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

项目
10/01/2024

在本快速入门中，你将使用 Jedis Redis 客户端将 Azure Cache for Redis 整合到 Java 应用中。你的应用连接到可通过 Azure 中的任何应用程序进行访问的安全专用缓存。

本快速入门使用 Maven 原型功能为 Java 应用生成基架。本快速入门介绍如何配置代码来创建连接到 Azure Cache for Redis 的工作应用。

如果要直接转到代码，请参阅 GitHub 上的 Java 快速入门示例。

先决条件

Azure 订阅。创建一个
Apache Maven

创建缓存

若要创建缓存，请登录到 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 的概述页上监视进度。如果“状态”显示为“正在运行”，则表示该缓存可供使用。

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

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

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

设置工作环境

根据操作系统，为上述的主机名和主访问密钥添加环境变量。在命令提示符窗口或终端窗口中，设置以下值：

Linux
Windows

export REDISCACHEHOSTNAME=<your-host-name>.redis.cache.chinacloudapi.cn
export REDISCACHEKEY=<your-primary-access-key>

set REDISCACHEHOSTNAME=<your-host-name>.redis.cache.chinacloudapi.cn
set REDISCACHEKEY=<your-primary-access-key>

将占位符替换为以下值：

<your-host-name>：在 Azure 门户中从 Azure Cache for Redis 资源的“属性”部分获取的 DNS 主机名。
<your-primary-access-key>：在 Azure 门户中从 Azure Cache for Redis 资源的“访问密钥”部分获取的主访问密钥。

查看 Java 示例

在本示例中，你使用 Maven 运行快速入门应用。

转到新的 redistest 项目目录。

打开 pom.xml 文件。在文件中，验证是否显示了 Jedis 的依赖项：

<dependency>
  <groupId>redis.clients</groupId>
  <artifactId>jedis</artifactId>
  <version>4.1.0</version>
  <type>jar</type>
  <scope>compile</scope>
</dependency>

关闭 pom.xml 文件。

打开 App.java 并验证是否显示了以下代码：

package example.demo;

import redis.clients.jedis.DefaultJedisClientConfig;
import redis.clients.jedis.Jedis;

/**
 * Redis test
 *
 */
public class App 
{
    public static void main( String[] args )
    {

        boolean useSsl = true;
        String cacheHostname = System.getenv("REDISCACHEHOSTNAME");
        String cachekey = System.getenv("REDISCACHEKEY");

        // Connect to the Azure Cache for Redis over the TLS/SSL port using the key.
        Jedis jedis = new Jedis(cacheHostname, 6380, DefaultJedisClientConfig.builder()
            .password(cachekey)
            .ssl(useSsl)
            .build());

        // Perform cache operations by using the cache connection object. 

        // Simple PING command
        System.out.println( "\nCache Command  : Ping" );
        System.out.println( "Cache Response : " + jedis.ping());

        // Simple get and put of integral data types into the cache
        System.out.println( "\nCache Command  : GET Message" );
        System.out.println( "Cache Response : " + jedis.get("Message"));

        System.out.println( "\nCache Command  : SET Message" );
        System.out.println( "Cache Response : " + jedis.set("Message", "Hello! The cache is working from Java!"));

        // Demonstrate "SET Message" executed as expected...
        System.out.println( "\nCache Command  : GET Message" );
        System.out.println( "Cache Response : " + jedis.get("Message"));

        // Get the client list, useful to see if connection list is growing...
        System.out.println( "\nCache Command  : CLIENT LIST" );
        System.out.println( "Cache Response : " + jedis.clientList());

        jedis.close();
    }
}

此代码演示了如何使用缓存主机名和密钥环境变量连接到 Azure Cache for Redis 实例。此代码还在缓存中存储和检索字符串值。还执行了 PING 和 CLIENT LIST 命令。

关闭 App.java。

生成并运行应用

如上所述设置环境变量：

Linux
Windows

export REDISCACHEHOSTNAME=<your-host-name>.redis.cache.chinacloudapi.cn
export REDISCACHEKEY=<your-primary-access-key>

set REDISCACHEHOSTNAME=<your-host-name>.redis.cache.chinacloudapi.cn
set REDISCACHEKEY=<your-primary-access-key>

若要生成并运行应用，请运行以下 Maven 命令：

Linux
Windows

mvn compile
mvn exec:java -D exec.mainClass=example.demo.App

mvn compile
mvn exec:java -D exec.mainClass=example.demo.App

在以下输出中，可以看到 Message 键之前有一个缓存值。已使用 jedis.set 将值更新为一个新值。应用还执行了 PING 和 CLIENT LIST 命令。

Cache Command  : Ping
Cache Response : PONG

Cache Command  : GET Message
Cache Response : Hello! The cache is working from Java!

Cache Command  : SET Message
Cache Response : OK

Cache Command  : GET Message
Cache Response : Hello! The cache is working from Java!

Cache Command  : CLIENT LIST
Cache Response : id=777430 addr=             :58989 fd=22 name= age=1 idle=0 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=32768 obl=0 oll=0 omem=0 ow=0 owmem=0 events=r cmd=client numops=6

清理资源

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

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

警告

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

删除资源组

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

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

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

通过