SpringBoot自定義Redis實現(xiàn)緩存序列化詳解
剛剛完成了Spring Boot整合Redis進行了數(shù)據(jù)的緩存管理,但緩存管理的實體類數(shù)據(jù)使用的是JDK序列化方式,不便于使用可視化管理工具進行查看和管理。

接下來分別針對基于注解的Redis緩存實現(xiàn)和基于API的Redis緩存實現(xiàn)中的數(shù)據(jù)序列化機制進行介紹,并自定義JSON格式的數(shù)據(jù)序列化方式進行數(shù)據(jù)緩存管理
1、自定義RedisTemplate
1.1、Redis API默認序列化機制
基于API的Redis緩存實現(xiàn)是使用RedisTemplate模板進行數(shù)據(jù)緩存操作的,這里打開RedisTemplate類,查看該類的源碼信息
public class RedisTemplate<K, V> extends RedisAccessor implements RedisOperations<K, V>, BeanClassLoaderAware {
// 聲明了key、value的各種序列化方式,初始值為空
@Nullable
private RedisSerializer keySerializer = null;
@Nullable
private RedisSerializer valueSerializer = null;
@Nullable
private RedisSerializer hashKeySerializer = null;
@Nullable
private RedisSerializer hashValueSerializer = null;
...
// 進行默認序列化方式設置,設置為JDK序列化方式
public void afterPropertiesSet() {
super.afterPropertiesSet();
boolean defaultUsed = false;
if (this.defaultSerializer == null) {
this.defaultSerializer = new JdkSerializationRedisSerializer(
this.classLoader != null ?
this.classLoader : this.getClass().getClassLoader());
}
...
}
...
}從上述RedisTemplate核心源碼可以看出,在RedisTemplate內(nèi)部聲明了緩存數(shù)據(jù)key、value的各種序列化方式,且初始值都為空;在afterPropertiesSet()方法中,判斷如果默認序列化參數(shù)defaultSerializer為空,將數(shù)據(jù)的默認序列化方式設置為JdkSerializationRedisSerializer
根據(jù)上述源碼信息的分析,可以得到以下兩個重要的結(jié)論:
(1)使用RedisTemplate進行Redis數(shù)據(jù)緩存操作時,內(nèi)部默認使用的是JdkSerializationRedisSerializer序列化方式,所以進行數(shù)據(jù)緩存的實體類必須實現(xiàn)JDK自帶的序列化接口(例如Serializable);
(2)使用RedisTemplate進行Redis數(shù)據(jù)緩存操作時,如果自定義了緩存序列化方式defaultSerializer,那么將使用自定義的序列化方式。
另外,在RedisTemplate類源碼中,看到的緩存數(shù)據(jù)key、value的各種序列化類型都是RedisSerializer。進入RedisSerializer源碼查看RedisSerializer支持的序列化方式(進入該類后,使用Ctrl+Alt+左鍵單擊類名查看)

