Rychlý Start: použití mezipaměti Azure pro Redis s aplikací .NET FrameworkQuickstart: Use Azure Cache for Redis with a .NET Framework application

V tomto rychlém startu zahrňte Azure cache pro Redis do aplikace .NET Framework, abyste měli přístup k zabezpečené vyhrazené mezipaměti, která je přístupná z libovolné aplikace v Azure.In this quickstart, you incorporate Azure Cache for Redis into a .NET Framework app to have access to a secure, dedicated cache that is accessible from any application within Azure. Konkrétně použijete klienta stackexchange. Redis s kódem C# v aplikaci konzoly .NET.You specifically use the StackExchange.Redis client with C# code in a .NET console app.

PožadavkyPrerequisites

Vytvoření mezipamětiCreate a cache

  1. Pokud chcete vytvořit mezipaměť, přihlaste se k Azure Portal a vyberte vytvořit prostředek.To create a cache, sign in to the Azure portal and select Create a resource.

    Vyberte vytvořit prostředek.

  2. Na stránce Nový vyberte databáze a pak vyberte Azure cache pro Redis.On the New page, select Databases and then select Azure Cache for Redis.

    Vybrat mezipaměť Azure pro Redis

  3. Na stránce nový Redis Cache nakonfigurujte nastavení pro novou mezipaměť.On the New Redis Cache page, configure the settings for your new cache.

    NastaveníSetting Navrhovaná hodnotaSuggested value PopisDescription
    Název DNSDNS name Zadejte globálně jedinečný název.Enter a globally unique name. Název mezipaměti musí být řetězec v rozmezí 1 až 63 znaků, který obsahuje jenom čísla, písmena nebo spojovníky.The cache name must be a string between 1 and 63 characters that contains only numbers, letters, or hyphens. Název musí začínat a končit číslicí nebo písmenem a nesmí obsahovat po sobě jdoucí spojovníky.The name must start and end with a number or letter, and can't contain consecutive hyphens. Název hostitele vaší instance mezipaměti bude * <název DNS>. Redis.cache.Windows.NET*.Your cache instance's host name will be <DNS name>.redis.cache.windows.net.
    PředplatnéSubscription Rozevírací seznam a vyberte své předplatné.Drop down and select your subscription. Předplatné, ve kterém se má vytvořit Tato nová mezipaměť Azure pro instanci RedisThe subscription under which to create this new Azure Cache for Redis instance.
    Skupina prostředkůResource group Rozevírací seznam a vyberte skupinu prostředků nebo vyberte vytvořit novou a zadejte nový název skupiny prostředků.Drop down and select a resource group, or select Create new and enter a new resource group name. Název skupiny prostředků, ve které se má vytvořit mezipaměť a další prostředkyName for the resource group in which to create your cache and other resources. Po uložení všech prostředků vaší aplikace do jedné skupiny prostředků je můžete snadno spravovat nebo odstraňovat společně.By putting all your app resources in one resource group, you can easily manage or delete them together.
    UmístěníLocation Rozevírací seznam a vyberte umístění.Drop down and select a location. Vyberte oblast poblíž jiných služeb, které budou používat vaši mezipaměť.Select a region near other services that will use your cache.
    Cenová úroveňPricing tier Rozevírací seznam a vyberte cenovou úroveň.Drop down and select a Pricing tier. Cenová úroveň určuje velikost, výkon a funkce, které jsou k dispozici pro danou mezipaměť.The pricing tier determines the size, performance, and features that are available for the cache. Další informace najdete v tématu Přehled služby Azure cache pro Redis.For more information, see Azure Cache for Redis Overview.
  4. Vyberte Vytvořit.Select Create.

    Vytvoření mezipaměti Azure pro Redis

    Vytvoření mezipaměti trvá nějakou dobu.It takes a while for the cache to create. Průběh můžete sledovat na stránce Přehled služby Azure cache pro Redis.You can monitor progress on the Azure Cache for Redis Overview page. Pokud se stav zobrazuje jako spuštěno, mezipaměť je připravena k použití.When Status shows as Running, the cache is ready to use.

    Mezipaměť Azure pro Redis se vytvořila.

