在Spring Boot微服务使用JedisCluster操作Redis集群String字符串

记录：449

场景：在Spring Boot微服务使用JedisCluster操作Redis集群的String字符串数据类型。

版本：JDK 1.8,Spring Boot 2.6.3,redis-6.2.5,jedis-3.7.1。

1.微服务中配置Redis信息

1.1在pom.xml添加依赖

pom.xml文件：

<dependency><groupId>redis.clients</groupId><artifactId>jedis</artifactId><version>3.7.1</version>
</dependency>

解析：在Spring Boot中默认集成jedis，使用无需加版本号，本例版本3.7.1是Spring Boot 2.6.3对应的版本。

1.2在application.yml中配置Redis集群信息

(1)application.yml配置内容

hub:example:redis:jedis-cluster:password: demo12345678connection-timeout: 60000so-timeout: 1000max-attempts: 100nodes:- 192.168.19.161:27001- 192.168.19.161:27002- 192.168.19.162:27001- 192.168.19.162:27002- 192.168.19.163:27001- 192.168.19.163:27002

(2)解析

在application.yml中配置内容是自定义的，对应自定义配置类JedisClusterProperties。

类全称：com.hub.example.config.JedisClusterProperties。

自定义配置类使用如下注解生效：

@ConfigurationProperties(prefix = "hub.example.redis.jedis-cluster")

1.3加载简要逻辑

Spring Boot微服务在启动时，自动注解机制会读取application.yml的配置信息注入到自定义配置类JedisClusterProperties对象的对应属性。因此，在Spring环境中就能取到Redis集群的配置信息。

Spring从JedisClusterProperties对象中取配置注入到JedisCluster客户端中。因此，JedisCluster客户端就能对Redis集群做增、删、改、查等操作。

2.配置JedisCluster

JedisCluster是jedis框架中封装的操作Redis的客户端。

类全称：redis.clients.jedis.JedisCluster

2.1配置JedisClusterProperties

JedisClusterProperties是自定义配置了，作用是加载application.yml中Redis集群的配置信息。

使用@ConfigurationProperties注解生效，使用注解的prefix指定配置application.yml中前缀。

@Component
@ConfigurationProperties(prefix = "hub.example.redis.jedis-cluster")
public class JedisClusterProperties {private List<String> nodes;private String password;private int connectionTimeout;private int soTimeout;private int maxAttempts;public List<String> getNodes() {return nodes;}public void setNodes(List<String> nodes) {this.nodes = nodes;}public String getPassword() {return password;}public void setPassword(String password) {this.password = password;}public int getConnectionTimeout() {return connectionTimeout;}public void setConnectionTimeout(int connectionTimeout) {this.connectionTimeout = connectionTimeout;}public int getSoTimeout() {return soTimeout;}public void setSoTimeout(int soTimeout) {this.soTimeout = soTimeout;}public int getMaxAttempts() {return maxAttempts;}public void setMaxAttempts(int maxAttempts) {this.maxAttempts = maxAttempts;}
}

2.2配置JedisCluster

@Configuration
public class JedisClusterConfig {@AutowiredJedisClusterProperties jedisClusterProperties;@Bean("jedisCluster")public JedisCluster getJedisCluster(JedisPoolConfig jedisPoolConfigCluster) {List<String> nodesList = jedisClusterProperties.getNodes();Set<HostAndPort> nodesSet = new HashSet<>();for (String ipAndPort : nodesList) {String[] ipAndPortPair = ipAndPort.split(":");nodesSet.add(new HostAndPort(ipAndPortPair[0].trim(), Integer.parseInt(ipAndPortPair[1].trim())));}return new JedisCluster(nodesSet,jedisClusterProperties.getConnectionTimeout(),jedisClusterProperties.getSoTimeout(),jedisClusterProperties.getMaxAttempts(),jedisClusterProperties.getPassword(),jedisPoolConfigCluster);}@Bean("jedisPoolConfigCluster")public JedisPoolConfig jedisPoolConfigCluster() {JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();jedisPoolConfig.setMaxTotal(30);jedisPoolConfig.setMaxIdle(30);jedisPoolConfig.setMinIdle(1);jedisPoolConfig.setNumTestsPerEvictionRun(-1);jedisPoolConfig.setTestOnBorrow(true);jedisPoolConfig.setTestOnReturn(false);jedisPoolConfig.setBlockWhenExhausted(false);return jedisPoolConfig;}
}

2.3解析

配置JedisCluster后，在Spring环境中，使用@Autowired注解注入JedisCluster实例操作Redis集群。

3.使用Jedis操作Redis集群String字符串

3.1简要说明

使用JedisCluster操作Redis集群String字符串，常用操作：增、查、改、删、设置超时等。

3.2操作示例

@RestController
@RequestMapping("/hub/example/operateJedisCluster")
@Slf4j
public class OperateJedisClusterController {@Autowiredprivate JedisCluster jedisCluster;/*** 使用JedisCluster操作Redis集群String字符串类型数据*/@GetMapping("/f02")public Object f02() {log.info("JedisCluster操作Redis集群开始...");// 1.增// 1.1写一条数据jedisCluster.set("J:2023060802:01", "苏州");// 1.2写一条数据,键不存在时,才对键进行设置操作jedisCluster.setnx("J:2023060802:02", "苏州-工业园区");// 1.3写一条数据,并设置超时,600秒jedisCluster.setex("J:2023060802:03", 600L, "苏州-相城");// 2.查String result01 = jedisCluster.get("J:2023060802:01");log.info("查询J:2023060802:01 = " + result01.toString());// 3.改// 3.1修改一条数据jedisCluster.set("J:2023060802:01", "苏州-姑苏");// 3.1修改一条数据,只有键存在才修改SetParams setParams01 = new SetParams();setParams01.ex(5 * 60L);setParams01.xx();jedisCluster.set("J:2023060802:03", "苏州-工业园区-苏州", setParams01);// 4.删long time = 8000;log.info("{}秒后,删除J:2023060802:03.", time / 1000);ThreadUtil.sleep(time);jedisCluster.del("J:2023060802:03");// 5.判断键是否存在Boolean exists01 = jedisCluster.exists("J:2023060802:03");// 6.设置超时// 6.1设置5分钟超时SetParams setParams02 = new SetParams();setParams02.ex(5 * 60L);jedisCluster.set("J:2023060802:04", "苏州-昆山", setParams02);// 6.2设置10分钟超时jedisCluster.expire("J:2023060802:04", 10 * 60L);// 7.查存活时间Long ttl = jedisCluster.ttl("J:2023060802:04");log.info("缓存J:2023060802:04剩余存活时间: {}", ttl);log.info("JedisCluster操作Redis集群结束...");return "执行成功";}
}

3.3测试验证

使用Postman测试。

请求RUL：http://127.0.0.1:18205/hub-205-redis/hub/example/operateJedisCluster/f02

以上，感谢。

2023年6月8日