SpringBoot自定義Redis實現快取序列化詳解

2022-07-16 14:01:31

1、自定義RedisTemplate

1.1、Redis API預設序列化機制

基於API的Redis快取實現是使用RedisTemplate模板進行資料快取操作的，這裡開啟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內部宣告了快取資料key、value的各種序列化方式，且初始值都為空；在afterPropertiesSet()方法中，判斷如果預設序列化引數defaultSerializer為空，將資料的預設序列化方式設定為JdkSerializationRedisSerializer

根據上述原始碼資訊的分析，可以得到以下兩個重要的結論：

（1）使用RedisTemplate進行Redis資料快取操作時，內部預設使用的是JdkSerializationRedisSerializer序列化方式，所以進行資料快取的實體類必須實現JDK自帶的序列化介面（例如Serializable）；

（2）使用RedisTemplate進行Redis資料快取操作時，如果自定義了快取序列化方式defaultSerializer，那麼將使用自定義的序列化方式。

另外，在RedisTemplate類原始碼中，看到的快取資料key、value的各種序列化型別都是RedisSerializer。進入RedisSerializer原始碼檢視RedisSerializer支援的序列化方式（進入該類後，使用Ctrl+Alt+左鍵單擊類名檢視）

可以看出，RedisSerializer是一個Redis序列化介面，預設有6個實現類，這6個實現類代表了6種不同的資料序列化方式。其中，JdkSerializationRedisSerializer是JDK自帶的，也是RedisTemplate內部預設使用的資料序列化方式，開發者可以根據需要選擇其他支援的序列化方式（例如JSON方式）

1.2、自定義RedisTemplate序列化機制

在專案中引入Redis依賴後，Spring Boot提供的RedisAutoConfiguration自動設定會生效。開啟RedisAutoConfiguration類，檢視內部原始碼中關於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不存在時生效），用來表明如果開發者自定義了一個名為redisTemplate的Bean，則該預設初始化的RedisTemplate不會生效。

如果想要使用自定義序列化方式的RedisTemplate進行資料快取操作，可以參考上述核心程式碼建立一個名為redisTemplate的Bean元件，並在該元件中設定對應的序列化方式即可

接下來，在專案中建立名為com.lagou.config的包，在該包下建立一個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);
        // 建立一個JSON格式序列化物件，對快取資料的key和value進行轉換
        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模板api序列化方式為json
        template.setDefaultSerializer(jackson2JsonRedisSerializer);
        return template;
    }
}

通過@Configuration註解定義了一個RedisConfig設定類，並使用@Bean註解注入了一個預設名稱為方法名的redisTemplate元件（注意，該Bean元件名稱必須是redisTemplate）。在定義的Bean元件中，自定義了一個RedisTemplate，使用自定義的Jackson2JsonRedisSerializer資料序列化方式；在客製化序列化方式中，定義了一個ObjectMapper用於進行資料轉換設定

1.3、效果測試

可以看出，執行findById()方法正確查詢出使用者評論資訊Comment，重複進行同樣的查詢操作，資料庫只執行了一次SQL語句，這說明客製化的Redis快取生效。

使用Redis使用者端視覺化管理工具Redis Desktop Manager檢視快取資料：

執行findById()方法查詢出使用者評論資訊Comment正確儲存到了Redis快取庫中，且快取到Redis服務的資料已經使用了JSON格式儲存展示，檢視和管理也非常方便，說明自定義的Redis API模板工具RedisTemplate生效

2、自定義RedisCacheManager

剛剛針對基於 API方式的RedisTemplate進行了自定義序列化方式的改進，從而實現了JSON序列化方式快取資料，但是這種自定義的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內部同樣通過Redis連線工廠RedisConnectionFactory定義了一個快取管理器RedisCacheManager；同時客製化RedisCacheManager時，也預設使用了JdkSerializationRedisSerializer序列化方式。

如果想要使用自定義序列化方式的RedisCacheManager進行資料快取操作，可以參考上述核心程式碼建立一個名為cacheManager的Bean元件，並在該元件中設定對應的序列化方式即可

注意，在Spring Boot 2.X版本中，RedisCacheManager是單獨進行構建的。因此，在SpringBoot 2.X版本中，對RedisTemplate進行自定義序列化機制構建後，仍然無法對RedisCacheManager內部預設序列化機制進行覆蓋（這也就解釋了基於註解的Redis快取實現仍然會使用JDK預設序列化機制的原因），想要基於註解的Redis快取實現也使用自定義序列化機制，需要自定義RedisCacheManager

2.2、自定義RedisCacheManager

在專案的Redis設定類RedisConfig中，按照上一步分析的客製化方法自定義名為cacheManager的Bean元件

    @Bean
    public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        // 分別建立String和JSON格式序列化物件，對快取資料key和value進行轉換
        RedisSerializer<String> strSerializer = new StringRedisSerializer();
        Jackson2JsonRedisSerializer jacksonSerial = new Jackson2JsonRedisSerializer(Object.class);
        // 解決查詢快取轉換異常的問題
        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);
        // 客製化快取資料序列化方式及時效
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofDays(1)) // 設定快取資料的時效（設定為了1天）
                .serializeKeysWith(RedisSerializationContext.SerializationPair
                        .fromSerializer(strSerializer)) // 對當前物件的key使用strSerializer這個序列化物件，進行轉換
                .serializeValuesWith(RedisSerializationContext.SerializationPair
                        .fromSerializer(jacksonSerial)) // 對value使用jacksonSerial這個序列化物件，進行轉換
                .disableCachingNullValues();
        RedisCacheManager cacheManager = RedisCacheManager
                .builder(redisConnectionFactory).cacheDefaults(config).build();
        return cacheManager;
    }

上述程式碼中，在RedisConfig設定類中使用@Bean註解注入了一個預設名稱為方法名的cacheManager元件。在定義的Bean元件中，通過RedisCacheConfiguration對快取資料的key和value分別進行了序列化方式的客製化，其中快取資料的key客製化為StringRedisSerializer（即String格式），而value客製化為了Jackson2JsonRedisSerializer（即JSON格式），同時還使用entryTtl(Duration.ofDays(1))方法將快取資料有效期設定為1天

完成基於註解的Redis快取管理器RedisCacheManager客製化後，可以對該快取管理器的效果進行測試（使用自定義序列化機制的RedisCacheManager測試時，實體類可以不用實現序列化介面）

到此這篇關於SpringBoot自定義Redis實現快取序列化詳解的文章就介紹到這了,更多相關SpringBoot 快取序列化內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！