Spring boot Caffeine缓存（三）——使用注解

1. Spring boot Caffeine缓存（一）——CacheManager与配置文件
2. Spring boot Caffeine缓存（二）——Cache、LoadingCache
3. Spring boot Caffeine缓存（三）——使用注解

注解在Spring中的应用很广泛，几乎成为了其标志，这里说下使用注解来集成缓存。
cache方面的注解主要有以下5个

• @Cacheable 触发缓存入口（这里一般放在创建和获取的方法上）
• @CacheEvict 触发缓存的eviction（用于删除的方法上）
• @CachePut 更新缓存且不影响方法执行（用于修改的方法上，该注解下的方法始终会被执行）
• @Caching 将多个缓存组合在一个方法上（该注解可以允许一个方法同时设置多个注解）
• @CacheConfig 在类级别设置一些缓存相关的共同配置（与其它缓存配合使用）

上边5个注解中目前我学习的时候使用了前三个，所以这里主要针对前三个来展开，后边两个结合spring官方文档来简单介绍下。

@Cacheable

先看看它的源码

public @interface Cacheable {

    /**
     * 设定要使用的cache的名字，必须提前定义好缓存
     */
    @AliasFor("cacheNames")
    String[] value() default {};

    /**
     * 同value()，决定要使用那个/些缓存
     */
    @AliasFor("value")
    String[] cacheNames() default {};

    /**
     * 使用SpEL表达式来设定缓存的key，如果不设置默认方法上所有参数都会作为key的一部分
     */
    String key() default "";

    /**
     * 用来生成key，与key()不可以共用
     */
    String keyGenerator() default "";

    /**
     * 设定要使用的cacheManager，必须先设置好cacheManager的bean，这是使用该bean的名字
     */
    String cacheManager() default "";

    /**
     * 使用cacheResolver来设定使用的缓存，用法同cacheManager，但是与cacheManager不可以同时使用
     */
    String cacheResolver() default "";

    /**
     * 使用SpEL表达式设定出发缓存的条件，在方法执行前生效
     */
    String condition() default "";

    /**
     * 使用SpEL设置出发缓存的条件，这里是方法执行完生效，所以条件中可以有方法执行后的value
     */
    String unless() default "";

    /**
     * 用于同步的，在缓存失效（过期不存在等各种原因）的时候，如果多个线程同时访问被标注的方法
     * 则只允许一个线程通过去执行方法
     */
    boolean sync() default false;

}

现在来看下我代码中集成的部分

    /**
     * condition条件判断是否要走缓存，无法使用方法中出现的值（返回结果等）,条件为true放入缓存
     * unless是方法执行后生效，决定是否放入缓存,返回true的放缓存
     * */
    @Cacheable(cacheNames = "outLimit",sync = true,key = "#name",unless = "#value != null ")
    public String getCaffeineServiceTest(String name,Integer age){
        String value = name + " nihao "+ age;
        logger.info("getCaffeineServiceTest value = {}",value);
        return value;
    }
    /**
     * 如果cacheLoad生效这里的方法主体不会被执行
     * */
    @Cacheable(cacheNames = "outLimit",key = "#name",cacheResolver = "simpleCacheResolver")
    public String addCaffeineServiceTest(String name){
        String value = name + " nihao";
        logger.info("addCaffeineServiceTest value = {}",value);
        return value;
    }
    /**
     * 使用cacheManager
     * */
    @Cacheable(cacheNames = "outLimit",sync = true,key = "#name",cacheManager = "caffeine")
    public String getCaffeineServiceTest2(String name,Integer age){
        String value = name + " nihao "+ age;
        logger.info("getCaffeineServiceTest value = {}",value);
        return value;
    }

其实看我上边的注解后这里没啥好说的了，cacheResolver 这个前边没有讲到过，这里正好介绍下。

先看下其实现类

其中SimpleCacheResolver和NamedCacheResolver是可以被我们使用的，所以这里我给出简单的代码

    @Autowired
    private CacheManager cacheManager;

    @Bean("simpleCacheResolver")
    public CacheResolver simpleCacheResolver(){
        SimpleCacheResolver resolver = new SimpleCacheResolver(cacheManager);
        return resolver;
    }

    @Bean("namedCacheResolver")
    public CacheResolver namedCacheResolver(){
        NamedCacheResolver resolver = new NamedCacheResolver(cacheManager,"outLimit");
        return resolver;
    }

CacheResolver 本质上还是加载了CacheManager，所以他和CacheManager才会互斥。

@CachePut

这是个一般用于修改方法上的注解，它的代码跟Cacheable基本相同，这里不做介绍。
现在说下CachePut和Cacheable的主要区别。

@Cacheable：它的注解的方法是否被执行取决于Cacheable中的条件，方法很多时候都可能不被执行。
@CachePut：这个注解不会影响方法的执行，也就是说无论它配置的条件是什么，方法都会被执行，更多的时候是被用到修改上。

看下代码

    /**
     * CachePut修改key的value，会调用cache的put
     * */
    @CachePut(cacheNames = "outLimit",cacheResolver = "namedCacheResolver")
    public String updateCaffeineServiceTest(String name){
        String value = name + " nihao";
        logger.info("updateCaffeineServiceTest value = {}",value);
        return value ;
    }

@CacheEvict

它跟上边的两个注解相比，源码中多了两个属性

public @interface CacheEvict {


    /**
     * 是否删除缓存中的所有数据，默认为false，只会删除被注解方法中传入的key的缓存
     */
    boolean allEntries() default false;

    /**
     * 设置缓存的删除在方法执行前执行还是执行后执行。如果设置true，则无论该方法是否正常结束，缓存中的值都会被删除。
     */
    boolean beforeInvocation() default false;

}

看下我的代码

    /**
     * CacheEvict删除key，会调用cache的evict
     * */
    @CacheEvict(cacheNames = "outLimit",key = "#name")
    public String deleteCaffeineServiceTest(String name){
        String value = name + " nihao";
        logger.info("deleteCaffeineServiceTest value = {}",value);
        return value;
    }

只是简单的集成，没有什么需要特别说明的。

@Caching

它是个组合上面三个注解的注解，之前我并没有用到，现在结合spring文档简单说下。

源码

public @interface Caching {

    Cacheable[] cacheable() default {};

    CachePut[] put() default {};

    CacheEvict[] evict() default {};

}

它只是给出了三种注解的组合，并没有给出限制条件，所以其使用也很简单，如下

@Caching(evict = { @CacheEvict("primary"), @CacheEvict(cacheNames="secondary", key="#p0") })
public Book importBooks(String deposit, Date date)

@CacheConfig
类级别的注解，可以设置某类中所有注解的相同部分，这个可以参考spring的类级别的@Mapping来理解。
其代码很简单

public @interface CacheConfig {

    String[] cacheNames() default {};

    String keyGenerator() default "";

    String cacheManager() default "";

    String cacheResolver() default "";

}

使用如下

@CacheConfig("books")
public class BookRepositoryImpl implements BookRepository {

    @Cacheable
    public Book findBook(ISBN isbn) {...}
}

这里说是使用books这个缓存。

关于缓存注解的就说到这，所有关于缓存的也说完了，具体使用的时候还是看自己对缓存的理解吧。