你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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

项目
12/20/2024

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

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

先决条件

Azure 订阅 - 创建免费帐户
.NET Core SDK

创建缓存

若要创建缓存，请登录到 Azure 门户。在门户菜单上，选择“创建资源”。
在“入门”页上的搜索框中键入“Azure Cache for Redis”。在搜索结果中找到“Azure Cache for Redis”，然后选择“创建”。

在“新建 Redis 缓存”窗格的“基本信息”选项卡上，配置缓存的以下设置：

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

选择“网络”选项卡，或选择“下一步：网络”。
在“网络”选项卡上，选择用于缓存的连接方法。
选择“高级”选项卡，或选择“下一步：高级”。
在“高级”窗格中，根据以下信息验证或选择身份验证方法：
- 默认情况下，对于新的“基本”、“标准”或“高级”缓存，“Microsoft Entra 身份验证”将处于启用状态，而“访问密钥身份验证”则处于禁用状态。
- 对于“基本”或“标准”缓存，可以选择非 TLS 端口的选项。
- 对于“标准”和“高级”缓存，可以选择启用可用性区域。创建缓存后，无法禁用可用性区域。
- 对于“高级”缓存，请配置非 TLS 端口、群集、托管标识和数据持久性的设置。
重要

为了获得最佳安全性，我们建议你在可能的情况下使用 Microsoft Entra ID 和托管标识来授权针对缓存的请求。与共享访问密钥授权相比，使用 Microsoft Entra ID 和托管标识进行授权提供了更高的安全性和易用性。若要详细了解如何将托管标识与缓存配合使用，请参阅使用 Microsoft Entra ID 进行缓存身份验证。
（可选）选择“标记”选项卡或选择“下一步: 标记”。
（可选）如果希望对缓存资源进行分类，请在“标记”选项卡中输入标记名称和值。
选择“查看 + 创建”按钮。

在“查看 + 创建”选项卡上，Azure 会自动验证你的配置。
显示绿色的“已通过验证”消息后，选择“创建” 。

新的缓存部署需要几分钟的时间。可以在 Azure Cache for Redis 的“概述”窗格上监视部署进度。如果“状态”显示为“正在运行”，则表示该缓存可供使用。

对缓存使用 Microsoft Entra ID 身份验证

Azure Redis 缓存（Enterprise 和 Enterprise Flash 层除外）默认启用了 Microsoft Entra 身份验证。默认已禁用访问密钥。

重要

Microsoft 建议使用 Microsoft Entra ID 身份验证来获得最安全的身份验证体验，而不要使用密码或访问密钥。本文本部分中所述的身份验证使用访问密钥，这需要高度信任应用程序，并且这种方法会带来风险，而使用 Microsoft Entra ID 则不存在这种风险。请仅在 Microsoft Entra ID 身份验证不可行时才使用本文档中所述的方法。

在 Azure 门户中，选择你要在其中使用基于 Microsoft Entra 令牌的身份验证的缓存。
从“资源”菜单中选择“身份验证”。
选择“选择成员”并输入有效用户的名称。选择“保存”时，系统会自动向你输入的用户默认分配数据所有者访问策略。还可输入托管标识或服务主体以连接到缓存实例。

有关如何将 Microsoft Entra ID 与 Azure CLI 配合使用的信息，请参阅标识参考页面。

记下主机名。稍后将对 appsettings.json 使用这些值。

添加连接字符串的本地机密

在 appsettings.json 文件中，添加以下内容：

{
  "RedisHostName": "your_Azure_Redis_hostname"
}

将“your_Azure_Redis_hostname”替换为 Azure Redis 主机名和端口号。例如：cache-name.region.redis.azure.net:10000 用于 Azure 托管 Redis（预览版），cache-name.redis.cache.windows.net:6380 用于 Azure Cache for Redis 服务。
保存文件。

使用 RedisConnection 连接到缓存

在 RedisConnection.cs 中，可以看到 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 对象序列化是应用程序开发人员的责任，同时赋与开发人员选择序列化程序的弹性。

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

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

运行示例

如果你已打开任何文件，请保存这些文件，并使用以下命令生成应用：

dotnet build

使用以下命令运行应用来测试 .NET 对象的序列化：

dotnet run

显示控制台应用已完成的屏幕截图。

清理资源

要继续使用在本文中创建的资源，请保留资源组。

否则，如果已完成资源，可以删除创建的 Azure 资源组以避免产生费用。

重要

删除资源组的操作不可逆。删除资源组时，包含在其中的所有资源会被永久删除。请确保不会意外删除错误的资源组或资源。如果在现有资源组（其中包含要保留的资源）内创建了此资源，可以逐个删除这些资源，而不是删除资源组。

删除资源组的步骤

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

如果有多个资源组，请使用“筛选任何字段...”框，键入为本文创建的资源组的名称。在结果列表中选择资源组。
选择“删除资源组”。
系统会要求确认是否删除资源组。键入资源组的名称进行确认，然后选择“删除”。

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

通过

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

先决条件

创建缓存

对缓存使用 Microsoft Entra ID 身份验证

添加连接字符串的本地机密

使用 RedisConnection 连接到缓存

执行缓存命令

处理缓存中的 .NET 对象

运行示例

清理资源

删除资源组的步骤

后续步骤

反馈

其他资源

通过

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

跳到 GitHub 上的代码

先决条件

创建缓存

对缓存使用 Microsoft Entra ID 身份验证

添加连接字符串的本地机密

使用 RedisConnection 连接到缓存

执行缓存命令

处理缓存中的 .NET 对象

运行示例

清理资源

删除资源组的步骤

后续步骤

反馈

其他资源