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)