Načtení názvu hostitele, portů a přístupových klíčů z Azure PortalRetrieve host name, ports, and access keys from the Azure portal

Aby bylo možné připojit se k mezipaměti Azure pro instanci Redis, klienti mezipaměti potřebují název hostitele, porty a klíč pro mezipaměť.To connect to an Azure Cache for Redis instance, cache clients need the host name, ports, and a key for the cache. Někteří klienti mohou tyto položky označovat trochu odlišnými názvy.Some clients might refer to these items by slightly different names. Název hostitele, porty a klíče můžete získat z Azure Portal.You can get the host name, ports, and keys from the Azure portal.

  • Přístupové klíče získáte tak, že z levé navigační části mezipaměti vyberete přístupové klíče.To get the access keys, from your cache left navigation, select Access keys.

    Azure cache pro klíče Redis

  • Pokud chcete získat název hostitele a porty, z levé navigační možnosti mezipaměti vyberte vlastnosti.To get the host name and ports, from your cache left navigation, select Properties. Název hostitele má formát * <DNS název>. Redis.cache.Windows.NET*.The host name is of the form <DNS name>.redis.cache.windows.net.

    Azure cache pro vlastnosti Redis

Vytvořte v počítači soubor s názvem TajnéKódyMezipaměti.config a uložte ho do umístění, které se nebude vracet se zdrojovým kódem této ukázkové aplikace.Create a file on your computer named CacheSecrets.config and place it in a location where it won't be checked in with the source code of your sample application. V tomto rychlém startu je soubor TajnéKódyMezipaměti.config umístěný zde: C:\AppSecrets\TajnéKódyMezipaměti.config.For this quickstart, the CacheSecrets.config file is located here, C:\AppSecrets\CacheSecrets.config.

Upravte soubor TajnéKódyMezipaměti.config a přidejte do něj následující obsah:Edit the CacheSecrets.config file and add the following contents:

<appSettings>
    <add key="CacheConnection" value="<cache-name>.redis.cache.windows.net,abortConnect=false,ssl=true,password=<access-key>"/>
</appSettings>

<cache-name> nahraďte názvem hostitele mezipaměti.Replace <cache-name> with your cache host name.

<access-key> nahraďte primárním klíčem mezipaměti.Replace <access-key> with the primary key for your cache.

Vytvoření konzolové aplikaceCreate a console app

V aplikaci Visual Studio klikněte na soubor > Nový > projekt.In Visual Studio, click File > New > Project.

Vyberte Konzolová aplikace (.NET Framework) a vedle konfigurace aplikace.Select Console App (.NET Framework), and Next to configure your app. Zadejte název projektu a kliknutím na vytvořit vytvořte novou konzolovou aplikaci.Type a Project name and click Create to create a new console application.

Konfigurace klienta mezipamětiConfigure the cache client

V této části nakonfigurujete konzolovou aplikaci, aby pro .NET používala klienta StackExchange.Redis.In this section, you will configure the console application to use the StackExchange.Redis client for .NET.

V aplikaci Visual Studio klikněte na nástroje > správce > balíčků NuGetKonzola správce balíčkůa spusťte následující příkaz z okna konzoly Správce balíčků.In Visual Studio, click Tools > NuGet Package Manager > Package Manager Console, and run the following command from the Package Manager Console window.

Install-Package StackExchange.Redis

Po dokončení instalace budete moct se svým projektem používat klienta mezipaměti StackExchange.Redis.Once the installation is completed, the StackExchange.Redis cache client is available to use with your project.

Připojení k mezipamětiConnect to the cache

V sadě Visual Studio otevřete soubor App.config a aktualizujte ho tak, aby obsahoval atribut appSettings file odkazující na soubor CacheSecrets.config.In Visual Studio, open your App.config file and update it to include an appSettings file attribute that references the CacheSecrets.config file.

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup> 
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.1" />
    </startup>

    <appSettings file="C:\AppSecrets\CacheSecrets.config"></appSettings>  

</configuration>

