快速入门：在 Java 中使用 Azure Cache for Redis 和 Jedis Redis 客户端

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

跳转到 GitHub 查看代码

克隆 GitHub 上的存储库 Java 快速入门。

先决条件

• Azure 订阅 - 创建免费帐户
• Apache Maven

设置工作环境

以下步骤演示了如何为 Java 应用设置工作环境。 可以选择使用 Microsoft Entra ID（推荐）或访问密钥来对 Azure Cache for Redis 进行身份验证。

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export USER_NAME=<user-name>
export REDIS_CACHE_PORT=10000

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export USER_NAME=<user-name>
export REDIS_CACHE_PORT=6380

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export REDIS_CACHE_KEY=<your-primary-access-key>
export REDIS_CACHE_PORT=10000

export REDIS_CACHE_HOSTNAME=<your-host-name>.redis.cache.windows.net
export REDIS_CACHE_KEY=<your-primary-access-key>
export REDIS_CACHE_PORT=6380

新建 Java 应用

1. 使用 Maven 生成新的快速入门应用：

   mvn archetype:generate \
       -DarchetypeGroupId=org.apache.maven.archetypes \
       -DarchetypeArtifactId=maven-archetype-quickstart \
       -DarchetypeVersion=1.3 \
       -DinteractiveMode=false \
       -DgroupId=example.demo \
       -DartifactId=redis-jedis-test \
       -Dversion=1.0
   

2. 切换到新的 redis-jedis-test 项目目录。

3. 打开 pom.xml 文件。 在文件中，你会看到 Jedis 的依赖项：

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

   <dependency>
       <groupId>com.azure</groupId>
       <artifactId>azure-identity</artifactId>
       <version>1.15.0</version> <!-- {x-version-update;com.azure:azure-identity;dependency} -->
   </dependency>
   
   <dependency>
       <groupId>redis.clients</groupId>
       <artifactId>jedis</artifactId>
       <version>5.2.0</version> <!-- {x-version-update;redis.clients:jedis;external_dependency} -->
   </dependency>
   

4. 关闭 pom.xml 文件。

5. 打开 App.java，将代码替换为以下代码：

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

   package example.demo;
   
   import com.azure.identity.DefaultAzureCredential;
   import com.azure.identity.DefaultAzureCredentialBuilder;
   import com.azure.core.credential.TokenRequestContext;
   import redis.clients.jedis.DefaultJedisClientConfig;
   import redis.clients.jedis.Jedis;
   
   /**
    * Redis test
    *
    */
   public class App
   {
       public static void main( String[] args )
       {
   
           boolean useSsl = true;
   
           //Construct a Token Credential from Identity library, e.g. DefaultAzureCredential / ClientSecretCredential / Client CertificateCredential / ManagedIdentityCredential etc.
           DefaultAzureCredential defaultAzureCredential = new DefaultAzureCredentialBuilder().build();
   
           // Fetch a Microsoft Entra token to be used for authentication. This token will be used as the password.
                   String token = defaultAzureCredential
                           .getToken(new TokenRequestContext()
                                   .addScopes("https://redis.azure.com/.default")).block().getToken();
   
           String cacheHostname = System.getenv("REDIS_CACHE_HOSTNAME");
           String username = System.getenv("USER_NAME");
           int port = Integer.parseInt(System.getenv().getOrDefault("REDIS_CACHE_PORT", "6380"));
   
           // Connect to the Azure Cache for Redis over the TLS/SSL port using the key.
           Jedis jedis = new Jedis(cacheHostname, port, DefaultJedisClientConfig.builder()
                   .password(token) // Microsoft Entra access token as password is required.
                   .user(username) // Username is Required
                   .ssl(useSsl) // SSL Connection is Required
                   .build());
           // Perform cache operations 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 Redis 缓存实例。 此代码还在缓存中存储和检索字符串值。 还执行了 PING 和 CLIENT LIST 命令。

6. 关闭 App.java 文件。

生成并运行应用

执行以下 Maven 命令来生成并运行应用：

mvn compile 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 资源，以免产生费用。

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

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

   

3. 键入资源组的名称来确认删除，然后选择“删除”。

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

后续步骤

本快速入门介绍了如何通过 Java 应用程序使用 Azure Redis 缓存。 请继续学习下一个快速入门，将 Azure Cache for Redis 与 ASP.NET Web 应用配合使用。

• 发展
• 连接复原能力
• Azure Cache for Redis 与 Jakarta EE
• Azure Cache for Redis 与 Spring