在Spring Boot微服务使用ListOperations操作Redis集群List列表

记录：444

场景：在Spring Boot微服务使用RedisTemplate的ListOperations操作Redis集群的List列表数据类型。

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

1.微服务中配置Redis信息

1.1在pom.xml添加依赖

pom.xml文件：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-redis</artifactId>
  <version>2.6.3</version>
</dependency>

解析：spring-boot-starter-data-redis和spring-boot版本保持一致。

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

(1)application.yml配置内容

spring:
  redis:
    cluster:
      nodes:
        - 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
    password: demo12345678
    timeout: 60000

(2)解析

配置内容来源。

jar包：spring-boot-autoconfigure-2.6.3.jar。

类：org.springframework.boot.autoconfigure.data.redis.RedisProperties。

当引入spring-boot-starter时，此包已经引入。

当需要配置集群其它信息时，在RedisProperties类中查找并配置到application.yml就能生效。

1.3加载简要逻辑

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

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

2.配置RedisTemplate

RedisTemplate是springframework框架中封装的操作Redis的客户端。

类全称：org.springframework.data.redis.core.RedisTemplate

2.1配置RedisTemplate

@Configuration
public class RedisConfig {
  @Bean("redisTemplate")
  public RedisTemplate<String, Object> redisTemplate(LettuceConnectionFactory lettuceConnectionFactory) {
      // 1.创建RedisTemplate对象
      RedisTemplate<String, Object> redisTemplate = new RedisTemplate<String, Object>();
      // 2.加载Redis配置
      redisTemplate.setConnectionFactory(lettuceConnectionFactory);
      // 3.配置key序列化
      RedisSerializer<?> stringRedisSerializer = new StringRedisSerializer();
      redisTemplate.setKeySerializer(stringRedisSerializer);
      redisTemplate.setHashKeySerializer(stringRedisSerializer);
      // 4.配置Value序列化
      Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
      ObjectMapper objMapper = new ObjectMapper();
      objMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
      objMapper.activateDefaultTyping(objMapper.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.NON_FINAL);
      jackson2JsonRedisSerializer.setObjectMapper(objMapper);
      redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
      redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
      // 5.初始化RedisTemplate
      redisTemplate.afterPropertiesSet();
      return redisTemplate;
  }
  @Bean
  public ListOperations<String, Object> listOperations(RedisTemplate<String, Object> redisTemplate) {
      return redisTemplate.opsForList();
  }
}

2.2解析

使用@Configuration和@Bean配置RedisTemplate后，使用@Autowired注解注入RedisTemplate和ListOperations实例操作Redis集群。

3.使用ListOperations操作Redis集群List列表

3.1简要说明

使用ValueOperations操作字符串，常用操作：增、查、改、删、设置超时等。

3.2操作示例

@RestController
@RequestMapping("/hub/example/operateCluster")
@Slf4j
public class OperateClusterController {
  @Autowired
  private RedisTemplate redisTemplate;
  @Autowired
  private ListOperations listOperations;
  /**
   * 使用ListOperations,操作List类型数据
   */
  @GetMapping("/f03")
  public Object f03() {
      log.info("ListOperations操作Redis集群开始...");
      // 1.增
      listOperations.leftPush("D:2023060803:01", "杭州");
      listOperations.rightPush("D:2023060803:01", "苏州");
      // 2.查,查出队列指定范围元素,不会删除队列里面数据,(0,-1)查出全部元素
      listOperations.leftPush("D:2023060803:01", "南京");
      listOperations.leftPush("D:2023060803:01", "无锡");
      List cityList = redisTemplate.boundListOps("D:2023060803:01").range(0, -1);
      cityList.forEach((value) -> {
          System.out.println("从队列D:2023060803:01取值: " + value);
      });
      // 3.取,逐个取出队列元素(取出一个元素后,队列就没有这个元素了)
      Object city01 = listOperations.leftPop("D:2023060803:01");
      Object city02 = listOperations.rightPop("D:2023060803:01");
      log.info("从队列D:2023060803:01取出: city01=" + city01 + ",city02=" + city02);
      // 4.删
      listOperations.leftPush("D:2023060803:01", "常州");
      listOperations.leftPush("D:2023060803:01", "绍兴");
      long time = 5000;
      log.info("{}秒后,删除D:2023060803:01队列", time / 1000);
      ThreadUtil.sleep(time);
      redisTemplate.delete("D:2023060803:01");
      // 5.设置超时
      listOperations.leftPush("D:2023060803:02", "上海");
      redisTemplate.boundValueOps("D:2023060803:02").expire(5, TimeUnit.MINUTES);
      redisTemplate.expire("D:2023060803:02", 10, TimeUnit.MINUTES);
      // 6.查询List的元素个数
      Long size = listOperations.size("D:2023060803:02");
      System.out.println("查询List的元素个数,size=" + size);
      log.info("ListOperations操作Redis集群结束...");
      return "执行成功";
  }
}

3.3测试验证

使用Postman测试。

请求RUL：http://127.0.0.1:18205/hub-205-redis/hub/example/operateCluster/f03

以上，感谢。

2023年6月8日