Spring Data Redis對象緩存序列化問題

相信在項(xiàng)目中,你一定是經(jīng)常使用 Redis ,那么,你是怎么使用的呢?在使用時,有沒有遇到同我一樣,對象緩存序列化問題的呢?那么,你又是如何解決的呢?

Redis 使用示例

添加依賴:

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

在應(yīng)用啟動如何添加啟用緩存注解(@EnableCaching)。

假如我們有一個用戶對象(UserVo):

@Data
public class UserVo implements Serializable {

    @Serial
    private static final long serialVersionUID = 2215423070276994378L;

    private Long id;

    private String name;

    private LocalDateTime createDateTime;

}

這里,我們實(shí)現(xiàn)了 Serializable 接口。

在我們需要緩存的方法上,使用 @Cacheable 注解,就表示如果返回的對象不是 null 時,就會對其進(jìn)行緩存,下次查詢,首先會去緩存中查詢,查到了,就直接返回,不會再去數(shù)據(jù)庫查詢,查不到,再去數(shù)據(jù)庫查詢。

@Service
@Slf4j
public class UserServiceImpl implements IUserService {

    @Override
    @Cacheable(
            value = "sample-redis",
            key = "'user-'+#id",
            unless = "#result == null"
    )
    public UserVo getUserById(Long id) {

        log.info("userVo from db query");

        UserVo userVo = new UserVo();
        userVo.setId(1L);
        userVo.setName("Zhang San");
        userVo.setCreateDateTime(LocalDateTime.now());

        return userVo;
    }

}

核心代碼:

@Cacheable(
        value = "sample-redis",
        key = "'user-'+#id",
        unless = "#result == null"
)

模擬測試,再寫一個測試接口:

@RestController
@RequestMapping("/sample")
@RequiredArgsConstructor
@Slf4j
public class SampleController {

    private final IUserService userService;

    @GetMapping("/user/{id}")
    public UserVo getUserById(@PathVariable Long id) {

        UserVo vo = userService.getUserById(id);

        log.info("vo: {}", JacksonUtils.json(vo));

        return vo;
    }

}

我們再加上連接 redis 的配置:

spring:
  data:
    redis:
      host: localhost
      port: 6379

測試:

### getUserById
GET http://localhost:8080/sample/user/1


image-20231229232659949.png

輸出結(jié)果跟我們想的一樣,第一次從數(shù)據(jù)庫查,后面都從緩存直接返回。

總結(jié)一下:

  1. 添加 spring-boot-starter-data-redis 依賴。

  2. 使用啟用緩存注解(@EnableCaching)。

  3. 需要緩存的對象實(shí)現(xiàn) Serializable 接口。

  4. 使用 @Cacheable 注解緩存查詢的結(jié)果。

遇到問題

在上面我們通過 spring boot 提供的 redis 實(shí)現(xiàn)了查詢對象緩存這樣一個功能,有下面幾個問題:

  1. 緩存的對象,必須序列化,不然會報(bào)錯。
  2. redis 存儲的數(shù)據(jù),看不懂,可以轉(zhuǎn)成 json 格式嗎?
  3. 使用 Jackson 時,遇到特殊類型的字段會報(bào)錯,比如 LocalDateTime。

第1個問題,如果對象沒有實(shí)現(xiàn) Serializable接口,會報(bào)錯:

image-20231230230844373.png

關(guān)鍵信息:

java.lang.IllegalArgumentException: DefaultSerializer requires a Serializable payload but received an object of type [xxx.xxx.UserVo]

我詳細(xì)描述一下第3個問題,默認(rèn)是使用 Jdk序列化 JdkSerializationRedisSerializer,redis 里面存的數(shù)據(jù)如下:

image-20231229232824285.png

問題很明顯,對象必須要實(shí)現(xiàn)序列化接口,存的數(shù)據(jù)不易查看,所以,改用 GenericJackson2JsonRedisSerializer ,這就有了第3個問題。

我們加上下面的配置,就能解決第2個問題。

@Bean
public RedisCacheConfiguration redisCacheConfiguration() {
    return RedisCacheConfiguration
            .defaultCacheConfig()
            .serializeValuesWith(
                    RedisSerializationContext
                            .SerializationPair
                            .fromSerializer(RedisSerializer.json())
            );
}

下面看第三個問題的錯誤:

image-20231229233716885.png

如何解決?

既然有了明確的錯誤提示,那也是好解決的,我們可以這樣:

@JsonDeserialize(using = LocalDateTimeDeserializer.class)       // 反序列化
@JsonSerialize(using = LocalDateTimeSerializer.class)           // 序列化
private LocalDateTime createDateTime;

這樣就可以了,我們看下redis里面存的數(shù)據(jù):

{"@class":"com.fengwenyi.erwin.component.sample.redis.vo.UserVo","id":1,"name":"Zhang San","createDateTime":[2023,12,29,23,44,3,479011000]}

其實(shí)到這里,已經(jīng)解決了問題,那有沒有更省心的辦法呢?

解決辦法

其實(shí)我們知道,使用的就是 Jackson 進(jìn)行 json 轉(zhuǎn)換,而 json 轉(zhuǎn)換,遇到 LocalDateTime 問題時,我們配置一下 module 就可以了,因?yàn)槟J(rèn)用的 SimpleModule,我們改用 JavaTimeModule 就可以了。

這時候問題又來啦,錯誤如下:

image-20231229233248619.png

這時候存的數(shù)據(jù)如下:

{"id":1,"name":"Zhang San","createDateTime":"2023-12-29T23:31:52.548517"}

這就涉及到 Jackson 序列化漏洞的問題了,采用了白名單機(jī)制,我們就粗暴一點(diǎn):

jsonMapper.activateDefaultTyping(
  LaissezFaireSubTypeValidator.instance, 
  ObjectMapper.DefaultTyping.NON_FINAL
);

redis 存的數(shù)據(jù)如下:

["com.fengwenyi.erwin.component.sample.redis.vo.UserVo",{"id":1,"name":"Zhang San","createDateTime":"2023-12-29T23:56:18.197203"}]

最后,來一段完整的 RedisCacheConfiguration 配置代碼:

@Bean
public RedisCacheConfiguration redisCacheConfiguration() {
    return RedisCacheConfiguration
            .defaultCacheConfig()
            .serializeValuesWith(
                    RedisSerializationContext
                            .SerializationPair
//                            .fromSerializer(RedisSerializer.json())
//                            .fromSerializer(
//                                    new GenericJackson2JsonRedisSerializer()
//                            )
                            .fromSerializer(redisSerializer())
            );
}

private RedisSerializer<Object> redisSerializer() {
    JsonMapper jsonMapper = new JsonMapper();
    JacksonUtils.configure(jsonMapper);
    jsonMapper.activateDefaultTyping(
            LaissezFaireSubTypeValidator.instance, 
            ObjectMapper.DefaultTyping.NON_FINAL
    );
    return new GenericJackson2JsonRedisSerializer(jsonMapper);
}

希望今天的分享對你有一定的幫助。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容