Spring Boot 3 配置 Redis 兼容单例和集群

配置项

Spring Boot 3.x 的 redis 配置和 Spring Boot 2.x 是不一样的, 路径多了一个data

1. spring:
2.   ...
3.   data:
4.     redis:
5.       host: @redis.host@
6.       port: @redis.port@
7.       password: @redis.password@
8.       database: @redis.database@

复制代码

兼容单例和集群的配置

开发时一般用一个Redis单例就足够, 测试和生产环境再换成集群, 但是在application.yml中默认的 Redis 单例和集群配置格式是不同的, 如果要用同一套格式兼容两种配置, 需要自定义 RedisConnectionFactory 这个bean的初始化.

1. @Configuration
2. public class RedisConfig {
4.     @Value("${spring.data.redis.host}")
5.     public String host;
6.     @Value("${spring.data.redis.port}")
7.     public int port;
8.     @Value("${spring.data.redis.password}")
9.     public String password;
10.     @Value("${spring.data.redis.database}")
11.     public int database;
13.     @Bean
14.     public RedisTemplate<String, String> redisStringTemplate(RedisConnectionFactory redisConnectionFactory) {
15.         RedisTemplate<String, String> redisTemplate = new RedisTemplate<>();
16.         redisTemplate.setConnectionFactory(redisConnectionFactory);
17.         redisTemplate.setDefaultSerializer(new StringRedisSerializer());
18.         return redisTemplate;
19.     }
21.     @Bean
22.     public RedisTemplate<String, byte[]> redisBytesTemplate(RedisConnectionFactory redisConnectionFactory) {
23.         RedisTemplate<String, byte[]> redisTemplate = new RedisTemplate<>();
24.         redisTemplate.setConnectionFactory(redisConnectionFactory);
26.         RedisSerializer<String> redisKeySerializer = new StringRedisSerializer();
27.         redisTemplate.setKeySerializer(redisKeySerializer);
28.         redisTemplate.setHashKeySerializer(redisKeySerializer);
29.         redisTemplate.setValueSerializer(RedisSerializer.byteArray());
30.         redisTemplate.setHashValueSerializer(RedisSerializer.byteArray());
32.         return redisTemplate;
33.     }
35.     @Bean
36.     public RedisConnectionFactory lettuceConnectionFactory() {
37.         if (host.contains(",")) {
38.             RedisClusterConfiguration config = new RedisClusterConfiguration(Arrays.asList(host.split(",")));
39.             config.setMaxRedirects(3);
40.             if (password != null && !password.isEmpty()) {
41.                 config.setPassword(RedisPassword.of(password));
42.             }
43.             LettuceConnectionFactory factory = new LettuceConnectionFactory(config);
44.             factory.afterPropertiesSet();
45.             return factory;
47.         } else {
48.             RedisStandaloneConfiguration config = new RedisStandaloneConfiguration();
49.             config.setHostName(host);
50.             config.setPort(port);
51.             config.setDatabase(database);
52.             if (password != null && !password.isEmpty()) {
53.                 config.setPassword(RedisPassword.of(password));
54.             }
55.             LettuceConnectionFactory factory = new LettuceConnectionFactory(config);
56.             factory.afterPropertiesSet();
57.             return factory;
58.         }
59.     }
61. }

复制代码

如许, 当配置改为集群时, 只需要修改 spring.data.redis.host 的内容为 1.1.1.1:6379,1.1.1.2:6379,1.1.1.3:6379如许的格式就可以了.
使用 Byte 作为值存储

ByteUtil.java

