Szybki Start: korzystanie z usługi Azure cache for Redis w programie .NET CoreQuickstart: Use Azure Cache for Redis in .NET Core

W tym przewodniku szybki start dodaliśmy usługę Azure cache for Redis do aplikacji platformy .NET Core w celu uzyskania dostępu do bezpiecznej, dedykowanej pamięci podręcznej dostępnej z dowolnej aplikacji na platformie Azure.In this quickstart, you incorporate Azure Cache for Redis into a .NET Core app to have access to a secure, dedicated cache that is accessible from any application within Azure. Należy używać klienta stackexchange. Redis z kodem C# w aplikacji konsolowej platformy .NET Core.You specifically use the StackExchange.Redis client with C# code in a .NET Core console app.

Wymagania wstępnePrerequisites

Tworzenie pamięci podręcznejCreate a cache

  1. Aby utworzyć pamięć podręczną, zaloguj się do Azure Portal i wybierz pozycję Utwórz zasób.To create a cache, sign in to the Azure portal and select Create a resource.

    W okienku nawigacji po lewej stronie zostanie wyróżniony zasób.

  2. Na stronie Nowy wybierz pozycję bazy danych , a następnie wybierz pozycję Azure cache for Redis.On the New page, select Databases and then select Azure Cache for Redis.

    W obszarze nowe są wyróżnione bazy danych, a usługa Azure cache for Redis jest wyróżniona.

  3. Na stronie nowy Redis Cache Skonfiguruj ustawienia dla nowej pamięci podręcznej.On the New Redis Cache page, configure the settings for your new cache.

    UstawienieSetting Sugerowana wartośćSuggested value OpisDescription
    Nazwa DNSDNS name Podaj globalnie unikatową nazwę.Enter a globally unique name. Nazwa pamięci podręcznej musi być ciągiem z przedziału od 1 do 63 znaków, który zawiera tylko cyfry, litery lub łączniki.The cache name must be a string between 1 and 63 characters that contains only numbers, letters, or hyphens. Nazwa musi zaczynać się i kończyć cyfrą lub literą i nie może zawierać następujących po sobie łączników.The name must start and end with a number or letter, and can't contain consecutive hyphens. Nazwa hosta wystąpienia pamięci podręcznej to <DNS name> . Redis.cache.Windows.NET.Your cache instance's host name will be <DNS name>.redis.cache.windows.net.
    SubskrypcjaSubscription Lista rozwijana i wybierz swoją subskrypcję.Drop down and select your subscription. Subskrypcja, w ramach której ma zostać utworzone nowe wystąpienie usługi Azure cache for Redis.The subscription under which to create this new Azure Cache for Redis instance.
    Grupa zasobówResource group Rozwiń i wybierz grupę zasobów lub wybierz pozycję Utwórz nową , a następnie wprowadź nową nazwę grupy zasobów.Drop down and select a resource group, or select Create new and enter a new resource group name. Nazwa grupy zasobów, w której ma zostać utworzona pamięć podręczna i inne zasoby.Name for the resource group in which to create your cache and other resources. Umieszczenie wszystkich zasobów aplikacji w jednej grupie zasobów pozwala łatwo zarządzać nimi i usuwać je razem.By putting all your app resources in one resource group, you can easily manage or delete them together.
    LokalizacjaLocation Lista rozwijana i wybierz lokalizację.Drop down and select a location. Wybierz region blisko innych usług, które będą korzystać z pamięci podręcznej.Select a region near other services that will use your cache.
    Warstwa cenowaPricing tier Lista rozwijana i wybierz warstwę cenową.Drop down and select a Pricing tier. Warstwa cenowa decyduje o rozmiarze, wydajności i funkcjach dostępnych dla pamięci podręcznej.The pricing tier determines the size, performance, and features that are available for the cache. Aby uzyskać więcej informacji, zobacz Omówienie pamięci podręcznej Azure Cache for Redis.For more information, see Azure Cache for Redis Overview.
  4. Wybierz kartę Sieć lub kliknij przycisk sieci w dolnej części strony.Select the Networking tab or click the Networking button at the bottom of the page.

  5. Na karcie Sieć wybierz metodę łączności.In the Networking tab, select your connectivity method.

  6. Wybierz kartę Dalej: Zaawansowane lub kliknij przycisk Dalej: Zaawansowane w dolnej części strony.Select the Next: Advanced tab or click the Next: Advanced button on the bottom of the page.

  7. Na karcie Zaawansowane dla podstawowego lub standardowego wystąpienia pamięci podręcznej wybierz opcję Włącz przełącznik, jeśli chcesz włączyć port inny niż TLS.In the Advanced tab for a basic or standard cache instance, select the enable toggle if you want to enable a non-TLS port. Możesz również wybrać, która wersja Redis ma być używana, 4 lub (wersja zapoznawcza) 6.You can also select which Redis version you would like use, either 4 or (PREVIEW) 6.

    Redis w wersji 4 lub 6.

  8. Na karcie Zaawansowane wystąpienia pamięci podręcznej Premium Skonfiguruj ustawienia dla portu niezwiązanego z protokołem TLS, klastrowanie i trwałość danych.In the Advanced tab for premium cache instance, configure the settings for non-TLS port, clustering, and data persistence. Możesz również wybrać, która wersja Redis ma być używana, 4 lub (wersja zapoznawcza) 6.You can also select which Redis version you would like use, either 4 or (PREVIEW) 6.

  9. Wybierz kartę następne: Tagi lub kliknij przycisk Dalej: Tagi w dolnej części strony.Select the Next: Tags tab or click the Next: Tags button at the bottom of the page.

  10. Opcjonalnie na karcie Tagi wprowadź nazwę i wartość, jeśli chcesz przydzielić zasób.Optionally, in the Tags tab, enter the name and value if you wish to categorize the resource.

  11. Wybierz pozycję Przeglądanie + tworzenie.Select Review + create. Nastąpi przekierowanie do karty Recenzja + tworzenie, w której platforma Azure weryfikuje konfigurację.You're taken to the Review + create tab where Azure validates your configuration.

  12. Po wyświetleniu komunikatu o pomyślnym sprawdzeniu poprawności, wybierz pozycję Utwórz.After the green Validation passed message appears, select Create.