可以看出,RedisSerializer是一個Redis序列化接口,默認有6個實現(xiàn)類,這6個實現(xiàn)類代表了6種不同的數(shù)據(jù)序列化方式。其中,JdkSerializationRedisSerializer是JDK自帶的,也是RedisTemplate內(nèi)部默認使用的數(shù)據(jù)序列化方式,開發(fā)者可以根據(jù)需要選擇其他支持的序列化方式(例如JSON方式)
1.2、自定義RedisTemplate序列化機制
在項目中引入Redis依賴后,Spring Boot提供的RedisAutoConfiguration自動配置會生效。打開RedisAutoConfiguration類,查看內(nèi)部源碼中關于RedisTemplate的定義方式
public class RedisAutoConfiguration {
@Bean
@ConditionalOnMissingBean(
name = {"redisTemplate"}
)
public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
RedisTemplate<Object, Object> template = new RedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
...
}從上述RedisAutoConfiguration核心源碼中可以看出,在Redis自動配置類中,通過Redis連接工廠RedisConnectionFactory初始化了一個RedisTemplate;該類上方添加了@ConditionalOnMissingBean注解(顧名思義,當某個Bean不存在時生效),用來表明如果開發(fā)者自定義了一個名為redisTemplate的Bean,則該默認初始化的RedisTemplate不會生效。
如果想要使用自定義序列化方式的RedisTemplate進行數(shù)據(jù)緩存操作,可以參考上述核心代碼創(chuàng)建一個名為redisTemplate的Bean組件,并在該組件中設置對應的序列化方式即可
接下來,在項目中創(chuàng)建名為com.lagou.config的包,在該包下創(chuàng)建一個Redis自定義配置類RedisConfig,并按照上述思路自定義名為redisTemplate的Bean組件
@Configuration
public class RedisConfig {
// 自定義RedisTemplate
@Bean
public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate<Object, Object> template = new RedisTemplate<>();
template.setConnectionFactory(redisConnectionFactory);
// 創(chuàng)建一個JSON格式序列化對象,對緩存數(shù)據(jù)的key和value進行轉(zhuǎn)換
Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
// 解決查詢緩存轉(zhuǎn)換異常的問題
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
// 設置RedisTemplate模板api序列化方式為json
template.setDefaultSerializer(jackson2JsonRedisSerializer);
return template;
}
}通過@Configuration注解定義了一個RedisConfig配置類,并使用@Bean注解注入了一個默認名稱為方法名的redisTemplate組件(注意,該Bean組件名稱必須是redisTemplate)。在定義的Bean組件中,自定義了一個RedisTemplate,使用自定義的Jackson2JsonRedisSerializer數(shù)據(jù)序列化方式;在定制序列化方式中,定義了一個ObjectMapper用于進行數(shù)據(jù)轉(zhuǎn)換設置
1.3、效果測試

可以看出,執(zhí)行findById()方法正確查詢出用戶評論信息Comment,重復進行同樣的查詢操作,數(shù)據(jù)庫只執(zhí)行了一次SQL語句,這說明定制的Redis緩存生效。
使用Redis客戶端可視化管理工具Redis Desktop Manager查看緩存數(shù)據(jù) :

