SpringBoot 整合 redis 踩坑日记

SpringBoot 中除了了对常用的关系型数据库提供了优秀的自动化测试以外，对于很多 NoSQL 数据库一样提供了自动化配置的支持，包括：Redis, MongoDB, Elasticsearch, Solr 和 Cassandra。

01 整合redis

Redis是一个速度非常快的非关系型数据库（non-relational database），它可以存储键（key）与5种不同类型的值（value）之间的映射（mapping），可以将存储在内存的键值对数据持久化到硬盘。可以使用复制特性来扩展读性能，还可以使用客户端分片来扩展写性能。

redis官网

redis中文社区


1.1 引入依赖

Spring Boot 提供了对 Redis 集成的组件包：spring-boot-starter-data-redis，spring-boot-starter-data-redis 依赖于spring-data-redis 和 lettuce 。

org.springframework.boot

spring-boot-starter-data-redis

1.2 参数配置

在 application.properties 中加入Redis服务端的相关配置 ：

#redis配置

#Redis服务器地址

spring.redis.host=127.0.0.1

#Redis服务器连接端口

spring.redis.port=6379

#Redis数据库索引（默认为0）

spring.redis.database=0

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

spring.redis.jedis.pool.max-active=50

#连接池最大阻塞等待时间（使用负值表示没有限制）

spring.redis.jedis.pool.max-wait=3000ms

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

spring.redis.jedis.pool.max-idle=20

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

spring.redis.jedis.pool.min-idle=2

#连接超时时间（毫秒）

spring.redis.timeout=5000ms

其中 spring.redis.database 的配置通常使用0即可，Redis 在配置的时候可以设置数据库数量，默认为16，可以理解为数据库的 schema

1.3 测试访问

通过编写测试用例，举例说明如何访问Redis。

@RunWith(SpringRunner.class)

@SpringBootTest

publicclassFirstSampleApplicationTests{

@Autowired

    StringRedisTemplate stringRedisTemplate;

@Test

publicvoidtest()throwsException{

// 保存字符串

stringRedisTemplate.opsForValue().set("name","chen");

Assert.assertEquals("chen", stringRedisTemplate.opsForValue().get("name"));

    }

}

上面的案例通过自动配置的StringRedisTemplate对象进行 redis 的对写操作，从对象命名就可注意到支持的是 string 类型，如果有用过 spring-data-redis 的开发者一定熟悉RedisTemplate<K,V>接口，StringRedisTemplate 就相当于RedisTemplate<String, String>的实现。

除了 String 类型，实战中经常会在 redis 中储存对象，我们就要在储存对象时对对象进行序列化。下面通过一个实例来完成对象的对写操作。

创建 User 实体

@Data

publicclassUserimplementsSerializable{

privateString userName;

privateInteger age;

}

配置针对对象的RedisTemplate实例

@Configuration

@EnableCaching

publicclassRedisConfigurationextendsCachingConfigurerSupport{

/**

    * 采用RedisCacheManager作为缓存管理器

*@paramconnectionFactory

    */

@Bean

publicCacheManagercacheManager(RedisConnectionFactory connectionFactory){

        RedisCacheManager redisCacheManager = RedisCacheManager.create(connectionFactory);

returnredisCacheManager;

    }

@Bean

publicRedisTemplateredisTemplate(RedisConnectionFactory factory){

//解决键、值序列化问题

StringRedisTemplate template =newStringRedisTemplate(factory);

Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =newJackson2JsonRedisSerializer(Object.class);

ObjectMapper om =newObjectMapper();

        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);

        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);

        jackson2JsonRedisSerializer.setObjectMapper(om);

        template.setValueSerializer(jackson2JsonRedisSerializer);

        template.afterPropertiesSet();

returntemplate;


}

完成了配置工作后，编写测试用例实验效果

@RunWith(SpringRunner.class)

@SpringBootTest

@Slf4j

publicclassFirstSampleApplicationTests{

@Autowired

    RedisTemplate redisTemplate;

@Test

publicvoidtest()throwsException{

//保存对象

User user =newUser();

user.setUserName("chen");

user.setAge(22);

        redisTemplate.opsForValue().set(user.getUserName(), user);

Home("result:{}",redisTemplate.opsForValue().get("chen"));

    }

}

这样我们就能对对象进行缓存了。但是在对 redis 更深入的了解中，一不小心就踩进坑里去了，下面对 redis 踩的坑做下记录。

02 踩坑记录

2.1 踩坑1：cacheable注解引发的乱码问题

@RestController

@RequestMapping("/chen/user")

@Slf4j

publicclassUserController{

@Autowired

    IUserService userService;

@GetMapping("/hello")

@Cacheable(value ="redis_key",key ="#name",unless ="#result == null")

publicUser hello(@RequestParam("name")String name){

        User user = new User();

        user.setName(name);

user.setAge(22);

user.setEmail("chen_ti@outlook.com");

returnuser;

    }

}

在使用 SpringBoot1.x 的时候，通过简单的配置 RedisTemplete 就可以了，升级到 SpringBoot2.0，spring-boot-starter-data-redis 也跟着升起来了，@Cacheable 就出现了乱码的情况，可以通过将上面的配置文件 RedisConfiguration 做如下更改解决 ：

@Configuration

@EnableCaching

publicclassRedisConfigurationextendsCachingConfigurerSupport{

@Bean(name="redisTemplate")

publicRedisTemplateredisTemplate(RedisConnectionFactory factory){

RedisTemplate template =newRedisTemplate<>();

RedisSerializer redisSerializer =newStringRedisSerializer();

Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =newJackson2JsonRedisSerializer(Object.class);

ObjectMapper om =newObjectMapper();

        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);

        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);

        jackson2JsonRedisSerializer.setObjectMapper(om);

        template.setConnectionFactory(factory);