Tworzenie pamięci podręcznej zajmuje trochę czasu.It takes a while for the cache to create. Postęp można monitorować na stronie Przegląd usługi Azure cache for Redis.You can monitor progress on the Azure Cache for Redis Overview page. Gdy stan jest wyświetlany jako uruchomiony, pamięć podręczna jest gotowa do użycia.When Status shows as Running, the cache is ready to use.

Pobieranie nazwy hosta, portów i kluczy dostępu z Azure PortalRetrieve host name, ports, and access keys from the Azure portal

Aby nawiązać połączenie z usługą Azure cache for Redis, klienci pamięci podręcznej potrzebują nazwy hosta, portów i klucza dla pamięci podręcznej.To connect to an Azure Cache for Redis instance, cache clients need the host name, ports, and a key for the cache. Niektórzy klienci mogą odwoływać się do tych elementów przy użyciu nieco innych nazw.Some clients might refer to these items by slightly different names. Możesz uzyskać nazwę hosta, porty i klucze z Azure Portal.You can get the host name, ports, and keys from the Azure portal.

  • Aby uzyskać klucze dostępu, w obszarze nawigacji po lewej stronie wybierz pozycję klucze dostępu.To get the access keys, from your cache left navigation, select Access keys.

    Klucze usługi Azure Cache for Redis

  • Aby uzyskać nazwę hosta i porty, z okienka nawigacji po lewej stronie wybierz pozycję Właściwości.To get the host name and ports, from your cache left navigation, select Properties. Nazwa hosta ma postać <DNS name> . Redis.cache.Windows.NET.The host name is of the form <DNS name>.redis.cache.windows.net.

    Właściwości usługi Azure Cache for Redis

Zanotuj NAZWĘ HOSTA i podstawowy klucz dostępu.Make a note of the HOST NAME and the Primary access key. Później użyjesz tych wartości do utworzenia wpisu tajnego CacheConnection.You will use these values later to construct the CacheConnection secret.

tworzenie aplikacji konsoliCreate a console app

Otwórz nowe okno poleceń i wykonaj następujące polecenie, aby utworzyć nową aplikację konsolową platformy .NET Core:Open a new command window and execute the following command to create a new .NET Core console app:

dotnet new console -o Redistest

W oknie poleceń przełącz na nowy katalog projektów Redistest.In your command window, change to the new Redistest project directory.

Dodawanie narzędzia Secret Manager do projektuAdd Secret Manager to the project

