快速入门：将 Azure Cache for Redis 与 Node.js 应用配合使用

项目
10/01/2024

在本快速入门中，你会将 Azure Cache for Redis 合并到 Node.js 应用中，以便能够访问 Azure 中的任何应用程序都可访问的安全专用缓存。

先决条件

Azure 订阅。创建一个
安装 Node.js。有关如何在 Windows 计算机上安装 Node 和 npm 的信息，请参阅在 Windows 上安装 Node.js。

创建缓存

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

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

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

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

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

安装 node-redis 客户端库

node-redis 库是 Redis 的主要 Node.js 客户端。你可以使用 npm 和以下命令来安装客户端：

npm install redis

创建 Node.js 应用以访问缓存

创建一个 Node.js 应用，该应用使用 Microsoft Entra ID 或访问密钥连接到 Azure Cache for Redis。建议使用 Microsoft Entra ID。

Microsoft Entra ID 身份验证（建议）
访问密钥身份验证

在缓存上启用 Microsoft Entra ID 身份验证

对于现有的缓存，首先请检查是否启用了 Microsoft Entra 身份验证。如果未启用，请完成以下步骤来启用 Microsoft Entra 身份验证。建议在应用程序中使用 Microsoft Entra ID 进行身份验证。

在 Azure 门户中，选择你想要使用基于 Microsoft Entra 令牌的身份验证的 Azure Cache for Redis 实例。
在服务菜单中的“设置”下，选择“身份验证”。
在“身份验证”窗格中，检查是否选中了“启用 Microsoft Entra 身份验证”复选框。如果是，你可以转到下一部分。
否则，请选中“启用 Microsoft Entra 身份验证”复选框。然后输入有效用户的名称。选择“保存”。将为输入的用户名自动分配数据所有者访问策略。

你还可以输入托管标识或服务主体来连接缓存。
在对话框中，系统会询问你是否要更新配置，并告知更新需要几分钟才能完成。选择是。

重要

启用操作完成后，缓存中的节点将重新启动以加载新配置。建议在标准维护时段或高峰营业时间之外完成此操作。此过程最多可能需要 30 分钟。

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

安装适用于 JavaScript 的 Azure 标识客户端库

适用于 JavaScript 的 Azure 标识客户端库使用所需的 Microsoft 身份验证库 (MSAL) 来提供令牌身份验证支持。使用 npm 安装该库：

npm install @azure/identity

使用 Microsoft Entra ID 创建 Node.js 应用

为主机名和服务主体 ID 添加环境变量。

服务主体 ID 是 Microsoft Entra ID 服务主体或用户的对象 ID。在 Azure 门户中，此值显示为“用户名”。
```
set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set REDIS_SERVICE_PRINCIPAL_ID=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
```
创建名为 redistest.js 的脚本文件。

将下面的示例 JavaScript 添加到文件。此代码演示了如何使用缓存主机名和密钥环境变量连接到 Azure Cache for Redis 实例。此代码还在缓存中存储和检索字符串值。还执行了 PING 和 CLIENT LIST 命令。有关将 Redis 与 node-redis 客户端一起使用的更多示例，请参阅 Node-Redis。

const { createClient } = require("redis");
const { DefaultAzureCredential } = require("@azure/identity");

async function main() {
  // Construct a Token Credential from Identity library, e.g. ClientSecretCredential / ClientCertificateCredential / ManagedIdentityCredential, etc.
  const credential = new DefaultAzureCredential();
  const redisScope = "https://redis.azure.com/.default";

  // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
  let accessToken = await credential.getToken(redisScope);
  console.log("access Token", accessToken);

  // Create redis client and connect to the Azure Cache for Redis over the TLS port using the access token as password.
  const cacheConnection = createClient({
    username: process.env.REDIS_SERVICE_PRINCIPAL_ID,
    password: accessToken.token,
    url: `redis://${process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME}:6380`,
    pingInterval: 100000,
    socket: { 
      tls: true,
      keepAlive: 0 
    },
  });

  cacheConnection.on("error", (err) => console.log("Redis Client Error", err));
  await cacheConnection.connect();

  // PING command
  console.log("\nCache command: PING");
  console.log("Cache response : " + await cacheConnection.ping());

  // SET
  console.log("\nCache command: SET Message");
  console.log("Cache response : " + await cacheConnection.set("Message",
      "Hello! The cache is working from Node.js!"));

  // GET
  console.log("\nCache command: GET Message");
  console.log("Cache response : " + await cacheConnection.get("Message"));

  // Client list, useful to see if connection list is growing...
  console.log("\nCache command: CLIENT LIST");
  console.log("Cache response : " + await cacheConnection.sendCommand(["CLIENT", "LIST"]));

  cacheConnection.disconnect();

  return "Done"
}

