從零搭建Spring Boot腳手架中如何整合Redis作為緩存

這篇文章將為大家詳細講解有關從零搭建Spring Boot腳手架中如何整合Redis作為緩存，文章內容質量較高，因此小編分享給大家做個參考，希望大家閱讀完這篇文章后對相關知識有一定的了解。

1. 前言

緩存是一個系統應用必備的一種功能，除了在減輕數據庫的壓力之外。還在存儲一些短時效的數據場景中發揮著重大作用，比如存儲用戶Token、短信驗證碼等等，目前緩存的選型還是比較多的，EHCACHE、HAZELCAST、CAFFEINE、COUCHBASE以及本文要整合的REDIS。接下來我們將會在kono腳手架項目中集成Spring Cache以及Redis。

2. 整合目標

使項目具有緩存功能，同時將默認的JDK序列化修改為Jackson序列化以存儲一些對象，同時實現一些特定的個性化的緩存空間以滿足不同場景下的不同緩存TTL時間需求。

3. 依賴集成

目前只需要引入下面的依賴即可：

 <dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-data-redis</artifactid>
</dependency>
<dependency>
    <groupid>org.springframework.boot</groupid>
    <artifactid>spring-boot-starter-cache</artifactid>
</dependency>
<dependency>
    <groupid>org.apache.commons</groupid>
    <artifactid>commons-pool2</artifactid>
</dependency>

默認情況下spring-data-redis使用高性能的lettuce客戶端實現，當然你可以替換為老舊的jedis。

4. 緩存及Redis配置

緩存以及Redis相關的配置項分別為spring.cache和spring.redis開頭的配置，這里比較簡單的配置為：

spring:
  redis:
    host: localhost
    port: 6379
  cache:
#   type: REDIS
    redis:
    # 全局過期時間
      time-to-live: 120

5. RedisTemplate個性化

默認情況下會有兩個模板類被注入Spring IoC供我們使用，需要個性化配置來滿足實際的開發。

一個是RedisTemplate<object, object>，主要用于對象緩存，其默認使用JDK序列化，我們需要更改其序列化方式解決一些問題，比如Java 8日期問題、JSON序列化問題。需要我們重寫一下。

/**
 * Redis的一些自定義配置.
 *
 * @author felord.cn
 * @since 2020 /8/17 20:39
 */
@ConditionalOnClass(ObjectMapper.class)
@Configuration(proxyBeanMethods = false)
public class RedisConfiguration {
    /**
     * Redis template redis template.
     *
     * @param redisConnectionFactory the redis connection factory
     * @return the redis template
     */
    @Bean("redisTemplate")
    public RedisTemplate<object, object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<object, object> template = new RedisTemplate&lt;&gt;();
        template.setConnectionFactory(redisConnectionFactory);
        // 使用Jackson2JsonRedisSerialize 替換默認序列化
        Jackson2JsonRedisSerializer<object> jackson2JsonRedisSerializer = initJacksonSerializer();
        // 設置value的序列化規則和 key的序列化規則
        template.setValueSerializer(jackson2JsonRedisSerializer);
        template.setKeySerializer(new StringRedisSerializer());
        template.afterPropertiesSet();
        return template;
    }

    /**
     * 處理redis序列化問題
     * @return Jackson2JsonRedisSerializer
     */
    private Jackson2JsonRedisSerializer<object> initJacksonSerializer() {
        Jackson2JsonRedisSerializer<object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer&lt;&gt;(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        //以下替代舊版本 om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        om.activateDefaultTyping(om.getPolymorphicTypeValidator(), ObjectMapper.DefaultTyping.NON_FINAL);
        //bugFix Jackson2反序列化數據處理LocalDateTime類型時出錯
        om.disable(SerializationFeature.WRITE_DATE_KEYS_AS_TIMESTAMPS);
        // java8 時間支持
        om.registerModule(new JavaTimeModule());
        jackson2JsonRedisSerializer.setObjectMapper(om);
        return jackson2JsonRedisSerializer;
    }

}

另一個是StringRedisTemplate,主要處理鍵值都是字符串的緩存，采用默認就好。

6. 緩存個性化

使用Spring Cache做緩存的時候，有針對不同的key設置不同過期時間的場景。比如Jwt Token我想設置為一周過期，而驗證碼我想設置為五分鐘過期。這個怎么實現呢？需要我們個性化配置RedisCacheManager。首先我通過枚舉來定義這些緩存及其TTL時間。例如：