W tej sekcji dodasz narzędzie Secret Manager do projektu.In this section, you will add the Secret Manager tool to your project. Narzędzie Secret manager przechowuje poufne dane potrzebne w pracy deweloperskiej poza Twoim drzewem projektu.The Secret Manager tool stores sensitive data for development work outside of your project tree. Takie podejście zapobiega przypadkowemu ujawnieniu wpisów tajnych aplikacji w kodzie źródłowym.This approach helps prevent the accidental sharing of app secrets within source code.

Otwórz plik Redistest.csproj.Open your Redistest.csproj file. Dodaj element DotNetCliToolReference, aby uwzględnić narzędzia Microsoft.Extensions.SecretManager.Tools.Add a DotNetCliToolReference element to include Microsoft.Extensions.SecretManager.Tools. Dodaj również element UserSecretsId w sposób pokazany poniżej, a następnie zapisz plik.Also add a UserSecretsId element as shown below, and save the file.

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <OutputType>Exe</OutputType>
        <TargetFramework>netcoreapp2.0</TargetFramework>
        <UserSecretsId>Redistest</UserSecretsId>
    </PropertyGroup>
    <ItemGroup>
        <DotNetCliToolReference Include="Microsoft.Extensions.SecretManager.Tools" Version="2.0.0" />
    </ItemGroup>
</Project>

Uruchom następujące polecenie, aby dodać do projektu pakiet Microsoft.Extensions.Configuration.UserSecrets:Execute the following command to add the Microsoft.Extensions.Configuration.UserSecrets package to the project:

dotnet add package Microsoft.Extensions.Configuration.UserSecrets

Uruchom następujące polecenie, aby przywrócić pakiety:Execute the following command to restore your packages:

dotnet restore

W oknie poleceń wykonaj następujące polecenie, aby zapisać nowy wpis tajny o nazwie CacheConnection po zastąpieniu symboli zastępczych (w tym nawiasów ostrych) nazwą pamięci podręcznej i podstawowym kluczem dostępu:In your command window, execute the following command to store a new secret named CacheConnection, after replacing the placeholders (including angle brackets) for your cache name and primary access key:

dotnet user-secrets set CacheConnection "<cache name>.redis.cache.windows.net,abortConnect=false,ssl=true,password=<primary-access-key>"

Dodaj następującą instrukcję akcji using do pliku Program.cs:Add the following using statement to Program.cs:

using Microsoft.Extensions.Configuration;

Dodaj następujące elementy członkowskie do klasy Program w pliku Program.cs.Add the following members to the Program class in Program.cs. Ten kod inicjuje konfigurację do uzyskiwania dostępu do wpisu tajnego użytkownika dla parametrów połączenia usługi Azure Cache for Redis.This code initializes a configuration to access the user secret for the Azure Cache for Redis connection string.

private static IConfigurationRoot Configuration { get; set; }
const string SecretName = "CacheConnection";

private static void InitializeConfiguration()
{
    var builder = new ConfigurationBuilder()
        .AddUserSecrets<Program>();

    Configuration = builder.Build();
}

Konfigurowanie klienta pamięci podręcznejConfigure the cache client

W tej sekcji skonfigurujesz aplikację konsolową umożliwiającą korzystanie z klienta StackExchange.Redis na platformie .NET.In this section, you will configure the console application to use the StackExchange.Redis client for .NET.

W oknie poleceń uruchom następujące polecenie w katalogu projektów Redistest:In your command window, execute the following command in the Redistest project directory:

dotnet add package StackExchange.Redis

Po ukończeniu instalacji klient pamięci podręcznej StackExchange.Redis będzie dostępny do użycia z projektem.Once the installation is completed, the StackExchange.Redis cache client is available to use with your project.

Łączenie z pamięcią podręcznąConnect to the cache

Dodaj następującą instrukcję akcji using do pliku Program.cs:Add the following using statement to Program.cs:

using StackExchange.Redis;

Połączenie z usługą Azure Cache for Redis jest zarządzane przez klasę ConnectionMultiplexer.The connection to the Azure Cache for Redis is managed by the ConnectionMultiplexer class. Ta klasa powinna być udostępniana i wielokrotnie używana w aplikacji klienta.This class should be shared and reused throughout your client application. Nie należy tworzyć nowego połączenia dla każdej operacji.Do not create a new connection for each operation.

W pliku Program.cs dodaj następujące elementy członkowskie do klasy Program aplikacji konsolowej: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 = Configuration[SecretName];
    return ConnectionMultiplexer.Connect(cacheConnection);
});

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