main().then((result) => console.log(result)).catch(ex => console.log(ex));

使用 Node.js 运行脚本：
```
node redistest.js
```

验证代码的输出如以下示例所示：

Cache command: PING
Cache response : PONG

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: SET Message
Cache response : OK

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: CLIENT LIST
Cache response : id=10017364 addr=76.22.73.183:59380 fd=221 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=32742 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 ow=0 owmem=0 events=r cmd=client user=default numops=6

Done

创建具有重新身份验证的示例 JavaScript 应用

Microsoft Entra ID 访问令牌的有效期大约为 75 分钟。若要保持与缓存的连接，必须刷新该令牌。

此示例演示如何使用 JavaScript 刷新令牌：

创建名为 redistestreauth.js 的脚本文件。

将下面的示例 JavaScript 添加到文件：

 const { createClient } = require("redis");
 const { DefaultAzureCredential } = require("@azure/identity");

 async function returnPassword(credential) {
     const redisScope = "https://redis.azure.com/.default";

     // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
     return credential.getToken(redisScope);
 }

 async function main() {
   // Construct a Token Credential from Identity library, e.g. ClientSecretCredential / ClientCertificateCredential / ManagedIdentityCredential, etc.
   const credential = new DefaultAzureCredential();
   let accessToken = await returnPassword(credential);

   // Create redis client and connect to the Azure Cache for Redis over the TLS port using the access token as password.
   let cacheConnection = createClient({
     username: process.env.REDIS_SERVICE_PRINCIPAL_ID,
     password: accessToken.token,
     url: `redis://${process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME}:6380`,
     pingInterval: 100000,
     socket: { 
       tls: true,
       keepAlive: 0 
     },
   });

   cacheConnection.on("error", (err) => console.log("Redis Client Error", err));
   await cacheConnection.connect();

   for (let i = 0; i < 3; i++) {
     try {
         // PING command
         console.log("\nCache command: PING");
         console.log("Cache response : " + await cacheConnection.ping());

         // SET
         console.log("\nCache command: SET Message");
         console.log("Cache response : " + await cacheConnection.set("Message",
             "Hello! The cache is working from Node.js!"));

         // GET
         console.log("\nCache command: GET Message");
         console.log("Cache response : " + await cacheConnection.get("Message"));

         // Client list, useful to see if connection list is growing...
         console.log("\nCache command: CLIENT LIST");
         console.log("Cache response : " + await cacheConnection.sendCommand(["CLIENT", "LIST"]));
       break;
     } catch (e) {
       console.log("error during redis get", e.toString());
       if ((accessToken.expiresOnTimestamp <= Date.now())|| (redis.status === "end" || "close") ) {
         await redis.disconnect();
         accessToken = await returnPassword(credential);
         cacheConnection = createClient({
           username: process.env.REDIS_SERVICE_PRINCIPAL_ID,
           password: accessToken.token,
           url: `redis://${process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME}:6380`,
           pingInterval: 100000,
           socket: {
             tls: true,
             keepAlive: 0
           },
         });
       }
     }
   }
 }

 main().then((result) => console.log(result)).catch(ex => console.log(ex));

使用 Node.js 运行脚本：
```
node redistestreauth.js
```

检查输出是否如以下示例所示：

 Cache command: PING
 Cache response : PONG

 Cache command: GET Message
 Cache response : Hello! The cache is working from Node.js!

 Cache command: SET Message
 Cache response : OK

 Cache command: GET Message
 Cache response : Hello! The cache is working from Node.js!

 Cache command: CLIENT LIST
 Cache response : id=10017364 addr=76.22.73.183:59380 fd=221 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=32742 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 ow=0 owmem=0 events=r cmd=client user=default numops=6

注意

有关如何使用 Microsoft Entra ID 通过 node-redis 库向 Redis 进行身份验证的更多示例，请参阅 node-redis GitHub 存储库。

获取主机名、端口和访问密钥

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

