SpringBoot怎么自定義Redis實現緩存序列化

本篇內容主要講解“SpringBoot怎么自定義Redis實現緩存序列化”，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“SpringBoot怎么自定義Redis實現緩存序列化”吧!

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實現緩存序列化”有了更深的了解，不妨來實際操作一番吧！這里是億速云網站，更多相關內容可以進入相關頻道進行查詢，關注我們，繼續學習！