W tym podejściu do udostępniania wystąpienia klasy ConnectionMultiplexer w aplikacji użyto właściwości statycznej, która zwraca połączone wystąpienie.This approach to sharing a ConnectionMultiplexer instance in your application uses a static property that returns a connected instance. Ten kod zapewnia bezpieczny wątkowo sposób inicjowania tylko jednego połączonego wystąpienia klasy ConnectionMultiplexer.The code provides a thread-safe way to initialize only a single connected ConnectionMultiplexer instance. Parametr abortConnect ma wartość false, co oznacza, że wywołanie zostanie wykonane pomyślnie, nawet jeśli połączenie z usługą Azure Cache for Redis nie zostanie nawiązane.abortConnect is set to false, which means that the call succeeds even if a connection to the Azure Cache for Redis is not established. Kluczowa funkcja klasy ConnectionMultiplexer polega na automatycznym przywracaniu łączności z pamięcią podręczną po rozwiązaniu problemu z siecią lub usunięciu innych przyczyn.One key feature of ConnectionMultiplexer is that it automatically restores connectivity to the cache once the network issue or other causes are resolved.

Wartość wpisu tajnego CacheConnection jest dostępna przy użyciu dostawcy konfiguracji programu Secret Manager oraz używana jako parametr hasła.The value of the CacheConnection secret is accessed using the Secret Manager configuration provider and used as the password parameter.

Wykonywanie poleceń pamięci podręcznejExecuting cache commands

W pliku Program.cs dodaj następujący kod do procedury Main klasy Program aplikacji konsolowej:In Program.cs, add the following code for the Main procedure of the Program class for your console application:

static void Main(string[] args)
{
    InitializeConfiguration();

    // Connection refers to a property that returns a ConnectionMultiplexer
    // as shown in the previous example.
    IDatabase cache = lazyConnection.Value.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 Core console app!\"";
    Console.WriteLine("\nCache command  : " + cacheCommand + " or StringSet()");
    Console.WriteLine("Cache response : " + cache.StringSet("Message", "Hello! The cache is working from a .NET Core 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();
}

Zapisz plik Program.cs.Save Program.cs.

Usługa Azure Cache for Redis ma konfigurowalną liczbę baz danych (domyślnie 16), których można użyć do logicznego odseparowania danych w tej usłudze.Azure Cache for Redis has a configurable number of databases (default of 16) that can be used to logically separate the data within an Azure Cache for Redis. Kod łączy się z domyślną bazą danych DB 0.The code connects to the default database, DB 0. Aby uzyskać więcej informacji, zobacz What are Redis databases? (Co to są bazy danych Redis?) i Default Redis server configuration (Domyślna konfiguracja serwera Redis).For more information, see What are Redis databases? and Default Redis server configuration.

Elementy pamięci podręcznej można zapisywać i pobierać za pomocą metod StringSet i StringGet.Cache items can be stored and retrieved by using the StringSet and StringGet methods.

Usługa Redis przechowuje większość danych w formie ciągów Redis, ale ciągi te mogą zawierać wiele typów danych, w tym serializowane dane binarne, które mogą być używane podczas przechowywania obiektów platformy .NET w pamięci podręcznej.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.

Aby utworzyć aplikację, uruchom w oknie polecenia następujące polecenie:Execute the following command in your command window to build the app:

dotnet build

Następnie uruchom aplikację za pomocą następującego polecenia:Then run the app with the following command:

dotnet run

W poniższym przykładzie widać, że klucz Message miał już w pamięci podręcznej wartość, która została ustawiona za pomocą konsoli Redis w witrynie 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. Aplikacja zaktualizowała tę wartość w pamięci podręcznej.The app updated that cached value. Aplikacja również wykonała polecenia PING i CLIENT LIST.The app also executed the PING and CLIENT LIST commands.

Częściowa aplikacja konsolowa

Praca z obiektami platformy .NET w pamięci podręcznejWork with .NET objects in the cache

Usługa Azure Cache for Redis może buforować obiekty platformy .NET oraz pierwotne typy danych, ale zanim będzie możliwe buforowanie obiektu platformy .NET, trzeba go serializować.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. Odpowiedzialność za serializację obiektu .NET spoczywa na deweloperze aplikacji, który ma możliwość wybrania serializatora.This .NET object serialization is the responsibility of the application developer, and gives the developer flexibility in the choice of the serializer.

Prostym sposobem na wykonanie serializacji obiektów jest użycie metod serializacji JsonConvert w środowisku Newtonsoft.Json oraz serializacja do i z formatu JSON.One simple way to serialize objects is to use the JsonConvert serialization methods in Newtonsoft.Json and serialize to and from JSON. W tej sekcji dodasz obiekt platformy .NET do pamięci podręcznej.In this section, you will add a .NET object to the cache.

Uruchom następujące polecenie, aby dodać pakiet Newtonsoft.json do aplikacji:Execute the following command to add the Newtonsoft.json package to the app:

dotnet add package Newtonsoft.json

Dodaj następującą instrukcję using na początku pliku Program.cs:Add the following using statement to the top of Program.cs:

using Newtonsoft.Json;

Dodaj następującą definicję klasy Employee do pliku Program.cs: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;
    }
}

