Szybki start: używanie usługi Azure Cache for Redis w środowisku .NET Core

W tym przewodniku Szybki start dołączasz usługę Azure Cache for Redis do aplikacji platformy .NET Core, aby mieć dostęp do bezpiecznej dedykowanej pamięci podręcznej dostępnej z dowolnej aplikacji na platformie Azure. W szczególności używasz klienta StackExchange.Redis z kodem języka C# w aplikacji konsolowej platformy .NET Core.

Przejdź do kodu w usłudze GitHub

Sklonuj repozytorium https://github.com/Azure-Samples/azure-cache-redis-samples/tree/main/quickstart/dotnet-core w usłudze GitHub.

Wymagania wstępne

Tworzenie pamięci podręcznej

  1. Aby utworzyć pamięć podręczną, zaloguj się do witryny Azure Portal i wybierz pozycję Utwórz zasób.

    Create a resource is highlighted in the left navigation pane.

  2. Na stronie Nowy wybierz pozycję Bazy danych, a następnie wybierz pozycję Azure Cache for Redis.

    On New, Databases is highlighted, and Azure Cache for Redis is highlighted.

  3. Na stronie Nowa pamięć podręczna Redis Cache skonfiguruj ustawienia nowej pamięci podręcznej.

    Ustawienie Wybierz wartość opis
    Subskrypcja Z listy rozwijanej i wybierz subskrypcję. Subskrypcja, w ramach której ma zostać utworzone to nowe wystąpienie usługi Azure Cache for Redis.
    Grupa zasobów: Z listy rozwijanej i wybierz grupę zasobów lub wybierz pozycję Utwórz nową i wprowadź nową nazwę grupy zasobów. Nazwa grupy zasobów, w której ma zostać utworzona pamięć podręczna i inne zasoby. Umieszczając wszystkie zasoby aplikacji w jednej grupie zasobów, można je łatwo zarządzać lub usuwać razem.
    Nazwa DNS Wprowadź unikatową nazwę. Nazwa pamięci podręcznej musi być ciągiem z zakresu od 1 do 63 znaków, które zawierają tylko cyfry, litery lub łączniki. Nazwa musi zaczynać się i kończyć cyfrą lub literą i nie może zawierać kolejnych łączników. Nazwa hosta wystąpienia pamięci podręcznej to <nazwa> DNS.redis.cache.windows.net.
    Lokalizacja Z listy rozwijanej i wybierz lokalizację. Wybierz region w pobliżu innych usług korzystających z pamięci podręcznej.
    Typ pamięci podręcznej Z listy rozwijanej wybierz warstwę. Warstwa określa rozmiar, wydajność i funkcje dostępne dla pamięci podręcznej. Aby uzyskać więcej informacji, zobacz Omówienie pamięci podręcznej Azure Cache for Redis.
  4. Wybierz kartę Sieć lub wybierz przycisk Sieć w dolnej części strony.

  5. Na karcie Sieć wybierz metodę łączności.

  6. Wybierz kartę Dalej: Zaawansowane lub wybierz przycisk Dalej: Zaawansowane w dolnej części strony, aby wyświetlić kartę Zaawansowane.

    Screenshot showing the Advanced tab in the working pane and the available option to select.

    • W przypadku pamięci podręcznych w warstwie Podstawowa lub Standardowa przełącz wybór portu innego niż TLS. Możesz również wybrać, jeśli chcesz włączyć uwierzytelnianie firmy Microsoft Entra.
    • W przypadku pamięci podręcznej Premium skonfiguruj ustawienia portów innych niż TLS, klastrowanie, tożsamość zarządzana i trwałość danych. Możesz również wybrać, jeśli chcesz włączyć uwierzytelnianie firmy Microsoft Entra.
  7. Wybierz kartę Dalej: Tagi lub wybierz przycisk Dalej: Tagi w dolnej części strony.

  8. Opcjonalnie na karcie Tagi wprowadź nazwę i wartość, jeśli chcesz skategoryzować zasób.

  9. Wybierz pozycję Przejrzyj i utwórz. Przejdź do karty Przeglądanie i tworzenie, na której platforma Azure weryfikuje konfigurację.

  10. Po pojawieniu się zielonego komunikatu Weryfikacja przekazana wybierz pozycję Utwórz.