執(zhí)行findById()方法查詢出用戶評論信息Comment正確存儲到了Redis緩存庫中,且緩存到Redis服務的數(shù)據(jù)已經(jīng)使用了JSON格式存儲展示,查看和管理也非常方便,說明自定義的Redis API模板工具RedisTemplate生效
2、自定義RedisCacheManager
剛剛針對基于 API方式的RedisTemplate進行了自定義序列化方式的改進,從而實現(xiàn)了JSON序列化方式緩存數(shù)據(jù),但是這種自定義的RedisTemplate對于基于注解的Redis緩存來說,是沒有作用的。
接下來,針對基于注解的Redis緩存機制和自定義序列化方式進行講解
2.1、Redis注解默認序列化機制
打開Spring Boot整合Redis組件提供的緩存自動配置類RedisCacheConfiguration(org.springframework.boot.autoconfigure.cache包下的),查看該類的源碼信息,其核心代碼如下
@Configuration
class RedisCacheConfiguration {
@Bean
public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFactory, ResourceLoader resourceLoader) {
RedisCacheManagerBuilder builder = RedisCacheManager
.builder(redisConnectionFactory)
.cacheDefaults(this.determineConfiguration(resourceLoader.getClassLoader()));
List<String> cacheNames = this.cacheProperties.getCacheNames();
if (!cacheNames.isEmpty()) {
builder.initialCacheNames(new LinkedHashSet(cacheNames));
}
return (RedisCacheManager) this.customizerInvoker.customize(builder.build());
}
private org.springframework.data.redis.cache.RedisCacheConfiguration
determineConfiguration(ClassLoader classLoader) {
if (this.redisCacheConfiguration != null) {
return this.redisCacheConfiguration;
} else {
Redis redisProperties = this.cacheProperties.getRedis();
org.springframework.data.redis.cache.RedisCacheConfiguration config = org.springframework.data.redis.cache.RedisCacheConfiguration.defaultCacheConfig();
config = config.serializeValuesWith(SerializationPair.fromSerializer(
new JdkSerializationRedisSerializer(classLoader)));
...
return config;
}
}
}從上述核心源碼中可以看出,同RedisTemplate核心源碼類似,RedisCacheConfiguration內(nèi)部同樣通過Redis連接工廠RedisConnectionFactory定義了一個緩存管理器RedisCacheManager;同時定制RedisCacheManager時,也默認使用了JdkSerializationRedisSerializer序列化方式。
如果想要使用自定義序列化方式的RedisCacheManager進行數(shù)據(jù)緩存操作,可以參考上述核心代碼創(chuàng)建一個名為cacheManager的Bean組件,并在該組件中設置對應的序列化方式即可
注意,在Spring Boot 2.X版本中,RedisCacheManager是單獨進行構(gòu)建的。因此,在SpringBoot 2.X版本中,對RedisTemplate進行自定義序列化機制構(gòu)建后,仍然無法對RedisCacheManager內(nèi)部默認序列化機制進行覆蓋(這也就解釋了基 于注解的Redis緩存實現(xiàn)仍然會使用JDK默認序列化機制的原因),想要基于注解的Redis緩存實現(xiàn)也使用自定義序列化機制,需要自定義RedisCacheManager
2.2、自定義RedisCacheManager
在項目的Redis配置類RedisConfig中,按照上一步分析的定制方法自定義名為cacheManager的Bean組件
@Bean
public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
// 分別創(chuàng)建String和JSON格式序列化對象,對緩存數(shù)據(jù)key和value進行轉(zhuǎn)換
RedisSerializer<String> strSerializer = new StringRedisSerializer();
Jackson2JsonRedisSerializer jacksonSerial = new Jackson2JsonRedisSerializer(Object.class);
// 解決查詢緩存轉(zhuǎn)換異常的問題
ObjectMapper om = new ObjectMapper();
om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
// om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY); // 上面注釋過時代碼的替代方法
jacksonSerial.setObjectMapper(om);
// 定制緩存數(shù)據(jù)序列化方式及時效
RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
.entryTtl(Duration.ofDays(1)) // 設置緩存數(shù)據(jù)的時效(設置為了1天)
.serializeKeysWith(RedisSerializationContext.SerializationPair
.fromSerializer(strSerializer)) // 對當前對象的key使用strSerializer這個序列化對象,進行轉(zhuǎn)換
.serializeValuesWith(RedisSerializationContext.SerializationPair
.fromSerializer(jacksonSerial)) // 對value使用jacksonSerial這個序列化對象,進行轉(zhuǎn)換
.disableCachingNullValues();
RedisCacheManager cacheManager = RedisCacheManager
.builder(redisConnectionFactory).cacheDefaults(config).build();
return cacheManager;
}上述代碼中,在RedisConfig配置類中使用@Bean注解注入了一個默認名稱為方法名的cacheManager組件。在定義的Bean組件中,通過RedisCacheConfiguration對緩存數(shù)據(jù)的key和value分別進行了序列化方式的定制,其中緩存數(shù)據(jù)的key定制為StringRedisSerializer(即String格式),而value定制為了Jackson2JsonRedisSerializer(即JSON格式),同時還使用entryTtl(Duration.ofDays(1))方法將緩存數(shù)據(jù)有效期設置為1天
完成基于注解的Redis緩存管理器RedisCacheManager定制后,可以對該緩存管理器的效果進行測試(使用自定義序列化機制的RedisCacheManager測試時,實體類可以不用實現(xiàn)序列化接口)
到此這篇關于SpringBoot自定義Redis實現(xiàn)緩存序列化詳解的文章就介紹到這了,更多相關SpringBoot 緩存序列化內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
解決@Transaction注解導致動態(tài)切換更改數(shù)據(jù)庫失效問題
這篇文章主要介紹了解決@Transaction注解導致動態(tài)切換更改數(shù)據(jù)庫失效問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-09-09
Java中spring boot validation自定義注解使用方式
這篇文章主要介紹了Java中spring boot validation自定義注解使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08
SpringBoot實現(xiàn)設置動態(tài)定時任務的方法詳解
這篇文章主要介紹了SpringBoot實現(xiàn)設置動態(tài)定時任務的方法詳解,SpringBoot是一個快速開發(fā)的Java框架,而動態(tài)定時任務是指可以在運行時動態(tài)添加、修改和刪除定時任務的功能,需要的朋友可以參考下2023-10-10
Spring Cloud Gateway 攔截響應問題分析(數(shù)據(jù)截斷問題)
這篇文章主要介紹了Spring Cloud Gateway 攔截響應問題分析(數(shù)據(jù)截斷問題),本文通過實例代碼給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2023-01-01