W dolnej części procedury Main() w pliku Program.cs i przed wywołaniem do Dispose() dodaj następujące wiersze kodu do pamięci podręcznej i pobierz serializowany obiekt platformy .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");

Zapisz plik Program.cs i ponownie skompiluj aplikację przy użyciu następującego polecenia:Save Program.cs and rebuild the app with the following command:

dotnet build

Uruchom aplikację za pomocą następującego polecenia, aby przetestować serializację obiektów platformy .NET:Run the app with the following command to test serialization of .NET objects:

dotnet run

Ukończono tworzenie aplikacji konsolowej

Czyszczenie zasobówClean up resources

Jeśli zamierzasz przejść do kolejnego samouczka, możesz zachować zasoby utworzone w tym przewodniku Szybki start i użyć ich ponownie.If you will be continuing to the next tutorial, you can keep the resources created in this quickstart and reuse them.

W przeciwnym razie po zakończeniu pracy z przykładową aplikacją poradnika Szybki start możesz usunąć zasoby platformy Azure utworzone w tym poradniku Szybki start, aby uniknąć naliczania opłat.Otherwise, if you are finished with the quickstart sample application, you can delete the Azure resources created in this quickstart to avoid charges.

Ważne

Usunięcie grupy zasobów jest nieodwracalne i grupa zasobów oraz wszystkie zawarte w niej zasoby zostaną trwale usunięte.Deleting a resource group is irreversible and that the resource group and all the resources in it are permanently deleted. Uważaj, aby nie usunąć przypadkowo niewłaściwych zasobów lub grupy zasobów.Make sure that you do not accidentally delete the wrong resource group or resources. Jeśli zasoby do hostowania tego przykładu zostały utworzone wewnątrz istniejącej grupy zasobów zawierającej zasoby, które chcesz zachować, możesz usunąć każdy zasób oddzielnie z odpowiadającego mu bloku zamiast usuwać całą grupę zasobów.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.

Zaloguj się do witryny Azure Portal i kliknij pozycję Grupy zasobów.Sign in to the Azure portal and click Resource groups.

W polu tekstowym Filtruj według nazwy... wpisz nazwę grupy zasobów.In the Filter by name... textbox, type the name of your resource group. Instrukcje w tym artykule używają grupy zasobów o nazwie TestResources.The instructions for this article used a resource group named TestResources. Dla grupy zasobów na liście wyników kliknij pozycję ..., a następnie kliknij pozycję Usuń grupę zasobów.On your resource group in the result list, click ... then Delete resource group.

Usuń

Zobaczysz prośbę o potwierdzenie usunięcia grupy zasobów.You will be asked to confirm the deletion of the resource group. Wpisz nazwę grupy zasobów w celu potwierdzenia, a następnie kliknij pozycję Usuń.Type the name of your resource group to confirm, and click Delete.

Po krótkim czasie grupa zasobów i wszystkie zawarte w niej zasoby zostaną usunięte.After a few moments, the resource group and all of its contained resources are deleted.

Następne krokiNext steps

W tym przewodniku Szybki start przedstawiono sposób użycia usługi Azure Cache for Redis z poziomu aplikacji platformy .NET Core.In this quickstart, you learned how to use Azure Cache for Redis from a .NET Core application. Przejdź do kolejnego Szybkiego startu, w którym wyjaśniono, jak używać usługi Microsoft Azure Cache for Redis z poziomu aplikacji internetowej ASP.NET.Continue to the next quickstart to use Azure Cache for Redis with an ASP.NET web app.

Chcesz zoptymalizować i zapisać wydatki na chmurę?Want to optimize and save on your cloud spending?