//key序列化方式

        template.setKeySerializer(redisSerializer);

//value序列化

        template.setValueSerializer(jackson2JsonRedisSerializer);

//value hashmap序列化

        template.setHashValueSerializer(jackson2JsonRedisSerializer);

returntemplate;

    }

@Bean

publicCacheManagercacheManager(RedisConnectionFactory factory){

RedisSerializer redisSerializer =newStringRedisSerializer();

Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =newJackson2JsonRedisSerializer(Object.class);

// 配置序列化

        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();

        RedisCacheConfiguration redisCacheConfiguration = config.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))            .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer));

        RedisCacheManager cacheManager = RedisCacheManager.builder(factory)

                .cacheDefaults(redisCacheConfiguration)

                .build();

returncacheManager;

    }

}

2.2 踩坑2：redis 获取缓存异常

报错信息:

java.lang.ClassCastException:java.util.LinkedHashMapcannotbecasttocom.tuhu.twosample.chen.entity.User

Redis获取缓存异常：java.lang.ClassCastException: java.util.LinkedHashMap cannot be cast to XXX。

出现这种异常，我们需要自定义ObjectMapper，设置一些参数，而不是直接使用 Jackson2JsonRedisSerializer 类中黙认的 ObjectMapper，看源代码可以知道，Jackson2JsonRedisSerializer 中的 ObjectMapper 是直接使用new ObjectMapper() 创建的，这样 ObjectMapper 会将 redis 中的字符串反序列化为 java.util.LinkedHashMap类型，导致后续 Spring 对其进行转换成报错。其实我们只要它返回 Object 类型就可以了。

使用以下方法，构建一个Jackson2JsonRedisSerializer对象，将其注入 RedisCacheManager 即可。

/**

    * 通过自定义配置构建Redis的Json序列化器

*@returnJackson2JsonRedisSerializer对象

    */

privateJackson2JsonRedisSerializer jackson2JsonRedisSerializer(){

        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer =

newJackson2JsonRedisSerializer<>(Object.class);

ObjectMapper objectMapper =newObjectMapper();

        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);

objectMapper.configure(MapperFeature.USE_ANNOTATIONS,false);

objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES,false);

objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS,false);

// 此项必须配置，否则会报java.lang.ClassCastException: java.util.LinkedHashMap cannot be cast to XXX

objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);

returnjackson2JsonRedisSerializer;

    }

2.3 踩坑3：类转移路径

异常打印:

19:32:47INFO  - Started Applicationin10.932seconds (JVM runningfor12.296)

19:32:50INFO  - get data from redis, key =10d044f9-0e94-420b-9631-b83f5ca2ed30

19:32:50WARN  - /market/renewal/homePage/index

org.springframework.data.redis.serializer.SerializationException: CouldnotreadJSON: Couldnotresolvetypeid'com.pa.market.common.util.UserInfoExt'into a subtypeof[simpletype,classjava.lang.Object]: no suchclassfound

at [Source: [B@641a684c; line:1, column:11]; nested exceptioniscom.fasterxml.jackson.databind.exc.InvalidTypeIdException: Couldnotresolvetypeid'com.pa.market.common.util.UserInfoExt'into a subtypeof[simpletype,classjava.lang.Object]: no suchclassfound at [Source: [B@641a684c; line:1, column:11]

项目中使用了拦截器，对每个 http 请求进行拦截。通过前端传递过来的 token，去 redis 缓存中获取用户信息UserInfoExt，用户信息是在用户登录的时候存入到 redis 缓存中的。根据获取到的用户信息来判断是否存是登录状态。 所以除白名单外的 url，其他请求都需要进行这个操作。通过日志打印，很明显出现在 UserInfoExt 对象存储到 redis 中序列化和反序列化的操作步骤。

解决办法:

@Bean

publicRedisTemplateredisTemplate(){

RedisTemplate redisTemplate =newRedisTemplate();

    redisTemplate.setConnectionFactory(jedisConnectionFactory());

redisTemplate.setKeySerializer(newStringRedisSerializer());

redisTemplate.setValueSerializer(newGenericJackson2JsonRedisSerializer());

returnredisTemplate;

}

查看 redis 的 Bean 定义发现，对 key 的序列化使用的是 StringRedisSerializer 系列化，value 值的序列化是GenericJackson2JsonRedisSerializer的序列化方法。

其中GenericJackson2JsonRedisSerializer序列化方法会在 redis 中记录类的 @class 信息，如下所示：

{

"@class":"com.pa.market.common.util.UserInfoExt",

"url":"百度一下，你就知道",

"name":"baidu"

}

"@class": "com.pa.market.common.util.UserInfoExt"，每个对象都会有这个 id 存在（可以通过源码看出为嘛有这个 @class），如果用户一直处在登录状态，是以 com.pa.market.common.util.UserInfoExt 这个路径进行的序列化操作。但是移动了 UserInfoExt 的类路径后，包全名变了。所以会抛出 no such class found 的异常。这样在判断用户是否存在的地方就抛出了异常，故而所有的请求都失败了，已经登录的用户没法进行任何操作。

ok 把踩的坑都记录下来，终于呼出了最后一口气，以后遇到这种坑都能从容的避开了，但是 redis 中的坑还有很多，可能以后还是会轻轻松松的跳进去

©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 194,242评论 5赞 459
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 81,769评论 2赞 371
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 141,484评论 0赞 319
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,133评论 1赞 263
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,007评论 4赞 355
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,080评论 1赞 272
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,496评论 3赞 381
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,190评论 0赞 253
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,464评论 1赞 290
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2赞 309
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,205评论 3赞 312
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,567评论 3赞 298
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0赞 17
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1赞 250
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2赞 341
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2赞 335