/**
 * 緩存定義枚舉
 *
 * @author felord.cn
 * @see cn.felord.kono.configuration.CacheConfiguration
 * @since 2020/8/17 21:40
 */

public enum CacheEnum {

    /**
     * 用戶jwt token 緩存空間 ttl 7天
     */
    JWT_TOKEN_CACHE("usrTkn", 7 * 24 * 60 * 60),
    /**
     * 驗證碼緩存 5分鐘ttl
     */
    SMS_CAPTCHA_CACHE("smsCode", 5 * 60);

    /**
     * 緩存名稱
     */
    private final String cacheName;
    /**
     * 緩存過期秒數
     */
    private final int ttlSecond;

    CacheEnum(String cacheName, int ttlSecond) {
        this.cacheName = cacheName;
        this.ttlSecond = ttlSecond;
    }
    
    public String cacheName() {
        return this.cacheName;
    }


    public int ttlSecond() {
        return this.ttlSecond;
    }
}

這樣就能很清楚地描述個性化的緩存了。

然后我們通過向Spring IoC分別注入RedisCacheConfiguration和RedisCacheManagerBuilderCustomizer 來個性化配置，你可以留意CacheEnum是如何工作的。如果你有其它的個性化需要也可以對這兩個配置類進行定制化。

import cn.felord.kono.enumeration.CacheEnum;
import org.springframework.boot.autoconfigure.cache.CacheProperties;
import org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.RedisSerializationContext;

import java.time.Duration;
import java.util.EnumSet;
import java.util.stream.Collectors;

/**
 * redis 緩存配置.
 *
 * @author felord.cn
 * @since 2020 /8/17 20:14
 */
@EnableCaching
@Configuration
public class CacheConfiguration {


    /**
     * Redis cache configuration.
     *
     * @param redisTemplate the redis template
     * @return the redis cache configuration
     */
    @Bean
    public RedisCacheConfiguration redisCacheConfiguration(RedisTemplate<object, object> redisTemplate, CacheProperties cacheProperties) {
         // 參見 spring.cache.redis
        CacheProperties.Redis redisProperties = cacheProperties.getRedis();

        RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
                // 緩存的序列化問題
                .serializeValuesWith(RedisSerializationContext.SerializationPair
                        .fromSerializer(redisTemplate.getValueSerializer()));

        if (redisProperties.getTimeToLive() != null) {
            // 全局 TTL 時間
            redisCacheConfiguration = redisCacheConfiguration.entryTtl(redisProperties.getTimeToLive());
        }
        if (redisProperties.getKeyPrefix() != null) {
            // key 前綴值
            redisCacheConfiguration = redisCacheConfiguration.prefixCacheNameWith(redisProperties.getKeyPrefix());
        }
        if (!redisProperties.isCacheNullValues()) {
            // 默認緩存null值 可以防止緩存穿透
            redisCacheConfiguration = redisCacheConfiguration.disableCachingNullValues();
        }
        if (!redisProperties.isUseKeyPrefix()) {
            // 不使用key前綴
            redisCacheConfiguration = redisCacheConfiguration.disableKeyPrefix();
        }
        return redisCacheConfiguration;
    }


    /**
     * Redis cache manager 個性化配置緩存過期時間.
     * @see RedisCacheManager,CacheEnum
     * @return the redis cache manager builder customizer
     */
    @Bean
    public RedisCacheManagerBuilderCustomizer redisCacheManagerBuilderCustomizer(RedisCacheConfiguration redisCacheConfiguration) {

        return builder -&gt; builder.cacheDefaults(redisCacheConfiguration)
                // 自定義的一些緩存配置初始化 主要是特定緩存及其ttl時間
                .withInitialCacheConfigurations(EnumSet.allOf(CacheEnum.class).stream()
                        .collect(Collectors.toMap(CacheEnum::cacheName,
                                cacheEnum -&gt; redisCacheConfiguration.entryTtl(Duration.ofSeconds(cacheEnum.ttlSecond())))));
    }

}

個性化的同時我們可以通過注解@EnableCaching開啟Spring Cache緩存支持。關于Spring Cache的細節可以通過文章Spring Cache詳解來了解。

> 請注意，只有通過Spring Cache操作緩存才會達到上圖的效果。命令行操作需要顯式的聲明指令。

關于從零搭建Spring Boot腳手架中如何整合Redis作為緩存就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。