【測試開發】知識點-項目中使用 Spring Cache + Redis 緩存數據

有時候我們爲了提高查詢速度，會使用緩存，但是並不是所有數據都適合放到緩存中來。

像一些不經常修改的數據、固定的數據、經常查詢的數據等，是適合放到緩存的。

那麼現在就把之前實現的字典功能裏的數據，放到緩存裏去。

一、Spring Cache + Redis 介紹

Spring Cache是一個非常優秀的緩存組件。

自 Spring 3.1起，提供了類似於@Transactional註解事務的註解Cache支持，且提供了Cache抽象，方便切換各種底層Cache（如：redis）。

使用Spring Cache的優點：

• 提供基本的Cache抽象，方便切換各種底層Cache
• 通過註解Cache可以實現類似於事務一樣，緩存邏輯透明的應用到我們的業務代碼上，且只需要更少的代碼就可以完成
• 提供事務回滾時也自動回滾緩存
• 支持比較複雜的緩存邏輯

二、項目中集成

1. 引入依賴

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

        <!-- spring2.X集成redis所需common-pool2-->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
            <version>2.6.0</version>
        </dependency>

    </dependencies>

2. 添加 redis 配置類

配置類是一個比較固定的寫法，需要了解下結構。

// 配置類
@Configuration
// 開啓緩存處理
@EnableCaching
public class RedisConfig {

    /**
     * 自定義key規則
     *
     * @return
     */
    @Bean
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object target, Method method, Object... params) {
                StringBuilder sb = new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(method.getName());
                for (Object obj : params) {
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }

    /**
     * 設置RedisTemplate規則
     * @param redisConnectionFactory
     * @return
     */
    @Bean
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<Object, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory);
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);

        //解決查詢緩存轉換異常的問題
        ObjectMapper om = new ObjectMapper();
        // 指定要序列化的域，field,get和set,以及修飾符範圍，ANY是都有包括private和public
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        // 指定序列化輸入的類型，類必須是非final修飾的，final修飾的類，比如String,Integer等會跑出異常
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);

        //序列號key value
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);

        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }

    /**
     * 設置CacheManager緩存規則
     * @param factory
     * @return
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory factory) {
        RedisSerializer<String> redisSerializer = new StringRedisSerializer();
        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);

        // 配置序列化（解決亂碼的問題）,過期時間600秒
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig()
                .entryTtl(Duration.ofSeconds(600))
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer))
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                .disableCachingNullValues();

        RedisCacheManager cacheManager = RedisCacheManager.builder(factory)
                .cacheDefaults(config)
                .build();
        return cacheManager;
    }
}

主要是 3 個方法:

• 自定義key規則：可以更具我們自定義規則生成 key。
• 設置RedisTemplate規則：後續操作redis，往裏存取內容，需要用到 RedisTemplate，這裏進行相關設置。
• 設置CacheManager緩存規則：處理緩存相關的一些規則，比如緩存時間、亂碼處理等。

3. 配置文件增加 redis 配置

spring.redis.host=XXX.XXX.XXX.XX
spring.redis.port=6379
spring.redis.database= 0
spring.redis.timeout=1800000

spring.redis.lettuce.pool.max-active=20
spring.redis.lettuce.pool.max-wait=-1
#最大阻塞等待時間(負數表示沒限制)
spring.redis.lettuce.pool.max-idle=5
spring.redis.lettuce.pool.min-idle=0

4. 啓動安裝好的 redis

安裝相關可以參考我之前的分享：

https://www.cnblogs.com/pingguo-softwaretesting/p/14883012.html

我換了臺雲服務器，也重新安裝了下，測試正常。

這是單機操作，如果需要其他主機也可以鏈接到redis，還要改個配置：

三、Spring Cache 常用註解介紹

Spring Cache 提供了相關注解，可以讓我們很方便實現緩存操作，先看下最常用的幾個。

1. @Cacheable

用的最多的註解，功能也很強大，一般用在查詢方法上。

可以根據方法對其返回結果進行緩存，下次請求時，如果緩存存在，則直接讀取緩存數據返回；如果緩存不存在，則執行方法，並把返回的結果存入緩存中。

說白了，比如我第一次查詢緩存操作，如果不存在就去查詢數據庫，查到數據後返回，並且放到緩存裏去，當第二次查詢的時候就可以查詢緩存裏的數據。

查看源碼，屬性值如下：

• value：緩存名，必填，它指定了你的緩存存放在哪塊命名空間
• cacheNames：與 value 差不多，二選一即可
• key：可選屬性，可以使用 SpEL 標籤自定義緩存的key

2. @CachePut

一般用在新增方法上。

使用該註解標誌的方法，每次都會執行，並將結果存入指定的緩存中。其他方法可以直接從響應的緩存中讀取緩存數據，而不需要再去查詢數據庫。

查看源碼，屬性值如下：

• value：緩存名，必填，它指定了你的緩存存放在哪塊命名空間
• cacheNames：與 value 差不多，二選一即可
• key：可選屬性，可以使用 SpEL 標籤自定義緩存的key

3. @CacheEvict

一般用在更新或者刪除方法上，使用該註解標誌的方法，會清空指定的緩存。

查看源碼，屬性值如下：

• value：緩存名，必填，它指定了你的緩存存放在哪塊命名空間
• cacheNames：與 value 差不多，二選一即可
• key：可選屬性，可以使用 SpEL 標籤自定義緩存的key
• allEntries：是否清空所有緩存，默認爲 false。如果指定爲 true，則方法調用後將立即清空所有的緩存
• beforeInvocation：是否在方法執行前就清空，默認爲 false。如果指定爲 true，則在方法執行前就會清空緩存

四、功能裏實現緩存操作

改造之前的字典功能，加入緩存相關操作，在查詢和導入（新增）的操作上增加對應註解。

查詢操作

在 service 層對應的實現方法上增加註解@Cacheable(value = "dict", keyGenerator = "keyGenerator")

value = "dict", keyGenerator = "keyGenerator"，這裏面傳入的值就是爲了構造key，keyGenerator就是redis配置類裏定義的：

接下來到前端刷新一下列表頁面，進行一次查詢請求，然後查看下redis：

這個 key 就是按照配置類裏自定義的規則構建出來的，再來查詢一下這個 key：

緩存裏有數據了。

導入操作

在 service 層對應的實現方法上增加註解@CacheEvict(value = "dict", allEntries=true)

測試一下，我先del刪除掉緩存，然後前端頁面做一個導入的操作：

導入成功後，再次查看緩存：

新增成功。