Spring Cache结合redis使用

╰半橙微兮° 2023-09-23 17:52 115阅读 0赞

### SpringCache结合redis使用 ###

*   *  springCache使用redis作为缓存使用步骤：
     *   *  1、添加依赖
         *  2、添加properties配置文件
         *  3、cache配置文件
         *  4、controller 和service
         *  5、测试
         *   *  5.1 @Cacheable案例
             *   *  缓存key为方法参数测试
                 *  缓存key为方法名测试
             *  5.2 @CachePut
             *  5.3 @CacheEvict
             *  5.4 测试自定义缓存过期时间
         *  6、springCache注解
     *  案例源码
     *  优秀链接

## springCache使用redis作为缓存使用步骤： ##

### 1、添加依赖 ###

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <version>2.7.2</version>
          </dependency>
          <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
            <version>2.7.2</version>
          </dependency>

### 2、添加properties配置文件 ###

spring.redis.host=127.0.0.1
    
    spring.redis.port=6379
    
    spring.redis.password=
    
    spring.redis.pool.max-active=8
    
    spring.redis.pool.max-wait=-1
    
    spring.redis.pool.max-idle=8
    
    spring.redis.pool.min-idle=0
    
    spring.redis.timeout=30000

### 3、cache配置文件 ###

import com.fasterxml.jackson.annotation.JsonAutoDetect;
    import com.fasterxml.jackson.annotation.PropertyAccessor;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
    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.cache.RedisCacheWriter;
    import org.springframework.data.redis.connection.RedisConnectionFactory;
    import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
    import org.springframework.data.redis.serializer.RedisSerializationContext;
    
    import java.time.Duration;
    import java.util.HashMap;
    import java.util.Map;
    
    /**
     * SpringCache中配置 RedisCache
     *
     * @author xlwang55
     */
    @EnableCaching
    @Configuration
    public class CacheConfig {
        
        /**
         * 测试缓存key
         */
        public static final String STUDENT_CACHE = "studentCache";
        public static final String MESSAGE_CACHE = "messageCache";
    
        /**
         * 设置SpringCache缓存时间:默认策略和自定义指定key策略的超时时间
         */
        @Bean
        public RedisCacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        
            return new RedisCacheManager(
                    RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory),
                    this.getRedisCacheConfigurationWithTtl(60),
                    this.getRedisCacheConfigurationMap());
        }
    
        /**
         * 自定义指定key策略的超时时间
         *
         * @author xlwang55
         * @date 2022/12/12
         */
        private Map<String, RedisCacheConfiguration> getRedisCacheConfigurationMap() {
        
    
            Map<String, RedisCacheConfiguration> redisCacheConfigurationMap = new HashMap<>(2);
            //SsoCache和BasicDataCache进行过期时间配置
            redisCacheConfigurationMap.put(MESSAGE_CACHE, this.getRedisCacheConfigurationWithTtl(30 * 60));
            //自定义设置缓存时间
            redisCacheConfigurationMap.put(STUDENT_CACHE, this.getRedisCacheConfigurationWithTtl(60));
            return redisCacheConfigurationMap;
        }
    
        /**
         * 初始化缓存序列化配置和过期时间
         *
         * @param seconds 缓存时间
         * @author xlwang55
         * @date 2022/12/12
         */
        private RedisCacheConfiguration getRedisCacheConfigurationWithTtl(Integer seconds) {
        
            Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
            ObjectMapper om = new ObjectMapper();
            om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
            om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
            jackson2JsonRedisSerializer.setObjectMapper(om);
            RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig();
            return redisCacheConfiguration.serializeValuesWith(RedisSerializationContext
                    .SerializationPair
                    .fromSerializer(jackson2JsonRedisSerializer)).entryTtl(Duration.ofSeconds(seconds));
        }
    
    }

@EnableCaching开启缓存  
@Configuration 标记当前类为配置类，确保springboot能够扫描到此配置类。

### 4、controller 和service ###

### 5、测试 ###

#### 5.1 @Cacheable案例 ####

![在这里插入图片描述][c9550204d56e45cf9291e4cdc7798264.png]

##### 缓存key为方法参数测试 #####

userName参数为 “小明”  
第一次访问，会查询数据库并将缓存存入redis中  
![在这里插入图片描述][c7553855c6e44f79a5ccbb26d4512bf2.png]  
![在这里插入图片描述][d99d8b779b9943c09a629e21328088d9.png]  
第二次访问，直接命中缓存返回结果  
![在这里插入图片描述][0e2773ba98ea4e02b524dd67f396b1d7.png]

##### 缓存key为方法名测试 #####

![在这里插入图片描述][6f221fff8c6b4fa8b47a91ae62d8b3a7.png]

#### 5.2 @CachePut ####

使用@CachePut修改缓存信息，当我们对数据库修改时，为了保持缓存数据一致性需要对缓存信息修改。但是思考了一下，我们在实际使用的时候采用修改缓存的方式并不能完全保证一致性。比如上述queryAllUser案例中，查询全部用户也做了缓存，要想修改缓存并不是件容易的事情。所以建议使用@CacheEvict将缓存清除。  
![在这里插入图片描述][259e30d3d6c34700a0ab3a2cf6b251a5.png]  
缓存结果  
![在这里插入图片描述][bcfaef04d2c544ac93b0a86a4bc8acf2.png]

#### 5.3 @CacheEvict ####

