spring-boot-starter-redis配置详解

Posted 2020-12-03 bigben0123

spring-boot-starter-redis配置详解

 

spring-boot-starter-redis主要是通过配置RedisConnectionFactory中的相关参数去实现连接redis service。RedisConnectionFactory是一个接口，有如下4个具体的实现类，我们通常使用的是JedisConnectionFactory。

 

在spring boot的配置文件中redis的基本配置如下：

# Redis服务器地址
spring.redis.host=192.168.0.58
# Redis服务器连接端口
spring.redis.port=6379  
# Redis服务器连接密码（默认为空，如果redis服务端配置文件开启了requirepass 密码，此处就应该填写相应的配置密码）
spring.redis.password=  
# 连接超时时间（毫秒）
spring.redis.timeout=0

 

上边这4项是在JedisConnectionFactory类中的基本配置项，里边其实还包含了一些比如连接池，集群，主从，哨兵等的配置，这里先简单介绍下连接池（JedisPoolConfig），需要了解其它配置了可以看下源码。GenericObjectPoolConfig是JedisPoolConfig的父类，主要提供了maxTotal、maxIdle、maxIdle共三个参数的配置，其中还设置了默认的参数。

# 连接池最大连接数（使用负值表示没有限制，对应maxTotal）

spring.redis.pool.max-active=8

# 连接池中的最大空闲连接

spring.redis.pool.max-idle=8

# 连接池中的最小空闲连接

spring.redis.pool.min-idle=0

 

配置文件配置好后，还需要建立一个redis的配置类，主要用来配置key和value的序列化及加载配置文件中的相关参数

如果你只需要使用基本的redis配置，那么使用如下配置类即可，spring boot会自动扫描redis的基本配置，但是有一项要注意那就是password，如果你在配置文件中设置了password，那么就必须在配置类中手工注入JedisConnectionFactory中，否则会在启动过程中报NOAUTH Authentication required.;：

 

1.  
   @Configuration
2.  
   @EnableCaching
3.  
   public class RedisConfig extends CachingConfigurerSupport{
4.  
    
5.  
   @Bean
6.  
   public KeyGenerator keyGenerator() {
7.  
   return new KeyGenerator() {
8.  
    
9.  
   public Object generate(Object target, Method method, Object... params) {
10.  
    StringBuilder sb = new StringBuilder();
11.  
                    sb.append(target.getClass().getName());
12.  
                    sb.append("_").append(method.getName());
13.  
                    for (Object obj : params) {
14.  
                        sb.append("_").append(obj.toString());
15.  
                    }
16.  
                    return sb.toString();
17.  
    }
18.  
    };
19.  
    }
20.  
     
21.  
    @SuppressWarnings("rawtypes")
22.  
    @Bean
23.  
    public CacheManager cacheManager(RedisTemplate redisTemplate) {
24.  
    RedisCacheManager rcm = new RedisCacheManager(redisTemplate);
25.  
    //设置缓存过期时间
26.  
    //rcm.setDefaultExpiration(60);//秒
27.  
    return rcm;
28.  
    }
29.  
     
30.  
     
31.  
    @Bean
32.  
    public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) {
33.  
    StringRedisTemplate template = new StringRedisTemplate(factory);
34.  
    @SuppressWarnings({ "rawtypes", "unchecked" })
35.  
    Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
36.  
    ObjectMapper om = new ObjectMapper();
37.  
    om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
38.  
    om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
39.  
    jackson2JsonRedisSerializer.setObjectMapper(om);
40.  
    template.setValueSerializer(jackson2JsonRedisSerializer);
41.  
    template.afterPropertiesSet();
42.  
    JedisConnectionFactory jc = (JedisConnectionFactory) factory;
43.  
    System.out.println(jc.getHostName());
44.  
    return template;
45.  
    }
46.  
     
47.  
    }

如果你还配置了如连接池之类的参数，在上边配置类中加入：

 

 

1.  
   @Bean
2.  
   public JedisConnectionFactory redisConnectionFactory() {
3.  
   JedisConnectionFactory factory = new JedisConnectionFactory();
4.  
   factory.setHostName(host);
5.  
   factory.setPort(port);
6.  
   factory.setPassword(password);
7.  
   factory.setTimeout(timeout); //设置连接超时时间
8.  
   return factory;
9.  
   }

使用factory进行set你所配置的值即可。

附带解释一点就是在配置类中注入配置文件中的属性方案有多种，如需了解可参考博客：

 

点击打开链接

StringRedisTemplate与RedisTemplate使用时的注意事项：

1、StringRedisTemplate是RedisTemplate的唯一子类

2、StringRedisTemplate默认采用的key序列化方式为setKeySerializer(stringSerializer);此时在使用Spring的缓存注解如@Cacheable的key属性设置值时，就需

1.  
   要注意如果参数类型为Long那么会出不能进行String类型转换异常。
2.  
   3、RedisTemplate默认使用的序列化方式为JdkSerializationRedisSerializer，它就没有上边的问题。因为它的序列化方法为serialize(Object object)