SpringBoot一键集成Redis

您好，我是码农飞哥，感谢您阅读本文！本文主要介绍SpringBoot如何整合Redis。

引入依赖

啥都不说，先引入依赖，SpringBoot其实已经整合好了redis,这里就直接使用Spring的redis来操作。

1. <dependency>
2. <groupId>org.springframework.boot</groupId>
3. <artifactId>spring-boot-starter-data-redis</artifactId>
4. <version>2.1.2.RELEASE</version>
5. </dependency>

Redis的配置

最简单的配置（单机模式）

直接在application.yml 添加如下配置：

1. spring:
2. redis:
3. host: 127.0.0.1
4. password: 123456
5. port: 6379
6. database: 1

配置好之后就可以直接使用StringRedisTemplate 以及RedisTemplate两个redis客户端的操作类了。这是由于SpringBoot的自动配置，SpringBoot通过RedisProperties类来映射yml中的Redis配置，通过RedisAutoConfiguration配置类来加载Redis配置。

哨兵模式配置

1.在yml文件中配置好哨兵

1. spring:
2. redis:
3. sentinel:
4. master: mymaster
5. nodes: 127.0.0.1:26379,127.0.0.1:26380,127.0.0.1:26381
6. password: 123456
7. lettuce:
8. pool:
9. max-idle: 30
10. database: 1

2. 定义配置类

1. // 定义配置类
2. @Configuration
3. // 启动自动配置
4. @EnableAutoConfiguration
5. public class RedisSentinelConfig {
6. private static Logger logger = LoggerFactory.getLogger(RedisSentinelConfig.class);
8. @Value("#{'${spring.redis.sentinel.nodes}'.split(',')}")
9. private List<String> nodes;
11. @Value("${spring.redis.password}")
12. private String password;
14. @Value("${spring.redis.sentinel.nodes}")
15. private String redisNodes;
17. @Value("${spring.redis.sentinel.master}")
18. private String master;
20. // 定义redis的连接池
21. @Bean(name = "poolConfig")
22. @ConfigurationProperties(prefix = "spring.redis")
23. public JedisPoolConfig poolConfig() {
24. JedisPoolConfig poolConfig = new JedisPoolConfig();
25. return poolConfig;
26. }
28. //定义RedisSentinelConfiguration，用于设置哨兵
29. @Bean
30. public RedisSentinelConfiguration sentinelConfiguration() {
31. RedisSentinelConfiguration redisSentinelConfiguration = new RedisSentinelConfiguration();
32. //配置matser的名称
33. redisSentinelConfiguration.master(master);
34. //数据库是1库
35. redisSentinelConfiguration.setDatabase(1);
36. redisSentinelConfiguration.setPassword(password);
37. //配置redis的哨兵sentinel
38. Set<RedisNode> redisNodeSet = new HashSet<>();
39. nodes.forEach(x -> {
40. redisNodeSet.add(new RedisNode(x.split(":")[0], Integer.parseInt(x.split(":")[1])));
41. });
42. logger.info("redisNodeSet -->" + redisNodeSet);
43. redisSentinelConfiguration.setSentinels(redisNodeSet);
44. return redisSentinelConfiguration;
45. }
47. //定义工厂类
48. @Bean
49. public JedisConnectionFactory redisConnectionFactory(
50. JedisPoolConfig poolConfig,
51. RedisSentinelConfiguration sentinelConfig) {
52. return new JedisConnectionFactory(sentinelConfig, poolConfig);
53. }

这样就定义好了。

源码分析

RedisAutoConfiguration配置类的代码如下;

1. @Configuration
2. @ConditionalOnClass(RedisOperations.class)
3. @EnableConfigurationProperties(RedisProperties.class)
4. @Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })
5. public class RedisAutoConfiguration {
7. //定义了RedisTemplate<Object, Object>的实例，只有当存在名为redisTemplate的时才启动
8. @Bean
9. @ConditionalOnMissingBean(name = "redisTemplate")
10. public RedisTemplate<Object, Object> redisTemplate(
11. RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
12. RedisTemplate<Object, Object> template = new RedisTemplate<>();
13. template.setConnectionFactory(redisConnectionFactory);
14. return template;
15. }
17. //定义了StringRedisTemplate的实例
18. @Bean
19. @ConditionalOnMissingBean
20. public StringRedisTemplate stringRedisTemplate(
21. RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
22. StringRedisTemplate template = new StringRedisTemplate();
23. template.setConnectionFactory(redisConnectionFactory);
24. return template;
25. }
27. }

代码说明：

1. @Configuration注解标记RedisAutoConfiguration类是一个配置类，可以替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。通过该注解之后可以保证Bean是单例的。
2. @ConditionalOnClass 的作用是定义条件装配，只有当RedisOperations类存在时才启动该配置
3. @EnableConfigurationProperties 的作用是开启@ConfigurationProperties。 @ConfigurationProperties的作用是将配置文件转换成类对象，便于修改或者获取值。
4. @Import({LettuceConnectionConfiguration.class,JedisConnectionConfiguration.class})的作用是引入LettuceConnectionConfiguration和JedisConnectionConfiguration两个配置类，其中LettuceConnectionConfiguration配置类中定义了LettuceConnectionFactory连接工厂类，JedisConnectionConfiguration定义了JedisConnectionFactory连接工厂类。

总结

本文详细介绍了如何在SpringBoot中整合Redis。最简单的单机模式的Redis整合只需要在yml文件中配置redis数据库的地址即可，其他哨兵模式和集群模式的Redis配置需要自己定义配置类。