方式一：  
@CacheEvict(cacheNames = “user”,allEntries = true)  
表示删除缓存名称为user的整个分区  
`allEntries = true` 表示直接清空掉整个分区

![在这里插入图片描述][e782a289337241488a8bd46cd0a6452d.png]  
@CacheEvict(cacheNames = “user”, key = “\#userName”)  
![在这里插入图片描述][1f22280486954c5fa540baacae862095.png]

方式二 @Caching + @CacheEvict

@Caching中evict可以添加多个@CacheEvict注解，删除指定key的缓存。  
添加多个@CacheEvict测试![在这里插入图片描述][937d97e22e17419a99592b15d2072bd7.png]

#### 5.4 测试自定义缓存过期时间 ####

CacheConfig配置类中定义信息  
![在这里插入图片描述][7940e8fca779480d9bcaa803a5c4e143.png]  
测试默认缓存时间  
通过如下结果发现缓存时间为6000秒，符合定义  
![在这里插入图片描述][6fcf34b111294ce088df418dc4e13c9e.png]  
测试自定义key缓存时间  
通过结果发现 缓存时间为60秒  
![在这里插入图片描述][e152c642c29a413791d7d4af1c162b4f.png]

### 6、springCache注解 ###

![在这里插入图片描述][001abbca4d1b4248aa90985fc130fd09.png]  
![在这里插入图片描述][430f1d4fcd974d95abf5f9ce7722f511.png]  
![在这里插入图片描述][bc8f503c8dbe4a93907977b036df739c.png]  
![在这里插入图片描述][542bcf59163e494b85054f0a64d41372.png]  
![在这里插入图片描述][eb0c27160d1145198b156693e9d4df5a.png]

## 案例源码 ##

[Spring Cache结合redis使用源码][Spring Cache_redis]

## 优秀链接 ##

[Spring Cache 整合 Redis 做缓存使用~ 快速上手~][Spring Cache _ Redis _]

[Spring源码解析-Spring Cache][Spring_-Spring Cache]

[Spring Cache缓存框架][Spring Cache]

[c9550204d56e45cf9291e4cdc7798264.png]: https://img-blog.csdnimg.cn/c9550204d56e45cf9291e4cdc7798264.png
[c7553855c6e44f79a5ccbb26d4512bf2.png]: https://img-blog.csdnimg.cn/c7553855c6e44f79a5ccbb26d4512bf2.png
[d99d8b779b9943c09a629e21328088d9.png]: https://img-blog.csdnimg.cn/d99d8b779b9943c09a629e21328088d9.png
[0e2773ba98ea4e02b524dd67f396b1d7.png]: https://img-blog.csdnimg.cn/0e2773ba98ea4e02b524dd67f396b1d7.png
[6f221fff8c6b4fa8b47a91ae62d8b3a7.png]: https://img-blog.csdnimg.cn/6f221fff8c6b4fa8b47a91ae62d8b3a7.png
[259e30d3d6c34700a0ab3a2cf6b251a5.png]: https://img-blog.csdnimg.cn/259e30d3d6c34700a0ab3a2cf6b251a5.png
[bcfaef04d2c544ac93b0a86a4bc8acf2.png]: https://img-blog.csdnimg.cn/bcfaef04d2c544ac93b0a86a4bc8acf2.png
[e782a289337241488a8bd46cd0a6452d.png]: https://img-blog.csdnimg.cn/e782a289337241488a8bd46cd0a6452d.png
[1f22280486954c5fa540baacae862095.png]: https://img-blog.csdnimg.cn/1f22280486954c5fa540baacae862095.png
[937d97e22e17419a99592b15d2072bd7.png]: https://img-blog.csdnimg.cn/937d97e22e17419a99592b15d2072bd7.png
[7940e8fca779480d9bcaa803a5c4e143.png]: https://img-blog.csdnimg.cn/7940e8fca779480d9bcaa803a5c4e143.png
[6fcf34b111294ce088df418dc4e13c9e.png]: https://img-blog.csdnimg.cn/6fcf34b111294ce088df418dc4e13c9e.png
[e152c642c29a413791d7d4af1c162b4f.png]: https://img-blog.csdnimg.cn/e152c642c29a413791d7d4af1c162b4f.png
[001abbca4d1b4248aa90985fc130fd09.png]: https://img-blog.csdnimg.cn/001abbca4d1b4248aa90985fc130fd09.png
[430f1d4fcd974d95abf5f9ce7722f511.png]: https://img-blog.csdnimg.cn/430f1d4fcd974d95abf5f9ce7722f511.png
[bc8f503c8dbe4a93907977b036df739c.png]: https://img-blog.csdnimg.cn/bc8f503c8dbe4a93907977b036df739c.png
[542bcf59163e494b85054f0a64d41372.png]: https://img-blog.csdnimg.cn/542bcf59163e494b85054f0a64d41372.png
[eb0c27160d1145198b156693e9d4df5a.png]: https://img-blog.csdnimg.cn/eb0c27160d1145198b156693e9d4df5a.png
[Spring Cache_redis]: https://gitee.com/wl8888/spring-cache.git
[Spring Cache _ Redis _]: https://juejin.cn/post/7157609002606526494
[Spring_-Spring Cache]: https://www.jianshu.com/p/fdff2f3f83f5
[Spring Cache]: https://www.cnblogs.com/javazhishitupu/p/16072083.html