V Průzkumníku řešení klikněte pravým tlačítkem myši na Odkazy a klikněte na Přidat odkaz.In Solution Explorer, right-click References and click Add a reference. Přidejte odkaz na sestavení System.Configuration.Add a reference to the System.Configuration assembly.

Do souboru Program.cs přidejte následující příkazy using:Add the following using statements to Program.cs:

using StackExchange.Redis;
using System.Configuration;

Připojení k mezipaměti Azure pro Redis je spravováno ConnectionMultiplexer třídou.The connection to the Azure Cache for Redis is managed by the ConnectionMultiplexer class. Tato třída by se měla v rámci klientské aplikace sdílet a opakovaně používat.This class should be shared and reused throughout your client application. Nevytvářejte pro každou operaci nové připojení.Do not create a new connection for each operation.

Neuchovávejte přihlašovací údaje ve zdrojovém kódu.Never store credentials in source code. Pro zjednodušení této ukázky používám pouze konfigurační soubor externích tajných kódů.To keep this sample simple, I’m only using an external secrets config file. Lepším přístupem může být použití řešení Azure Key Vault s certifikáty.A better approach would be to use Azure Key Vault with certificates.

V souboru Program.cs přidejte k třídě Program konzolové aplikace následující členy:In Program.cs, add the following members to the Program class of your console application:

        private static Lazy<ConnectionMultiplexer> lazyConnection = new Lazy<ConnectionMultiplexer>(() =>
        {
            string cacheConnection = ConfigurationManager.AppSettings["CacheConnection"].ToString();
            return ConnectionMultiplexer.Connect(cacheConnection);
        });

        public static ConnectionMultiplexer Connection
        {
            get
            {
                return lazyConnection.Value;
            }
        }

Tento přístup ke sdílení instance ConnectionMultiplexer v aplikaci používá statickou vlastnost, která vrací připojenou instanci.This approach to sharing a ConnectionMultiplexer instance in your application uses a static property that returns a connected instance. Tento kód poskytuje způsob inicializace pouze jedné připojené instance ConnectionMultiplexer, který je bezpečný pro přístup z více vláken.The code provides a thread-safe way to initialize only a single connected ConnectionMultiplexer instance. abortConnectje nastavené na false, což znamená, že volání je úspěšné i v případě, že není navázáno připojení k mezipaměti Azure pro Redis.abortConnect is set to false, which means that the call succeeds even if a connection to the Azure Cache for Redis is not established. Klíčovou vlastností ConnectionMultiplexer je automatické obnovení připojení k mezipaměti po vyřešení problémů se sítí nebo jiných příčin.One key feature of ConnectionMultiplexer is that it automatically restores connectivity to the cache once the network issue or other causes are resolved.

Hodnota CacheConnection appSetting se používá k odkazování na připojovací řetězec mezipaměti z webu Azure Portal ve formě parametru hesla.The value of the CacheConnection appSetting is used to reference the cache connection string from the Azure portal as the password parameter.

Provádění příkazů mezipamětiExecuting cache commands

Pro proceduru Main třídy Program konzolové aplikace přidejte následující kód:Add the following code for the Main procedure of the Program class for your console application:

        static void Main(string[] args)
        {
            // Connection refers to a property that returns a ConnectionMultiplexer
            // as shown in the previous example.
            IDatabase cache = Connection.GetDatabase();

            // Perform cache operations using the cache object...

            // Simple PING command
            string cacheCommand = "PING";
            Console.WriteLine("\nCache command  : " + cacheCommand);
            Console.WriteLine("Cache response : " + cache.Execute(cacheCommand).ToString());

            // Simple get and put of integral data types into the cache
            cacheCommand = "GET Message";
            Console.WriteLine("\nCache command  : " + cacheCommand + " or StringGet()");
            Console.WriteLine("Cache response : " + cache.StringGet("Message").ToString());

            cacheCommand = "SET Message \"Hello! The cache is working from a .NET console app!\"";
            Console.WriteLine("\nCache command  : " + cacheCommand + " or StringSet()");
            Console.WriteLine("Cache response : " + cache.StringSet("Message", "Hello! The cache is working from a .NET console app!").ToString());

            // Demonstrate "SET Message" executed as expected...
            cacheCommand = "GET Message";
            Console.WriteLine("\nCache command  : " + cacheCommand + " or StringGet()");
            Console.WriteLine("Cache response : " + cache.StringGet("Message").ToString());

            // Get the client list, useful to see if connection list is growing...
            cacheCommand = "CLIENT LIST";
            Console.WriteLine("\nCache command  : " + cacheCommand);
            Console.WriteLine("Cache response : \n" + cache.Execute("CLIENT", "LIST").ToString().Replace("id=", "id="));

            lazyConnection.Value.Dispose();
        }

