SpringCache的简介和使用_cacheproperties-CSDN博客

本文链接：https://blog.csdn.net/hc1285653662/article/details/125382597

1、简介

Spring 从 3.1 开始定义了 org.springframework.cache.Cache 和 org.springframework.cache.CacheManager 接口来统一不同的缓存技术；并支持使用 **JCache(JSR-107)**注解简化我们开发

Cache 接口为缓存的规范定义，包含缓存的各种操作集合； Cache 接口下 Spring 提供了各种 xxxCache 的实现；如 RedisCache ，EhCacheCache , ConcurrentMapCache 等；

每次调用需要缓存功能的方法时，Spring 会检查检查指定参数的指定的目标方法是否已经被调用过；如果有就直接从缓存中获取方法调用后的结果，如果没有就调用方法并缓存结果后返回给用户。下次调用直接从缓存中获取

2、整合SpringCache简化缓存开发

1）引入依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

2）添加配置

spring.cache.type=redis

3）主启动类上添加 @EnableCache注解,开启缓存功能

4）只需要在方法上使用注解就可以完成缓存操作

/*
1、每一个需要缓存的数据，我们都要来指定要放到哪个名字的缓存。【相当于缓存的分区（按照业务类型来进行分区）】
2、代表当前方法的结果需要缓存，如果缓存中有，方法不调用；如果缓存中没有，会调用方法，并将方法返回的结果放入缓存
3、默认行为
    1）如果缓存中有，方法不能调用
    2）key值默认生成，缓存的名字::simplekey 
    3）缓存的value的值默认使用jdk序列化机制，将序列化后的数据存储到redis
    4）默认缓存过期时间是-1（永不过期）
    
    自定义：
    1）指定缓存生成的key： 指定key-> spel表达式
    2）指定缓存的数据的过期时间：配置文件指定
    3）将数据保存为json格式： 
    
*/
@Cacheable("category")     
@Override
public List<CategoryEntity> getLevel1Categorys() {
    System.out.println("getLevel1Categorys方法执行......");
    List<CategoryEntity> categoryEntities = this.baseMapper
        .selectList(new QueryWrapper<CategoryEntity>().eq("parent_cid", "0"));
    return categoryEntities;
}

几个常用的注解
@CacheConfig：主要用于配置该类中会用到的一些共用的缓存配置。在这里@CacheConfig(cacheNames = “users”)：配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中，我们也可以不使用该注解，直接通过@Cacheable自己配置缓存集的名字来定义。

@Cacheable：配置了findByName函数的返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问。该注解主要有下面几个参数：

value、cacheNames：两个等同的参数（cacheNames为Spring 4新增，作为value的别名），用于指定缓存存储的集合名。由于Spring 4中新增了@CacheConfig，因此在Spring 3中原本必须有的value属性，也成为非必需项了
key：缓存对象存储在Map集合中的key值，非必需，缺省按照函数的所有参数组合作为key值，若自己配置需使用SpEL表达式，比如：@Cacheable(key = "#p0")：使用函数第一个参数作为缓存的key值，更多关于SpEL表达式的详细内容可参考 http://docs.spring.io/spring/docs/current/spring-framework-reference/html/cache.html#cache-spel-context
condition：缓存对象的条件，非必需，也需使用SpEL表达式，只有满足表达式条件的内容才会被缓存，比如：@Cacheable(key = "#p0", condition = "#p0.length() < 3")，表示只有当第一个参数的长度小于3的时候才会被缓存
unless：另外一个缓存条件参数，非必需，需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机，该条件是在函数被调用之后才做判断的，所以它可以通过对result进行判断。
keyGenerator：用于指定key生成器，非必需。若需要指定一个自定义的key生成器，我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口，并使用该参数来指定。需要注意的是：该参数与key是互斥的
cacheManager：用于指定使用哪个缓存管理器，非必需。只有当有多个时才需要使用
cacheResolver：用于指定使用那个缓存解析器，非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器，并用该参数指定。

@CachePut：配置于函数上，能够根据参数定义条件来进行缓存，它与@Cacheable不同的是，它每次都会真是调用函数，所以主要用于数据新增和修改操作上。它的参数与@Cacheable类似，具体功能可参考上面对@Cacheable`参数的解析

@CacheEvict：配置于函数上，通常用在删除方法上，用来从缓存中移除相应数据。除了同@Cacheable`一样的参数之外，它还有下面两个参数：

allEntries：非必需，默认为false。当为true时，会移除所有数据
beforeInvocation：非必需，默认为false，会在调用方法之后移除数据。当为true时，会在调用方法之前移除数据。

5）常用的几种自定义配置

①、以自定义的方式设置key的名称和过期时间

注解上添加属性

@Cacheable(value = {"category"},key="'level1Categorys'")

配置文件中：

#以毫秒为单位
spring.cache.redis.time-to-live=3600000

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-A9ioIXOG-1655738970085)(2、分布式高级篇.assets/image-20220620231718385.png)]

配置key|value的序列化机制

/**
 * @author houChen
 * @date 2021/11/4 6:59
 * @Description:
 *
 * 缓存配置类
 *    @ConfigurationProperties(prefix = "spring.cache") ： 只是使类中的属性和配置文件绑定，并不能注入到容器中
 *
 */
@EnableConfigurationProperties(CacheProperties.class)    //@EnableConfigurationProperties注解 可以使CacheProperties类注入到容器中
@Configuration
@EnableCaching
public class MyCacheConfig {

    @Bean
    RedisCacheConfiguration redisCacheConfiguration(CacheProperties cacheProperties){
        RedisCacheConfiguration config = RedisCacheConfiguration.defaultCacheConfig();
        config=config.serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()));
        config=config.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer()));

        CacheProperties.Redis redisCacheProperties = cacheProperties.getRedis();
        if(redisCacheProperties.getTimeToLive()!=null){
            config = config.entryTtl(redisCacheProperties.getTimeToLive());
        }
        return config;
    }
}