若要获取缓存的访问密钥，请执行以下操作：
1. 在 Azure 门户中转到自己的缓存。
2. 在服务菜单中的“设置”下，选择“身份验证”。
3. 在“身份验证”窗格上，选择“访问密钥”选项卡。
4. 若要复制访问密钥的值，请选择密钥字段中的“复制”图标。
若要获取缓存的主机名和端口，请执行以下操作：
1. 在 Azure 门户中转到自己的缓存。
2. 在服务菜单中，选择“概述”。
3. 在“Essentials”下，对于“主机名”，请选择“复制”图标以复制主机名值。主机名值的形式为 <DNS name>.redis.cache.chinacloudapi.cn。
4. 对于“端口”，请选择“复制”图标以复制端口值。

为主机名和主访问密钥添加环境变量。通过代码使用这些变量，而不是直接在代码中包含敏感信息。

set AZURE_CACHE_FOR_REDIS_HOST_NAME=contosoCache
set AZURE_CACHE_FOR_REDIS_ACCESS_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

连接到缓存

注意

不要为代码中的每个操作创建新连接，而应尽可能重用连接。

新建 Node.js 应用

创建名为 redistest.js 的新脚本文件。

将下面的示例 JavaScript 添加到文件：

const redis = require("redis");

// Environment variables for cache
const cacheHostName = process.env.AZURE_CACHE_FOR_REDIS_HOST_NAME;
const cachePassword = process.env.AZURE_CACHE_FOR_REDIS_ACCESS_KEY;

if(!cacheHostName) throw Error("AZURE_CACHE_FOR_REDIS_HOST_NAME is empty")
if(!cachePassword) throw Error("AZURE_CACHE_FOR_REDIS_ACCESS_KEY is empty")

async function testCache() {

    // Connection configuration
    const cacheConnection = redis.createClient({
        // redis for TLS
        url: `redis://${cacheHostName}:6380`,
        password: cachePassword
    });

    // Connect to Redis
    await cacheConnection.connect();

    // PING command
    console.log("\nCache command: PING");
    console.log("Cache response : " + await cacheConnection.ping());

    // GET
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.get("Message"));

    // SET
    console.log("\nCache command: SET Message");
    console.log("Cache response : " + await cacheConnection.set("Message",
        "Hello! The cache is working from Node.js!"));

    // GET again
    console.log("\nCache command: GET Message");
    console.log("Cache response : " + await cacheConnection.get("Message"));

    // Client list, useful to see if connection list is growing...
    console.log("\nCache command: CLIENT LIST");
    console.log("Cache response : " + await cacheConnection.sendCommand(["CLIENT", "LIST"]));

    // Disconnect
    cacheConnection.disconnect()

    return "Done"
}

testCache().then((result) => console.log(result)).catch(ex => console.log(ex));

此代码演示了如何使用缓存主机名和密钥环境变量连接到 Azure Cache for Redis 实例。此代码还在缓存中存储和检索字符串值。还执行了 PING 和 CLIENT LIST 命令。有关将 Redis 与 node_redis 客户端一起使用的更多示例，请参阅 Node-Redis。

使用 Node.js 运行脚本：
```
node redistest.js
```

验证输出是否如以下示例所示：

Cache command: PING
Cache response : PONG

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: SET Message
Cache response : OK

Cache command: GET Message
Cache response : Hello! The cache is working from Node.js!

Cache command: CLIENT LIST
Cache response : id=10017364 addr=76.22.73.183:59380 fd=221 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=26 qbuf-free=32742 argv-mem=10 obl=0 oll=0 omem=0 tot-mem=61466 ow=0 owmem=0 events=r cmd=client user=default numops=6

Done

清理资源

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

否则，为了避免与资源相关的费用，若已用完资源，可以删除已创建的 Azure 资源组。

警告

删除资源组的操作不可逆。删除一个资源组时，该资源组中的所有资源都会被永久删除。请确保不会意外删除错误的资源组或资源。如果在现有资源组内创建了资源，并且该资源组中还有想要保留的资源，可以逐个删除这些资源，而不是删除资源组。

删除资源组

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

如果有多个资源组，请在“筛选任何字段”中，输入为完成本文创建的资源组的名称。在搜索结果列表中，选择该资源组。
选择“删除资源组”。
在“删除资源组”窗格中，输入资源组的名称进行确认，然后选择“删除”。

很快将会删除该资源组及其所有资源。

获取示例代码

获取 GitHub 上的 Node.js 快速入门示例。

创建使用 Azure Cache for Redis 的 ASP.NET Web 应用

通过