Azure cache pro Redis má konfigurovatelný počet databází (výchozí hodnota je 16), který se dá použít k logickému oddělení dat v mezipaměti Azure pro Redis. Kód se připojí k výchozí databázi DB 0. Další informace najdete v tématu Co jsou databáze Redis? a Výchozí konfigurace serveru Redis.For more information, see What are Redis databases? and Default Redis server configuration.

Položky v mezipaměti lze ukládat a načítat pomocí metod StringSet a StringGet.Cache items can be stored and retrieved by using the StringSet and StringGet methods.

Redis ukládá většinu dat jako řetězce Redis, ale tyto řetězce mohou obsahovat mnoho typů dat, včetně serializovaných binárních dat, která lze použít při ukládání objektů .NET v mezipaměti.Redis stores most data as Redis strings, but these strings can contain many types of data, including serialized binary data, which can be used when storing .NET objects in the cache.

Stisknutím kombinace kláves Ctrl+F5 sestavíte a spustíte konzolovou aplikaci.Press Ctrl+F5 to build and run the console app.

V níže uvedeném příkladu můžete vidět, že klíč Message měl předtím hodnotu z mezipaměti, která byla nastavena pomocí konzoly Redis na webu Azure Portal.In the example below, you can see the Message key previously had a cached value, which was set using the Redis Console in the Azure portal. Aplikace tuto hodnotu z mezipaměti aktualizovala.The app updated that cached value. Aplikace rovněž spustila příkazy PING a CLIENT LIST.The app also executed the PING and CLIENT LIST commands.

Částečně provedený kód konzolové aplikace

Práce s objekty .NET v mezipamětiWork with .NET objects in the cache

Mezipaměť Azure pro Redis může ukládat do mezipaměti objekty .NET i primitivní datové typy, ale před tím, než může být objekt .NET uložen do mezipaměti, musí být serializován.Azure Cache for Redis can cache both .NET objects and primitive data types, but before a .NET object can be cached it must be serialized. Serializaci objektů .NET má na starosti vývojář aplikace, kterému je tak poskytnuta flexibilita při výběru serializátoru.This .NET object serialization is the responsibility of the application developer, and gives the developer flexibility in the choice of the serializer.

Jeden snadný způsob, jak serializovat objekty, je použít metody serializace JsonConvert v balíčku Newtonsoft.Json a serializovat a deserializovat tak objekty do a z formátu JSON.One simple way to serialize objects is to use the JsonConvert serialization methods in Newtonsoft.Json and serialize to and from JSON. V této části přidáte do mezipaměti objekt .NET.In this section, you will add a .NET object to the cache.

V aplikaci Visual Studio klikněte na nástroje > správce > balíčků NuGetKonzola správce balíčkůa spusťte následující příkaz z okna konzoly Správce balíčků.In Visual Studio, click Tools > NuGet Package Manager > Package Manager Console, and run the following command from the Package Manager Console window.

Install-Package Newtonsoft.Json

Na začátek souboru Program.cs přidejte následující příkaz using:Add the following using statement to the top of Program.cs:

using Newtonsoft.Json;

Do souboru Program.cs přidejte následující definici třídy Employee:Add the following Employee class definition to Program.cs:

        class Employee
        {
            public string Id { get; set; }
            public string Name { get; set; }
            public int Age { get; set; }

            public Employee(string EmployeeId, string Name, int Age)
            {
                this.Id = EmployeeId;
                this.Name = Name;
                this.Age = Age;
            }
        }