Utworzenie pamięci podręcznej zajmuje trochę czasu. Postęp można monitorować na stronie Przegląd usługi Azure Cache for Redis. Gdy stan jest wyświetlany jako Uruchomiono, pamięć podręczna jest gotowa do użycia.

Pobieranie nazwy hosta, portów i kluczy dostępu z witryny Azure Portal

Aby połączyć serwer usługi Azure Cache for Redis, klient pamięci podręcznej potrzebuje nazwy hosta, portów i klucza pamięci podręcznej. Niektórzy klienci mogą odwoływać się do tych elementów przy użyciu nieco innych nazw. Nazwę hosta, porty i klucze można uzyskać w witrynie Azure Portal.

  • Aby uzyskać klucze dostępu, w obszarze nawigacji po lewej stronie pamięci podręcznej wybierz pozycję Klucze dostępu.

    Azure Cache for Redis keys

  • Aby uzyskać nazwę hosta i porty, w obszarze nawigacji po lewej stronie pamięci podręcznej wybierz pozycję Właściwości. Nazwa hosta ma formę <DNS name.redis.cache.windows.net>.

    Azure Cache for Redis properties

Zanotuj NAZWĘ HOSTA i podstawowy klucz dostępu. Użyjesz tych wartości później, aby skonstruować wpis tajny Cache Połączenie ion.

Dodawanie lokalnego wpisu tajnego dla parametry połączenia

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:

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

Połączenie do pamięci podręcznej za pomocą usługi Redis Połączenie ion

Połączenie z pamięcią podręczną jest zarządzane przez klasę RedisConnection . Połączenie jest najpierw wykonywane w tej instrukcji z :Program.cs

      _redisConnection = await RedisConnection.InitializeAsync(connectionString: configuration["CacheConnection"].ToString());

W RedisConnection.cspliku zobaczysz, StackExchange.Redis że przestrzeń nazw została dodana do kodu. Jest to wymagane dla RedisConnection klasy .

using StackExchange.Redis;

Kod RedisConnection gwarantuje, że zawsze istnieje dobre połączenie z pamięcią podręczną przez zarządzanie wystąpieniem ConnectionMultiplexer z programu StackExchange.Redis. Klasa RedisConnection ponownie utworzy połączenie, gdy połączenie zostanie utracone i nie będzie można nawiązać połączenia automatycznie.

Aby uzyskać więcej informacji, zobacz StackExchange.Redis i kod w repozytorium GitHub.

Wykonywanie poleceń pamięci podręcznej

W program.cspliku zobaczysz następujący kod metody RunRedisCommandsAsync w Program klasie dla aplikacji konsolowej:

