快速入门：在 .NET Framework 中使用 Azure Cache for Redis

项目
06/25/2023

在本快速入门中，会将 Azure Redis 缓存合并到 .NET Framework 应用中，以便能够访问 Azure 中的任何应用程序都可以访问的安全专用缓存。你专门在 .NET 控制台应用中将 StackExchange.Redis 客户端与 C# 代码配合使用。

从 GitHub 上的 (https://github.com/Azure-Samples/azure-cache-redis-samples/tree/main/quickstart/dotnet 克隆存储库。

先决条件

Azure 订阅 - 创建订阅
Visual Studio 2019
.NET Framework 4 或更高版本，这是 StackExchange.Redis 客户端所必需的。

创建缓存

若要创建缓存，请登录到 Azure 门户并选择“创建资源” 。
在“新建”页上选择“数据库”，然后选择“Azure Cache for Redis”。

在“新建 Redis 缓存”页上配置新缓存的设置。

设置	选择值	说明
订阅	单击下拉箭头并选择你的订阅。	要在其下创建此新的 Azure Cache for Redis 实例的订阅。
资源组	单击下拉箭头并选择一个资源组，或者选择“新建”并输入新的资源组名称。	要在其中创建缓存和其他资源的资源组的名称。将所有应用资源放入一个资源组可以轻松地统一管理或删除这些资源。
DNS 名称	输入唯一名称。	缓存名称必须是包含 1 到 63 个字符的字符串，只能包含数字、字母或连字符。该名称必须以数字或字母开头和结尾，且不能包含连续的连字符。缓存实例的主机名是 <DNS name>.redis.cache.chinacloudapi.cn。
位置	单击下拉箭头并选择一个位置。	选择与要使用该缓存的其他服务靠近的区域。
缓存类型	下拉并选择一个层。	此层决定可用于缓存的大小、性能和功能。有关详细信息，请参阅用于 Redis 的 Azure 缓存概述。

选择“网络”选项卡，或选择“网络”按钮（位于页面底部）。
在“网络”选项卡中，选择你的连接方法。
选择“下一步:高级”选项卡，或者选择页面底部的“下一步:高级”按钮。
在基本或标准缓存实例的“高级”选项卡中，如果想要启用非 TLS 端口，请选择启用开关。还可以选择你想使用的 Redis 版本，4 或 6。
在高级缓存实例的“高级”选项卡中，配置非 TLS 端口、群集和数据持久性的设置。还可以选择你想使用的 Redis 版本，4 或 6。
选择“下一步: 标记”选项卡，或者选择页面底部的“下一步: 标记”按钮。
或者，在“标记”选项卡中，如果希望对资源分类，请输入名称或值。
选择“查看 + 创建” 。随后你会转到“查看 + 创建”选项卡，Azure 将在此处验证配置。
显示绿色的“已通过验证”消息后，选择“创建”。

创建缓存需要花费片刻时间。可以在 Azure Cache for Redis 的“概述”页上监视进度。如果“状态”显示为“正在运行”，则表示该缓存可供使用。

从 Azure 门户检索主机名、端口和访问密钥

若要连接到你的 Azure Cache for Redis 服务器，缓存客户端需要该缓存的主机名、端口和密钥。在某些客户端中，这些项的名称可能略有不同。可以从 Azure 门户检索主机名、端口和访问密钥。

若要获取访问密钥，请在缓存的左侧导航中选择“访问密钥”。
若要获取主机名和端口，请在缓存的左侧导航栏中选择“属性”。主机名的格式为 <DNS 名称>.redis.cache.chinacloudapi.cn。

在计算机上创建名为 CacheSecrets.config 的文件，并将其放置在 C:\AppSecrets\CacheSecrets.config。

编辑 CacheSecrets.config 文件，添加以下内容：

<appSettings>
    <add key="CacheConnection" value="<host-name>,abortConnect=false,ssl=true,allowAdmin=true,password=<access-key>"/>
</appSettings>

将 <host-name> 替换为缓存主机名。
将 <access-key> 替换缓存的主密钥。
保存文件。

配置缓存客户端

在本部分，你将准备控制台应用程序，以便将 StackExchange.Redis 客户端用于 .NET。

在 Visual Studio 中，选择“工具”>“NuGet 包管理器”>“包管理器控制台”，然后从“包管理器控制台”窗口运行以下命令。
```
Install-Package StackExchange.Redis
```
完成安装后，StackExchange.Redis 缓存客户端可供与项目一起使用。

连接到 Secrets 缓存

在 Visual Studio 中，打开 App.config 文件，验证其中是否包含引用 CacheSecrets.config 文件的 appSettingsfile 属性。

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

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

切勿将凭据存储在源代码中。为使本示例简单易懂，我们使用外部密码配置文件。更好的方法是将 Azure Key Vault 与证书配合使用。

使用 RedisConnection 连接到缓存

与缓存的连接由 RedisConnection 类管理。首先在 Program.cs 中使用此语句建立连接：

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

CacheConnection appSetting 的值用于将 Azure 门户中的缓存连接字符串作为密码参数引用。

在 RedisConnection.cs 中，你会看到带有 using 关键字的 StackExchange.Redis 命名空间。这是 RedisConnection 类所必需的。

using StackExchange.Redis;

RedisConnection 代码通过管理 StackExchange.Redis 中的 ConnectionMultiplexer 实例来确保始终与缓存建立运行状况正常的连接。连接丢失且无法自动重新连接时，RedisConnection 类会重新创建该连接。

有关详细信息，请参阅 StackExchange.Redis 和 GitHub 存储库中的代码。

执行缓存命令

在 program.cs 中，你可以看到控制台应用程序 Program 类中 RunRedisCommandsAsync 方法的以下代码：

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}");
    }

