SpringBoot2.0整合Redis

【1】pom依赖

添加redis依赖如下：

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-data-redisartifactId>
    
    <exclusions>
        <exclusion>
            <groupId>redis.clientsgroupId>
            <artifactId>jedisartifactId>
        exclusion>
        <exclusion>
            <groupId>io.lettucegroupId>
            <artifactId>lettuce-coreartifactId>
        exclusion>
    exclusions>
dependency>

<dependency>
    <groupId>redis.clientsgroupId>
    <artifactId>jedisartifactId>
dependency>


<dependency>
    <groupId>org.apache.commonsgroupId>
    <artifactId>commons-pool2artifactId>
    <version>2.5.0version>
    
dependency>

---

【2】yml配置

yml中对redis配置如下：

spring:
    redis:
      host: 127.0.0.1
      port: 6379
      password: admin
      jedis:
        pool:
          #最大连接数
          max-active: 1024
          #最大阻塞等待时间(负数表示没限制)
          max-wait: 20000
          #最大空闲
          max-idle: 200
          #最小空闲
          min-idle: 10
      #连接超时时间
      timeout: 10000

注意，与SpringBoot1.X整合Redis配置不同。

---

【3】Redis配置类

MyRedisConfig如下：

@Configuration// 必须加，使配置生效
@EnableCaching
public class MyRedisConfig extends CachingConfigurerSupport {
    /**
     * Logger
     */
    private static final Logger log = LoggerFactory.getLogger(MyRedisConfig.class);


    @Autowired
    private JedisConnectionFactory jedisConnectionFactory;


    @Bean
    @Override
    public CacheManager cacheManager() {
        // 初始化缓存管理器，在这里我们可以缓存的整体过期时间什么的，我这里默认没有配置
        log.info("初始化 -> [{}]", "CacheManager RedisCacheManager Start");
        RedisCacheManager.RedisCacheManagerBuilder builder = RedisCacheManager
                .RedisCacheManagerBuilder
                .fromConnectionFactory(jedisConnectionFactory);
        return builder.build();
    }

    @Bean
    public RedisTemplate redisTemplate(JedisConnectionFactory jedisConnectionFactory ) {
        //设置序列化
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        // 配置redisTemplate
        RedisTemplate redisTemplate = new RedisTemplate();
        redisTemplate.setConnectionFactory(jedisConnectionFactory);
        RedisSerializer stringSerializer = new StringRedisSerializer();
        redisTemplate.setKeySerializer(stringSerializer); // key序列化
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer); // value序列化
        redisTemplate.setHashKeySerializer(stringSerializer); // Hash key序列化
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer); // Hash value序列化
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    @Override
    @Bean
    public CacheErrorHandler errorHandler() {
        // 异常处理，当Redis发生异常时，打印日志，但是程序正常走
        log.info("初始化 -> [{}]", "Redis CacheErrorHandler");
        CacheErrorHandler cacheErrorHandler = new CacheErrorHandler() {
            @Override
            public void handleCacheGetError(RuntimeException e, Cache cache, Object key) {
                log.error("Redis occur handleCacheGetError：key -> [{}]", key, e);
            }

            @Override
            public void handleCachePutError(RuntimeException e, Cache cache, Object key, Object value) {
                log.error("Redis occur handleCachePutError：key -> [{}]；value -> [{}]", key, value, e);
            }

            @Override
            public void handleCacheEvictError(RuntimeException e, Cache cache, Object key)    {
                log.error("Redis occur handleCacheEvictError：key -> [{}]", key, e);
            }

            @Override
            public void handleCacheClearError(RuntimeException e, Cache cache) {
                log.error("Redis occur handleCacheClearError：", e);
            }
        };
        return cacheErrorHandler;
    }

}

其实这里主要是注入了自定义的redisTemplate，替换了默认的jdk 序列化机制，使存入redis中的value json化，体验更友好。

---

【4】测试实例

测试value为String和Object的存取。

    @Autowired
    StringRedisTemplate stringRedisTemplate;

    @Autowired
    RedisTemplate redisTemplate;

    @Test
    public void testRedis(){
        // 测试redis
        if(stringRedisTemplate.hasKey("hello")){
            String hello = stringRedisTemplate.opsForValue().get("hello");
            System.out.println("从redis中获取 key-hello--value : "+hello);
            stringRedisTemplate.opsForValue().set("jane","is a boy");

        }
        SysApk sysApk = sysApkMapper.selectByPrimaryKey(1L);
        redisTemplate.opsForValue().set("sysApk",sysApk);
        SysApk sysApk2 = (SysApk) redisTemplate.opsForValue().get("sysApk");
        System.out.println(sysApk2);
    }

---

【Tips】

需要注意的是Redis中value是不允许为null或者尽量不要为null的。

使用Jedis客户端直接set键值的时候，如果value为null，会抛异常：

在SpringBoot下使用StringRedisTemplate或者RedisTemplate进行键值set时，如果value为null，会将其序列化为,存入redis不会抛出异常。

redisTemplate.opsForValue().set("sysApk",null);

System.out.println(redisTemplate.opsForValue().get("sysApk"));
//打印结果 ：null

// 客户端直接获取
127.0.0.1:6379> get sysApk
""

不过还是建议redis中value值一般不要为null。

---

参考博客：

Spring缓存默认配置与运行流程；
缓存入门与注解使用示例；
SpringBoot1.5使用Redis详解；
Redis安装与详解系列。