Na konec procedury Main() a před volání metody Dispose() v souboru Program.cs přidejte do mezipaměti následující řádky kódu a získejte serializovaný objekt .NET:At the bottom of Main() procedure in Program.cs, and before the call to Dispose(), add the following lines of code to cache and retrieve a serialized .NET object:

            // Store .NET object to cache
            Employee e007 = new Employee("007", "Davide Columbo", 100);
            Console.WriteLine("Cache response from storing Employee .NET object : " + 
                cache.StringSet("e007", JsonConvert.SerializeObject(e007)));

            // Retrieve .NET object from cache
            Employee e007FromCache = JsonConvert.DeserializeObject<Employee>(cache.StringGet("e007"));
            Console.WriteLine("Deserialized Employee .NET object :\n");
            Console.WriteLine("\tEmployee.Name : " + e007FromCache.Name);
            Console.WriteLine("\tEmployee.Id   : " + e007FromCache.Id);
            Console.WriteLine("\tEmployee.Age  : " + e007FromCache.Age + "\n");

Stisknutím kombinace kláves Ctrl+F5 sestavte a spusťte konzolovou aplikaci a otestujte serializaci objektů .NET.Press Ctrl+F5 to build and run the console app to test serialization of .NET objects.

Dokončená konzolová aplikace

Vyčištění prostředkůClean up resources

Pokud budete pokračovat k dalšímu kurzu, můžete prostředky vytvořené v tomto rychlém startu zachovat a znovu je použít.If you will be continuing to the next tutorial, you can keep the resources created in this quickstart and reuse them.

V opačném případě, pokud jste už s ukázkovou aplikací v tomto rychlém startu skončili, můžete prostředky Azure vytvořené v tomto rychlém startu odstranit, abyste se vyhnuli poplatkům.Otherwise, if you are finished with the quickstart sample application, you can delete the Azure resources created in this quickstart to avoid charges.

Důležité

Odstranění skupiny prostředků je nevratné a skupina prostředků včetně všech v ní obsažených prostředků bude trvale odstraněna.Deleting a resource group is irreversible and that the resource group and all the resources in it are permanently deleted. Ujistěte se, že nechtěně neodstraníte nesprávnou skupinu prostředků nebo prostředky.Make sure that you do not accidentally delete the wrong resource group or resources. Pokud jste vytvořili prostředky pro hostování této ukázky ve stávající skupině prostředků obsahující prostředky, které chcete zachovat, můžete místo odstranění skupiny prostředků odstranit jednotlivé prostředky z jejich odpovídajících oken.If you created the resources for hosting this sample inside an existing resource group that contains resources you want to keep, you can delete each resource individually from their respective blades instead of deleting the resource group.

Přihlaste se na web Azure Portal a klikněte na Skupiny prostředků.Sign in to the Azure portal and click Resource groups.

Do textového pole Filtrovat podle názvu zadejte název vaší skupiny prostředků.In the Filter by name... textbox, type the name of your resource group. V pokynech v tomto článku se používala skupina prostředků TestResources.The instructions for this article used a resource group named TestResources. Ve výsledcích hledání klikněte na ... u vaší skupiny prostředků a pak na Odstranit skupinu prostředků.On your resource group in the result list, click ... then Delete resource group.

Odstranit

Zobrazí se výzva k potvrzení odstranění skupiny prostředků.You will be asked to confirm the deletion of the resource group. Potvrďte odstranění zadáním názvu vaší skupiny prostředků a klikněte na Odstranit.Type the name of your resource group to confirm, and click Delete.

Po chvíli bude skupina prostředků včetně všech obsažených prostředků odstraněná.After a few moments, the resource group and all of its contained resources are deleted.

Další krokyNext steps

V tomto rychlém startu jste zjistili, jak používat Azure cache pro Redis z aplikace .NET.In this quickstart, you learned how to use Azure Cache for Redis from a .NET application. Přejděte k dalšímu rychlému startu a použijte Azure cache pro Redis s webovou aplikací ASP.NET.Continue to the next quickstart to use Azure Cache for Redis with an ASP.NET web app.