private static async Task RunRedisCommandsAsync(string prefix)
    {
        // Simple PING command
        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: PING");
        RedisResult pingResult = await _redisConnection.BasicRetryAsync(async (db) => await db.ExecuteAsync("PING"));
        Console.WriteLine($"{prefix}: Cache response: {pingResult}");

        // Simple get and put of integral data types into the cache
        string key = "Message";
        string value = "Hello! The cache is working from a .NET console app!";

        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: GET {key} via StringGetAsync()");
        RedisValue getMessageResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringGetAsync(key));
        Console.WriteLine($"{prefix}: Cache response: {getMessageResult}");

        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: SET {key} \"{value}\" via StringSetAsync()");
        bool stringSetResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringSetAsync(key, value));
        Console.WriteLine($"{prefix}: Cache response: {stringSetResult}");

        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache command: GET {key} via StringGetAsync()");
        getMessageResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringGetAsync(key));
        Console.WriteLine($"{prefix}: Cache response: {getMessageResult}");

        // Store serialized object to cache
        Employee e007 = new Employee("007", "Davide Columbo", 100);
        stringSetResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringSetAsync("e007", JsonSerializer.Serialize(e007)));
        Console.WriteLine($"{Environment.NewLine}{prefix}: Cache response from storing serialized Employee object: {stringSetResult}");

        // Retrieve serialized object from cache
        getMessageResult = await _redisConnection.BasicRetryAsync(async (db) => await db.StringGetAsync("e007"));
        Employee e007FromCache = JsonSerializer.Deserialize<Employee>(getMessageResult);
        Console.WriteLine($"{prefix}: Deserialized Employee .NET object:{Environment.NewLine}");
        Console.WriteLine($"{prefix}: Employee.Name : {e007FromCache.Name}");
        Console.WriteLine($"{prefix}: Employee.Id   : {e007FromCache.Id}");
        Console.WriteLine($"{prefix}: Employee.Age  : {e007FromCache.Age}{Environment.NewLine}");
    }

Elementy pamięci podręcznej można zapisywać i pobierać za pomocą metod StringSetAsync i StringGetAsync.

W tym przykładzie widać Message , że klucz jest ustawiony na wartość. Aplikacja zaktualizowała tę wartość w pamięci podręcznej. Aplikacja wykonała PING również polecenie i .

Praca z obiektami platformy .NET w pamięci podręcznej

Serwer Redis przechowuje większość danych jako ciągi, ale te ciągi 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.

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ć.

Odpowiedzialność za serializację obiektu .NET spoczywa na deweloperze aplikacji, który ma możliwość wybrania serializatora.

Następująca Employee klasa została zdefiniowana w Program.cs , aby przykład mógł również pokazać, jak uzyskać i ustawić serializowany obiekt :

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

        public Employee(string id, string name, int age)
        {
            Id = id;
            Name = name;
            Age = age;
        }
    }

Uruchamianie aplikacji przykładowej

Jeśli otwarto jakiekolwiek pliki, zapisz je i skompiluj aplikację za pomocą następującego polecenia:

dotnet build

Uruchom aplikację za pomocą następującego polecenia, aby przetestować serializację obiektów platformy .NET:

dotnet run

Console app completed

Czyszczenie zasobów

Jeśli nadal używasz tego przewodnika Szybki start, możesz zachować utworzone zasoby i użyć ich ponownie.

W przeciwnym razie, jeśli skończysz z przykładową aplikacją Szybkiego startu, możesz usunąć zasoby platformy Azure utworzone w tym przewodniku Szybki start, aby uniknąć naliczania opłat.

Ważne

Usunięcie grupy zasobów jest nieodwracalne i grupa zasobów oraz wszystkie zawarte w niej zasoby zostaną trwale usunięte. Uważaj, aby nie usunąć przypadkowo niewłaściwych zasobów lub grupy zasobów. Jeśli utworzono zasoby do hostowania tego przykładu wewnątrz istniejącej grupy zasobów zawierającej zasoby, które chcesz zachować, możesz usunąć każdy zasób indywidualnie po lewej stronie zamiast usuwać grupę zasobów.

Aby usunąć grupę zasobów

  1. Zaloguj się do witryny Azure Portal i wybierz pozycję Grupy zasobów.

  2. W polu tekstowym Filtruj według nazwy... wpisz nazwę grupy zasobów. Instrukcje w tym artykule używają grupy zasobów o nazwie TestResources. Na liście wyników w grupie zasobów wybierz pozycję ... a następnie pozycję Usuń grupę zasobów.

    Delete

  3. Zostanie wyświetlony monit o potwierdzenie usunięcia grupy zasobów. Wpisz nazwę grupy zasobów, aby potwierdzić, a następnie wybierz pozycję Usuń.

Po krótkim czasie grupa zasobów i wszystkie zawarte w niej zasoby zostaną usunięte.

Następne kroki