1. public class ByteUtil {
3.     public static byte[] toByte(String str) {
4.         if (str == null) return null;
5.         return str.getBytes();
6.     }
8.     public static byte[][] toByte(String[] strs) {
9.         if (strs == null) return null;
10.         byte[][] arr = new byte[strs.length][];
11.         for (int i = 0; i < strs.length; i++) {
12.             arr[i] = strs[i].getBytes();
13.         }
14.         return arr;
15.     }
17.     public static String toString(byte[] bytes) {
18.         return bytes == null ? null : new String(bytes);
19.     }
21.     public static Set<String> toString(Set<byte[]> byteset) {
22.         if (byteset == null) return null;
23.         return byteset.stream()
24.                 .map(String::new)
25.                 .collect(Collectors.toSet());
26.     }
28.     public static List<String> toStrings(List<byte[]> byteslist) {
29.         if (byteslist == null) return null;
30.         return byteslist.stream()
31.                 .map(String::new)
32.                 .collect(Collectors.toList());
33.     }
35.     public static byte[] toByte(int x) {
36.         ByteBuffer buffer = ByteBuffer.allocate(Integer.BYTES);
37.         buffer.putInt(x);
38.         return buffer.array();
39.     }
40.     public static int toInteger(byte[] bytes) {
41.         ByteBuffer buffer = ByteBuffer.allocate(Integer.BYTES);
42.         buffer.put(bytes);
43.         buffer.flip();//need flip
44.         return buffer.getInt();
45.     }
47.     public static byte[] toByte(long x) {
48.         ByteBuffer buffer = ByteBuffer.allocate(Long.BYTES);
49.         buffer.putLong(x);
50.         return buffer.array();
51.     }
52.     public static long toLong(byte[] bytes) {
53.         ByteBuffer buffer = ByteBuffer.allocate(Long.BYTES);
54.         buffer.put(bytes);
55.         buffer.flip();//need flip
56.         return buffer.getLong();
57.     }
59.     public static byte[] toByte(Object object) {
60.         if (object == null) return null;
61.         try (ByteArrayOutputStream baos = new ByteArrayOutputStream();
62.              ObjectOutputStream oos = new ObjectOutputStream(baos)) {
63.             oos.writeObject(object);
64.             return baos.toByteArray();
65.         } catch (IOException e) {
66.             throw new RuntimeException(e);
67.         }
68.     }
70.     public static <T> List<T> toObjs(List<byte[]> byteslist) {
71.         if (byteslist == null) return null;
72.         List<T> list = new ArrayList<>();
73.         for (byte[] bytes : byteslist) {
74.             T t = toObj(bytes);
75.             list.add(t);
76.         }
77.         return list;
78.     }
80.     @SuppressWarnings("unchecked")
81.     public static <T> T toObj(byte[] bytes) {
82.         if (bytes == null || bytes.length < 8) return null;
83.         try (ByteArrayInputStream bais = new ByteArrayInputStream(bytes);
84.              ObjectInputStream ois = new ObjectInputStream(bais)) {
85.             return (T)ois.readObject();
86.         } catch (IOException|ClassNotFoundException e) {
87.             throw new RuntimeException(e);
88.         }
89.     }
90. }

复制代码

在服务中的调用方式

1. @Autowired
2. private RedisTemplate<String, byte[]> redisBytesTemplate;
4. @Override
5. public Boolean hasKey(String key) {
6.     return redisBytesTemplate.hasKey(key);
7. }
9. @Override
10. public Boolean hashHasKey(String key, String field) {
11.     return redisBytesTemplate.opsForHash().hasKey(key,field);
12. }
14. @Override
15. public Integer hashGetInt(String key, String field) {
16.     HashOperations<String, String, byte[]> opsForHash = redisBytesTemplate.opsForHash();
17.     byte[] bytes = opsForHash.get(key, field);
18.     return bytes == null? null : ByteUtil.toInteger(bytes);
19. }
21. @Override
22. public void hashSetInt(String key, String field, int value) {
23.     HashOperations<String, String, byte[]> opsForHash = redisBytesTemplate.opsForHash();
24.     opsForHash.put(key, field, ByteUtil.toByte(value));
25. }
27. @Override
28. public <T> T hashGetObj(String key, String field) {
29.     HashOperations<String, String, byte[]> opsForHash = redisBytesTemplate.opsForHash();
30.     return ByteUtil.toObj(opsForHash.get(key, field));
31. }
33. @Override
34. public <T> void hashSetObj(String key, String field, T value) {
35.     HashOperations<String, String, byte[]> opsForHash = redisBytesTemplate.opsForHash();
36.     opsForHash.put(key, field, ByteUtil.toByte(value));
37. }
39. /**
40. * @param timeout seconds to block
41. */
42. @Override
43. public <T> T bLPopObj(int timeout, String key) {
44.     ListOperations<String, byte[]> opsForList = redisBytesTemplate.opsForList();
45.     byte[] bytes = opsForList.leftPop(key, timeout, TimeUnit.SECONDS);
46.     return ByteUtil.toObj(bytes);
47. }
49. @Override
50. public <T> Long rPush(String key, T value) {
51.     ListOperations<String, byte[]> opsForList = redisBytesTemplate.opsForList();
52.     return opsForList.rightPush(key, ByteUtil.toByte(value));
53. }

复制代码

参考

• https://vincentbogousslavsky.com/post/configuration-for-spring-data-redis-reactive-for-connecting
  创建 RedisClusterConfiguration
  
• https://blog.csdn.net/weixin_67601403/article/details/129706748
  创建 RedisConnectionFactory lettuceConnectionFactory
  
• https://cloud.tencent.com/developer/article/2371793
  默认的级联配置方式
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。