Schnellstart: Verwenden von Azure Cache for Redis mit einer .NET Core-App
In diesem Schnellstart integrieren Sie Azure Cache for Redis in eine .NET Core-App, um Zugriff auf einen sicheren, dedizierten Cache zu erhalten, der von jeder Anwendung in Azure aus zugänglich ist. Sie verwenden insbesondere den StackExchange.Redis-Client mit C#-Code in einer .NET Core-Konsolen-App.
Zum Code springen
In diesem Artikel wird beschrieben, wie Sie den Code für eine Beispiel-App ändern, um eine funktionierende App zu erstellen, die eine Verbindung mit Azure Cache for Redis herstellt.
Wenn Sie direkt mit dem Beispielcode fortfahren möchten, sehen Sie sich das .NET Core-Schnellstartbeispiel auf GitHub an.
Voraussetzungen
- Ein Azure-Abonnement. Kostenloses Konto erstellen
- .NET Core SDK
Erstellen eines Caches
Um einen Cache zu erstellen, melden Sie sich im Azure-Portal an. Wählen Sie im Menü des Portals Ressource erstellen aus.
Geben Sie auf der Seite Erste Schritte den Begriff Azure Cache for Redis auf der Suchleiste ein. Suchen Sie in den Suchergebnissen nach Azure Cache for Redis, und wählen Sie dann Erstellen aus.
Konfigurieren Sie im Bereich Neuer Redis Cache auf der Registerkarte Grundlagen die folgenden Einstellungen für Ihren Cache:
Einstellung Aktion Beschreibung Abonnement Wählen Sie Ihr Azure-Abonnement. Das Abonnement, das zum Erstellen der neuen Instanz von Azure Cache for Redis verwendet werden soll Ressourcengruppe Wählen Sie eine Ressourcengruppe aus, oder wählen Sie Neu erstellen aus, und geben Sie einen Namen für eine neue Ressourcengruppe ein. Der Name der Ressourcengruppe, in der Ihr Cache und weitere Ressourcen erstellt werden Wenn Sie alle Ihre App-Ressourcen in einer Ressourcengruppe zusammenfassen, können Sie sie einfacher gemeinsam verwalten oder löschen. DNS-Name Geben Sie einen eindeutigen Namen ein. Der Cachename muss eine Zeichenfolge von 1 bis 63 Zeichen sein, die nur Zahlen, Buchstaben und Bindestriche enthalten darf. Der Name muss mit einer Zahl oder einem Buchstaben beginnen und enden und darf keine aufeinanderfolgenden Bindestriche enthalten. Der Hostname Ihrer Cache-Instanz ist \<DNS name>.redis.cache.windows.net.Location Wählen Sie einen Standort aus. Eine Azure-Region, die sich in der Nähe anderer Dienste befindet, die Ihren Cache verwenden Cache-SKU Wählen Sie eine SKU aus. Die SKU bestimmt die Parameter für Größe, Leistung und Features, die für den Cache verfügbar sind. Weitere Informationen finden Sie unter Azure Cache for Redis. Cachegröße Wählen Sie eine Cachegröße aus. Weitere Informationen finden Sie unter Azure Cache for Redis. Wählen Sie die Registerkarte Netzwerk oder Weiter: Netzwerke aus.
Wählen Sie auf der Registerkarte Netzwerk eine Konnektivitätsmethode für den Cache aus.
Wählen Sie die Registerkarte Erweitert oder Weiter: Erweitert aus.
Überprüfen Sie im Bereich Erweitert die Authentifizierungsmethode basierend auf den folgenden Informationen, oder wählen Sie eine aus:
- Standardmäßig ist für einen neuen Basic-, Standard- oder Premium-Cache die Microsoft Entra-Authentifizierung aktiviert und die Authentifizierung mit Zugriffsschlüsseln deaktiviert.
- Für Basic- oder Standard-Caches können Sie sich für die Auswahl eines Nicht-TLS-Ports entscheiden.
- Für Standard- und Premium-Caches können Sie Verfügbarkeitszonen aktivieren. Verfügbarkeitszonen können nach der Erstellung des Caches nicht deaktiviert werden.
- Konfigurieren Sie für ein Premium-Cache die Einstellungen für einen Nicht-TLS-Port, das Clustering, die verwaltete Identität und die Datenpersistenz.
Wichtig
Für eine optimale Sicherheit sollten Sie nach Möglichkeit Microsoft Entra ID mit verwalteten Identitäten verwenden, um Anforderungen an Ihren Cache zu autorisieren. Die Autorisierung mit Microsoft Entra ID und verwalteten Identitäten bietet eine höhere Sicherheit und Benutzerfreundlichkeit als die Autorisierung mit einem gemeinsam verwendeten Schlüssel. Weitere Informationen zum Verwenden verwalteter Identitäten mit Ihren Caches finden Sie unter Verwenden von Microsoft Entra ID für die Cacheauthentifizierung.
(Optional:) Wählen Sie die Registerkarte Kategorien oder Weiter: Kategorien aus.
(Optional:) Geben Sie auf der Registerkarte Kategorien einen Tagnamen und den zueghörigen Wert ein, wenn Sie die Cacheressource kategorisieren möchten.
Wählen Sie die Schaltfläche Überprüfen + erstellen aus.
Auf der Registerkarte Überprüfen + Erstellen überprüft Azure automatisch Ihre Konfiguration.
Wenn die grüne Meldung Validierung erfolgreich angezeigt wird, wählen Sie Erstellen aus.
Eine neue Cachebereitstellung dauert mehrere Minuten. Sie können den Fortschritt der Bereitstellung im Bereich „Übersicht“ von Azure Cache for Redis überwachen. Wenn als Status der Wert Wird ausgeführt angezeigt wird, kann der Cache verwendet werden.
Abrufen des Hostnamens, der Ports und des Zugriffsschlüssels
Um Ihren Azure Cache for Redis-Server zu verbinden, benötigt der Cacheclient den Hostnamen, die Ports und einen Zugriffsschlüssel. Einige Clients verweisen möglicherweise auf diese Elemente, indem sie geringfügig andere Namen verwenden. Sie finden Hostname, Ports und Schlüssel im Azure-Portal.
So rufen Sie einen Zugriffsschlüssel für Ihren Cache ab
- Navigieren Sie im Azure-Portal zu Ihrem Cache.
- Wählen Sie im Menü „Dienst“ unter Einstellungen die Option Authentifizierung aus.
- Wählen Sie im Bereich Authentifizierung die Registerkarte Zugriffsschlüssel aus.
- Um den Wert für einen Zugriffsschlüssel zu kopieren, wählen Sie im Feld „Schlüssel“ das Symbol Kopieren aus.
So rufen Sie den Hostnamen und die Ports für Ihren Cache ab
- Navigieren Sie im Azure-Portal zu Ihrem Cache.
- Wählen Sie im Menü „Dienst“ die Option Übersicht aus.
- Wählen Sie unter Grundlagen für den Hostnamen das Symbol Kopieren aus, um den Hostnamenwert zu kopieren. Der Hostnamenwert weist das Format
<DNS name>.redis.cache.windows.netauf. - Wählen Sie für Ports das Symbol Kopieren aus, um die Portwerte zu kopieren.
Notieren Sie sich die Werte für HOSTNAME und den primären Zugriffsschlüssel. Sie verwenden diese Werte später, um das CacheConnection-Geheimnis zu erstellen.
Hinzufügen eines lokalen Geheimnisses für die Verbindungszeichenfolge
Führen Sie im Eingabeaufforderungsfenster den folgenden Befehl aus, um ein neues Geheimnis mit dem Namen CacheConnection zu speichern. Ersetzen Sie die Platzhalter (einschließlich der eckigen Klammern) durch den Cachenamen (<cache name>) und den primären Zugriffsschlüssel (<primary-access-key>):
dotnet user-secrets set CacheConnection "<cache name>.redis.cache.windows.net,abortConnect=false,ssl=true,allowAdmin=true,password=<primary-access-key>"
Herstellen einer Verbindung mit dem Cache mittels RedisConnection
Die Verbindung mit Ihrem Cache wird von der RedisConnection-Klasse verwaltet. Erstellen Sie zunächst die Verbindung in dieser Anweisung in der Datei Program.cs:
_redisConnection = await RedisConnection.InitializeAsync(connectionString: configuration["CacheConnection"].ToString());
In RedisConnection.cs wird der StackExchange.Redis-Namespace dem Code hinzugefügt. Der Namespace ist für die RedisConnection-Klasse erforderlich.
using StackExchange.Redis;
Der Code der RedisConnection-Klasse stellt sicher, dass immer eine fehlerfreie Verbindung mit dem Cache besteht. Die Verbindung wird über die ConnectionMultiplexer-Instanz in StackExchange.Redis verwaltet. Die RedisConnection-Klasse erstellt die Verbindung neu, wenn eine Verbindung getrennt wird und nicht automatisch wiederhergestellt werden kann.
Weitere Informationen finden Sie unter StackExchange.Redis und im Code im GitHub-Repository „StackExchange.Redis“.
Ausführen von Cachebefehlen
In der Datei Program.cs wird für die RunRedisCommandsAsync-Methode in der Program-Klasse der Konsolenanwendung der folgende Code angezeigt:
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}");
}
Sie können Cacheelemente mithilfe der Methoden StringSetAsync und StringGetAsync speichern und abrufen.
Im Beispiel ist der Message-Schlüssel auf einen Wert festgelegt. Die App hat diesen zwischengespeicherten Wert aktualisiert. Außerdem hat die App den Befehl PING ausgeführt.
Arbeiten mit .NET-Objekten im Cache
Der Redis-Server speichert die meisten Daten im Zeichenfolgenformat. Die Zeichenfolgen können verschiedene Datentypen enthalten, einschließlich serialisierter Binärdaten. Sie können serialisierte Binärdaten verwenden, wenn Sie .NET-Objekte im Cache speichern.
Azure Cache for Redis kann sowohl .NET-Objekte als auch primitive Datentypen zwischenspeichern. .NET-Objekte müssen allerdings zuvor serialisiert werden.
Die Serialisierung von .NET-Objekten liegt in der Verantwortung der Anwendungsentwickler. Die Objektserialisierung bietet Entwicklern mehr Flexibilität bei der Wahl des Serialisierungsprogramms.
Die folgende Employee-Klasse wurde in Program.cs definiert, damit mit dem Beispiel auch gezeigt werden kann, wie ein serialisiertes Objekt abgerufen und festgelegt wird:
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;
}
}
Ausführen des Beispiels
Wenn Sie Dateien geöffnet haben, speichern Sie diese. Erstellen Sie die App dann mit dem folgenden Befehl:
dotnet build
Führen Sie den folgenden Befehl aus, um die Serialisierung von .NET-Objekten zu testen:
dotnet run
Bereinigen von Ressourcen
Wenn Sie die in diesem Artikel erstellten Ressourcen weiterhin verwenden möchten, behalten Sie die Ressourcengruppe bei.
Wenn Sie die Ressourcen nicht mehr benötigen, können Sie die erstellte Azure-Ressourcengruppe andernfalls löschen, um Kosten im Zusammenhang mit den Ressourcen zu vermeiden.
Warnung
Das Löschen einer Ressourcengruppe kann nicht rückgängig gemacht werden. Beim Löschen einer Ressourcengruppe werden alle darin enthaltenen Ressourcen dauerhaft gelöscht. Achten Sie daher darauf, dass Sie nicht versehentlich die falsche Ressourcengruppe oder die falschen Ressourcen löschen. Falls Sie die Ressourcen in einer vorhandenen Ressourcengruppe erstellt haben, die Ressourcen enthält, die Sie behalten möchten, können Sie anstelle der Ressourcengruppe alle Ressourcen einzeln löschen.
Löschen einer Ressourcengruppe
Melden Sie sich beim Azure-Portal an, und wählen Sie anschließend Ressourcengruppen aus.
Wählen Sie die zu löschende Ressourcengruppe aus.
Wenn viele Ressourcengruppen vorhanden sind, verwenden Sie das Feld Nach einem beliebigen Feld filtern, und geben Sie den Namen der Ressourcengruppe ein, die Sie für diesen Artikel erstellt haben. Wählen Sie in der Liste der Suchergebnisse die Ressourcengruppe aus.
Wählen Sie die Option Ressourcengruppe löschen.
Geben Sie im Bereich Ressourcengruppe löschen zur Bestätigung den Namen Ihrer Ressourcengruppe ein, und wählen Sie dann Löschen aus.
Nach kurzer Zeit werden die Ressourcengruppe und alle darin enthaltenen Ressourcen gelöscht.