可以使用 StringSetAsync 和 StringGetAsync 方法来存储和检索缓存项。

在示例中，你可以看到 Message 密钥设置为值。应用更新了该缓存值。应用还执行了 PING 和命令。

处理缓存中的 .NET 对象

Redis 服务器将大多数数据存储为字符串，但这些字符串可能包含许多类型的数据，包括序列化的二进制数据，可在缓存中存储 .NET 对象时使用。

Azure Redis 缓存可以缓存 .NET 对象以及基元数据类型，但在缓存 .NET 对象之前，必须将其序列化。

此 .NET 对象序列化是应用程序开发人员的责任，同时赋与开发人员选择序列化程序的弹性。

将对象序列化的一种简单方式是使用 System.text.Json 中的 JsonConvert 序列化方法。

将 System.text.Json 命名空间添加到 Visual Studio：

选择“工具”>“NuGet 包管理器”>“包管理器控制台”。
然后在“包管理器控制台”窗口中，运行以下命令。
```
Install-Package system.text.json
```

在 Program.cs 中定义了以下 Employee 类，因此示例还可以显示如何获取和设置序列化对象：

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)
    {
        Id = employeeId;
        Name = name;
        Age = age;
    }
}

运行示例

按 Ctrl+F5 生成并运行控制台应用，以便测试 .NET 对象的序列化。

已完成的控制台应用

清理资源

如果想要继续使用此快速入门，可以保留创建的资源，以便重复使用。

如果已完成快速入门示例应用程序，可以删除本快速入门中创建的 Azure 资源，以免产生费用。

重要

删除资源组的操作不可逆，资源组以及其中的所有资源将被永久删除。请确保不会意外删除错误的资源组或资源。如果在现有资源组（其中包含要保留的资源）中为托管此示例而创建了相关资源，可在左侧逐个删除这些资源，而不是删除资源组。

登录到 Azure 门户，然后选择“资源组”。

在“按名称筛选...”文本框中键入资源组的名称。本文的说明使用了名为 TestResources 的资源组。在结果列表中的资源组上，选择“...”，然后选择“删除资源组” 。

系统会要求确认是否删除资源组。键入资源组的名称进行确认，然后选择“删除”。

片刻之后，将会删除该资源组及其包含的所有资源。