Spring Boot 2自动配置Redis

spring boot有以下方式配置redis：

• 自动配置
• 编程式配置
• xml配置

这里介绍自动配置方式。

Spring boot使用spring-boot-starter-data-redis来自动配置Lettuce和Jedis这两种redis的Java客户端。默认选用的是Lettuce。

添加依赖

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

切换Lettuce和Jedis

默认使用Lettuce，改用Jedis：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <exclusions>
        <exclusion>
            <groupId>io.lettuce</groupId>
            <artifactId>lettuce-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
</dependency>

配置application.properties

#用于Connection Factory的数据库索引
spring.redis.database=0
spring.redis.host=localhost
spring.redis.port=6379
# 连接超时时间 单位 ms（毫秒）
spring.redis.timeout=3000
# 连接池中的最大空闲连接，默认值也是8。
spring.redis.pool.max-idle=8
#连接池中的最小空闲连接，默认值也是0。
spring.redis.pool.min-idle=0
# 如果赋值为-1，则表示不限制；如果pool已经分配了maxActive个jedis实例，则此时pool的状态为exhausted(耗尽)。
spring.redis.pool.max-active=8
# 等待可用连接的最大时间，单位毫秒，默认值为-1，表示永不超时。如果超过等待时间，则直接抛出JedisConnectionException
spring.redis.pool.max-wait=-1
#################redis哨兵设置#################
# Redis服务器master的名字
#spring.redis.sentinel.master=master1
# redis-sentinel的配置地址和端口
#spring.redis.sentinel.nodes=127.0.0.1:26379,127.0.0.1:26378,127.0.0.1:26377

lettuce专有的配置：

#连接池最大连接数，负数表示不限制
spring.redis.lettuce.pool.max-active=8
#连接池最大空闲连接数，负数表示不限制 
spring.redis.lettuce.pool.max-idle=8 
#等待可用连接的最大时间，负数不限制
spring.redis.lettuce.pool.max-wait=-1ms
#连接池最小空闲连接数 
spring.redis.lettuce.pool.min-idle=0 
spring.redis.lettuce.shutdown-timeout=100ms

jedis专有配置（和lettuce类似）：

spring.redis.jedis.pool.max-active=8 
spring.redis.jedis.pool.max-idle=8 
spring.redis.jedis.pool.max-wait=-1ms 
spring.redis.jedis.pool.min-idle=0

启动类

启动类需要添加@SpringBootApplication或者@EnableAutoConfiguration

@SpringBootApplication 
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

说明

Spring Boot会根据application.properties的配置，自动生成两个bean：RedisTemplate<Object,Object>和StringRedisTemplate。

查看RedisConfiguration源码：

@Configuration
protected static class RedisConfiguration {
    @Bean
    @ConditionalOnMissingBean(name = "redisTemplate")
    public RedisTemplate<Object, Object> redisTemplate(
            RedisConnectionFactory redisConnectionFactory)
                    throws UnknownHostException {
        RedisTemplate<Object, Object> template = new RedisTemplate<Object, Object>();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
    @Bean
    @ConditionalOnMissingBean(StringRedisTemplate.class)
    public StringRedisTemplate stringRedisTemplate(
            RedisConnectionFactory redisConnectionFactory)
                    throws UnknownHostException {
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
}

使用

在Component上注入StringRedisTemplate或RedisTemplate来做redis操作。

@Component
public class MyBean {
    private StringRedisTemplate template;
    @Autowired
    public MyBean(StringRedisTemplate template) {
        this.template = template;
    }
    // ...
}