宝马娱乐在线112222 > 网络应用 > Spring Cache缓存介绍

原标题:Spring Cache缓存介绍

浏览次数:140 时间:2019-10-07

Spring 3.1 引入了激动人心的基于注释(annotation)的缓存(cache)技术,它本质上不是一个具体的缓存实现方案(例如 EHCache 或者 OSCache),而是一个对缓存使用的抽象,通过在既有代码中添加少量它定义的各种 annotation,即能够达到缓存方法的返回对象的效果。

缓存简介

缓存,我的理解是:让数据更接近于使用者;工作机制是:先从缓存中读取数据,如果没有再从慢速设备上读取实际数据(数据也会存入缓存);缓存什么:那些经常读取且不经常修改的数据/那些昂贵(CPU/IO)的且对于相同的请求有相同的计算结果的数据。如CPU--L1/L2--内存--磁盘就是一个典型的例子,CPU需要数据时先从L1/L2中读取,如果没有到内存中找,如果还没有会到磁盘上找。还有如用过Maven的朋友都应该知道,我们找依赖的时候,先从本机仓库找,再从本地服务器仓库找,最后到远程仓库服务器找;还有如京东的物流为什么那么快?他们在各个地都有分仓库,如果该仓库有货物那么送货的速度是非常快的。

 

Spring 的缓存技术还具备相当的灵活性,不仅能够使用 SpEL(Spring Expression Language)来定义缓存的 key 和各种 condition,还提供开箱即用的缓存临时存储方案,也支持和主流的专业缓存例如 EHCache 集成。

缓存命中率

即从缓存中读取数据的次数 与 总读取次数的比率,命中率越高越好:

命中率 = 从缓存中读取次数 / (总读取次数[从缓存中读取次数 + 从慢速设备上读取的次数])

Miss率 = 没有从缓存中读取的次数 / (总读取次数[从缓存中读取次数 + 从慢速设备上读取的次数])

 

这是一个非常重要的监控指标,如果做缓存一定要健康这个指标来看缓存是否工作良好;

 

其特点总结如下:

缓存策略

1.通过少量的配置 annotation 注释即可使得既有代码支持缓存

Eviction policy

移除策略,即如果缓存满了,从缓存中移除数据的策略;常见的有LFU、LRU、FIFO:

FIFO(First In First Out):先进先出算法,即先放入缓存的先被移除;

LRU(Least Recently Used):最久未使用算法,使用时间距离现在最久的那个被移除;

LFU(Least Frequently Used):最近最少使用算法,一定时间段内使用次数(频率)最少的那个被移除;

 

2.支持开箱即用 Out-Of-The-Box,即不用安装和部署额外第三方组件即可使用缓存

TTL(Time To Live )

存活期,即从缓存中创建时间点开始直到它到期的一个时间段(不管在这个时间段内有没有访问都将过期)

3.支持 Spring Express Language,能使用对象的任何属性或者方法来定义缓存的 key 和 condition

 

4.支持 AspectJ,并通过其实现任何方法的缓存支持

TTI(Time To Idle)

空闲期,即一个数据多久没被访问将从缓存中移除的时间。

 

 

到此,基本了解了缓存的知识,在Java中,我们一般对调用方法进行缓存控制,比如我调用"findUserById(Long id)",那么我应该在调用这个方法之前先从缓存中查找有没有,如果没有再掉该方法如从数据库加载用户,然后添加到缓存中,下次调用时将会从缓存中获取到数据。

 

自Spring 3.1起,提供了类似于@Transactional注解事务的注解Cache支持,且提供了Cache抽象;在此之前一般通过AOP实现;使用Spring Cache的好处:

提供基本的Cache抽象,方便切换各种底层Cache;

通过注解Cache可以实现类似于事务一样,缓存逻辑透明的应用到我们的业务代码上,且只需要更少的代码就可以完成;

提供事务回滚时也自动回滚缓存;

支持比较复杂的缓存逻辑;

 

对于Spring Cache抽象,主要从以下几个方面学习:

  • Cache API及默认提供的实现
  • Cache注解
  • 实现复杂的Cache逻辑

 

5.支持自定义 key 和自定义缓存管理者,具有相当的灵活性和扩展性

Cache API及默认提供的实现

Spring提供的核心Cache接口: 

Java代码  图片 1

  1. package org.springframework.cache;  
  2.   
  3. public interface Cache {  
  4.     String getName();  //缓存的名字  
  5.     Object getNativeCache(); //得到底层使用的缓存,如Ehcache  
  6.     ValueWrapper get(Object key); //根据key得到一个ValueWrapper,然后调用其get方法获取值  
  7.     <T> T get(Object key, Class<T> type);//根据key,和value的类型直接获取value  
  8.     void put(Object key, Object value);//往缓存放数据  
  9.     void evict(Object key);//从缓存中移除key对应的缓存  
  10.     void clear(); //清空缓存  
  11.   
  12.     interface ValueWrapper { //缓存值的Wrapper  
  13.         Object get(); //得到真实的value  
  14.         }  
  15. }  

提供了缓存操作的读取/写入/移除方法;

 

 

默认提供了如下实现:

ConcurrentMapCache:使用java.util.concurrent.ConcurrentHashMap实现的Cache;

GuavaCache:对Guava com.google.common.cache.Cache进行的Wrapper,需要Google Guava 12.0或更高版本,@since spring 4;

EhCacheCache:使用Ehcache实现

JCacheCache:对javax.cache.Cache进行的wrapper,@since spring 3.2;spring4将此类更新到JCache 0.11版本;

 

另外,因为我们在应用中并不是使用一个Cache,而是多个,因此Spring还提供了CacheManager抽象,用于缓存的管理: 

Java代码  图片 2

  1. package org.springframework.cache;  
  2. import java.util.Collection;  
  3. public interface CacheManager {  
  4.     Cache getCache(String name); //根据Cache名字获取Cache   
  5.     Collection<String> getCacheNames(); //得到所有Cache的名字  
  6. }  

 

默认提供的实现: 

ConcurrentMapCacheManager/ConcurrentMapCacheFactoryBean:管理ConcurrentMapCache;

GuavaCacheManager;

EhCacheCacheManager/EhCacheManagerFactoryBean;

JCacheCacheManager/JCacheManagerFactoryBean;

 

另外还提供了CompositeCacheManager用于组合CacheManager,即可以从多个CacheManager中轮询得到相应的Cache,如

Java代码  图片 3

  1. <bean id="cacheManager" class="org.springframework.cache.support.CompositeCacheManager">  
  2.     <property name="cacheManagers">  
  3.         <list>  
  4.             <ref bean="ehcacheManager"/>  
  5.             <ref bean="jcacheManager"/>  
  6.         </list>  
  7.     </property>  
  8.     <property name="fallbackToNoOpCache" value="true"/>  
  9. </bean>  

当我们调用cacheManager.getCache(cacheName) 时,会先从第一个cacheManager中查找有没有cacheName的cache,如果没有接着查找第二个,如果最后找不到,因为fallbackToNoOpCache=true,那么将返回一个NOP的Cache否则返回null。

 

 

除了GuavaCacheManager之外,其他Cache都支持Spring事务的,即如果事务回滚了,Cache的数据也会移除掉。

 

Spring不进行Cache的缓存策略的维护,这些都是由底层Cache自己实现,Spring只是提供了一个Wrapper,提供一套对外一致的API。

 

一、基于注解的支持

示例

需要添加Ehcache依赖,具体依赖轻参考pom.xml

 

SpringCacheTest.java

Java代码  图片 4

  1. @Test  
  2. public void test() throws IOException {  
  3.     //创建底层Cache  
  4.     net.sf.ehcache.CacheManager ehcacheManager  
  5.             = new net.sf.ehcache.CacheManager(new ClassPathResource("ehcache.xml").getInputStream());  
  6.   
  7.     //创建Spring的CacheManager  
  8.     EhCacheCacheManager cacheCacheManager = new EhCacheCacheManager();  
  9.     //设置底层的CacheManager  
  10.     cacheCacheManager.setCacheManager(ehcacheManager);  
  11.   
  12.     Long id = 1L;  
  13.     User user = new User(id, "zhang", "zhang@gmail.com");  
  14.   
  15.     //根据缓存名字获取Cache  
  16.     Cache cache = cacheCacheManager.getCache("user");  
  17.     //往缓存写数据  
  18.     cache.put(id, user);  
  19.     //从缓存读数据  
  20.     Assert.assertNotNull(cache.get(id, User.class));  
  21. }  

此处直接使用Spring提供的API进行操作;我们也可以通过xml/注解方式配置到spring容器;

 

xml风格的(spring-cache.xml):

Java代码  图片 5

  1. <bean id="ehcacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">  
  2.     <property name="configLocation" value="classpath:ehcache.xml"/>  
  3. </bean>  
  4.   
  5. <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">  
  6.     <property name="cacheManager" ref="ehcacheManager"/>  
  7.     <property name="transactionAware" value="true"/>  
  8. </bean>  

spring提供EhCacheManagerFactoryBean来简化ehcache cacheManager的创建,这样注入configLocation,会自动根据路径从classpath下找,比编码方式简单多了,然后就可以从spring容器获取cacheManager进行操作了。此处的transactionAware表示是否事务环绕的,如果true,则如果事务回滚,缓存也回滚,默认false。

 

 

注解风格的(AppConfig.java):

Java代码  图片 6

  1. @Bean  
  2. public CacheManager cacheManager() {  
  3.   
  4.     try {  
  5.         net.sf.ehcache.CacheManager ehcacheCacheManager  
  6.                 = new net.sf.ehcache.CacheManager(new ClassPathResource("ehcache.xml").getInputStream());  
  7.   
  8.         EhCacheCacheManager cacheCacheManager = new EhCacheCacheManager(ehcacheCacheManager);  
  9.         return cacheCacheManager;  
  10.     } catch (IOException e) {  
  11.         throw new RuntimeException(e);  
  12.     }  
  13. }  

和编程方式差不多就不多介绍了。

另外,除了这些默认的Cache之外,我们可以写自己的Cache实现;而且即使不用之后的Spring Cache注解,我们也尽量使用Spring Cache API进行Cache的操作,如果要替换底层Cache也是非常方便的。到此基本的Cache API就介绍完了,接下来我们来看看使用Spring Cache注解来简化Cache的操作。

 

Spring为我们提供了几个注解来支持Spring Cache。其核心主要是@Cacheable、@CachePut 和@CacheEvict。使用@Cacheable标记的方法在执行后Spring Cache将缓存其返回结果,@CachePut主要针对方法配置,能够根据方法的请求参数对其结果进行缓存,和 @Cacheable不同的是,它每次都会触发真实方法的调用,而使用@CacheEvict标记的方法会在方法执行前或者执行后移除Spring Cache中的某些元素。

Cache注解

1.@Cacheable

启用Cache注解

XML风格的(spring-cache.xml):

Java代码  图片 7

  1. <cache:annotation-driven cache-manager="cacheManager" proxy-target-class="true"/>  

另外还可以指定一个 key-generator,即默认的key生成策略,后边讨论;

 

 

注解风格的(AppConfig.java):

Java代码  图片 8

  1. @Configuration  
  2. @ComponentScan(basePackages = "com.sishuok.spring.service")  
  3. @EnableCaching(proxyTargetClass = true)  
  4. public class AppConfig implements CachingConfigurer {  
  5.     @Bean  
  6.     @Override  
  7.     public CacheManager cacheManager() {  
  8.   
  9.         try {  
  10.             net.sf.ehcache.CacheManager ehcacheCacheManager  
  11.                     = new net.sf.ehcache.CacheManager(new ClassPathResource("ehcache.xml").getInputStream());  
  12.   
  13.             EhCacheCacheManager cacheCacheManager = new EhCacheCacheManager(ehcacheCacheManager);  
  14.             return cacheCacheManager;  
  15.         } catch (IOException e) {  
  16.             throw new RuntimeException(e);  
  17.         }  
  18.     }  
  19.   
  20.     @Bean  
  21.     @Override  
  22.     public KeyGenerator keyGenerator() {  
  23.         return new SimpleKeyGenerator();  
  24.     }  
  25. }  

1、使用@EnableCaching启用Cache注解支持;

2、实现CachingConfigurer,然后注入需要的cacheManager和keyGenerator;从spring4开始默认的keyGenerator是SimpleKeyGenerator;

 

@Cacheable可以标记在一个方法上,也可以标记在一个类上。当标记在一个方法上时表示该方法是支持缓存的,当标记在一个类上时则表示该类所有的方法都是支持缓存的。对于一个支持缓存的方法,Spring会在其被调用后将其返回值缓存起来,以保证下次利用同样的参数来执行该方法时可以直接从缓存中获取结果,而不需要再次执行该方法。Spring在缓存方法的返回值时是以键值对进行缓存的,值就是方法的返回结果,至于键的话,Spring又支持两种策略,默认策略和自定义策略,需要注意的是当一个支持缓存的方法在对象内部被调用时是不会触发缓存功能的。@Cacheable可以指定三个属性,value、key和condition。

@CachePut 

应用到写数据的方法上,如新增/修改方法,调用方法时会自动把相应的数据放入缓存: 

Java代码  图片 9

  1. @CachePut(value = "user", key = "#user.id")  
  2. public User save(User user) {  
  3.     users.add(user);  
  4.     return user;  
  5. }  

即调用该方法时,会把user.id作为key,返回值作为value放入缓存;

 

@CachePut注解:

Java代码  图片 10

  1. public @interface CachePut {  
  2.     String[] value();              //缓存的名字,可以把数据写到多个缓存  
  3.     String key() default "";       //缓存key,如果不指定将使用默认的KeyGenerator生成,后边介绍  
  4.     String condition() default ""; //满足缓存条件的数据才会放入缓存,condition在调用方法之前和之后都会判断  
  5.     String unless() default "";    //用于否决缓存更新的,不像condition,该表达只在方法执行之后判断,此时可以拿到返回值result进行判断了  
  6. }  

 

value:缓存的名称,在 spring 配置文件中定义,必须指定至少一个。如@Cacheable(value=”mycache”) 或者@Cacheable(value={”cache1”,”cache2”}

@CacheEvict 

即应用到移除数据的方法上,如删除方法,调用方法时会从缓存中移除相应的数据:

Java代码  图片 11

  1. @CacheEvict(value = "user", key = "#user.id") //移除指定key的数据  
  2. public User delete(User user) {  
  3.     users.remove(user);  
  4.     return user;  
  5. }  
  6. @CacheEvict(value = "user", allEntries = true) //移除所有数据  
  7. public void deleteAll() {  
  8.     users.clear();  
  9. }  

 

@CacheEvict注解:

Java代码  图片 12

  1. public @interface CacheEvict {  
  2.     String[] value();                        //请参考@CachePut  
  3.     String key() default "";                 //请参考@CachePut  
  4.     String condition() default "";           //请参考@CachePut  
  5.     boolean allEntries() default false;      //是否移除所有数据  
  6.     boolean beforeInvocation() default false;//是调用方法之前移除/还是调用之后移除  

 

key:缓存的 key,可以为空,如果指定要按照 SpEL 表达式编写,如果不指定,则缺省按照方法的所有参数进行组合。如@Cacheable(value=”testcache”,key=”#userName”)

@Cacheable

应用到读取数据的方法上,即可缓存的方法,如查找方法:先从缓存中读取,如果没有再调用方法获取数据,然后把数据添加到缓存中:

Java代码  图片 13

  1. @Cacheable(value = "user", key = "#id")  
  2.  public User findById(final Long id) {  
  3.      System.out.println("cache miss, invoke find by id, id:" + id);  
  4.      for (User user : users) {  
  5.          if (user.getId().equals(id)) {  
  6.              return user;  
  7.          }  
  8.      }  
  9.      return null;  
  10.  }  

 

@Cacheable注解:

Java代码  图片 14

  1. public @interface Cacheable {  
  2.     String[] value();             //请参考@CachePut  
  3.     String key() default "";      //请参考@CachePut  
  4.     String condition() default "";//请参考@CachePut  
  5.     String unless() default "";   //请参考@CachePut    

condition:缓存的条件,可以为空,使用 SpEL 编写,返回 true 或者 false,只有为 true 才进行缓存。如@Cacheable(value=”testcache”,condition=”#userName.length()>2”)

 

注:除了上述使用方法参数作为key之外,Spring还为我们提供了一个root对象可以用来生成key。通过该root对象我们可以获取到以下信息。

运行流程

Java代码  图片 15

  1. 1、首先执行@CacheEvict(如果beforeInvocation=true且condition 通过),如果allEntries=true,则清空所有  
  2. 2、接着收集@Cacheable(如果condition 通过,且key对应的数据不在缓存),放入cachePutRequests(也就是说如果cachePutRequests为空,则数据在缓存中)  
  3. 3、如果cachePutRequests为空且没有@CachePut操作,那么将查找@Cacheable的缓存,否则result=缓存数据(也就是说只要当没有cache put请求时才会查找缓存)  
  4. 4、如果没有找到缓存,那么调用实际的API,把结果放入result  
  5. 5、如果有@CachePut操作(如果condition 通过),那么放入cachePutRequests  
  6. 6、执行cachePutRequests,将数据写入缓存(unless为空或者unless解析结果为false);  
  7. 7、执行@CacheEvict(如果beforeInvocation=false 且 condition 通过),如果allEntries=true,则清空所有  

流程中需要注意的就是2/3/4步:

如果有@CachePut操作,即使有@Cacheable也不会从缓存中读取;问题很明显,如果要混合多个注解使用,不能组合使用@CachePut和@Cacheable;官方说应该避免这样使用(解释是如果带条件的注解相互排除的场景);不过个人感觉还是不要考虑这个好,让用户来决定如何使用,否则一会介绍的场景不能满足。

属性名称

描述

示例

methodName

当前方法名

#root.methodName

method

当前方法

#root.method.name

target

当前被调用的对象

#root.target

targetClass

当前被调用的对象的class

#root.targetClass

args

当前方法参数组成的数组

#root.args[0]

caches

当前被调用的方法使用的Cache

#root.caches[0].name

提供的SpEL上下文数据

Spring Cache提供了一些供我们使用的SpEL上下文数据,下表直接摘自Spring官方文档:

名字 位置 描述 示例

methodName

root对象

当前被调用的方法名

#root.methodName

method

root对象

当前被调用的方法

#root.method.name

target

root对象

当前被调用的目标对象

#root.target

targetClass

root对象

当前被调用的目标对象类

#root.targetClass

args

root对象

当前被调用的方法的参数列表

#root.args[0]

caches

root对象

当前方法调用使用的缓存列表(如@Cacheable(value={"cache1", "cache2"})),则有两个cache

#root.caches[0].name

argument name

执行上下文

当前被调用的方法的参数,如findById(Long id),我们可以通过#id拿到参数

#user.id

result

执行上下文

方法执行后的返回值(仅当方法执行之后的判断有效,如‘unless’,'cache evict'的beforeInvocation=false)

#result

通过这些数据我们可能实现比较复杂的缓存逻辑了,后边再来介绍。

 

2.@CachePut
在支持Spring Cache的环境下,对于使用@Cacheable标注的方法,Spring在每次执行前都会检查Cache中是否存在相同key的缓存元素,如果存在就不再执行该方法,而是直接从缓存中获取结果进行返回,否则才会执行并将返回结果存入指定的缓存中。@CachePut也可以声明一个方法支持缓存功能。与@Cacheable不同的是使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果,而是每次都会执行该方法,并将执行结果以键值对的形式存入指定的缓存中。
@CachePut也可以标注在类上和方法上。使用@CachePut时我们可以指定的属性跟@Cacheable是一样的。
3.@CacheEvict
@CacheEvict是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。其中value、key和condition的语义与@Cacheable对应的属性类似。即value表示清除操作是发生在哪些Cache上的(对应Cache的名称);key表示需要清除的是哪个key,如未指定则会使用默认策略生成的key;condition表示清除操作发生的条件。下面我们来介绍一下新出现的两个属性allEntries和beforeInvocation。
allEntries:是否清空所有缓存内容,缺省为 false,如果指定为 true,则方法调用后将立即清空所有缓存。如:@CachEvict(value=”testcache”,allEntries=true)
beforeInvocation:是否在方法执行前就清空,缺省为 false,如果指定为 true,则在方法还没有执行的时候就清空缓存,缺省情况下,如果方法执行抛出异常,则不会清空缓存。如:@CachEvict(value=”testcache”,beforeInvocation=true)
其他参数和@Cacheable相同
4.@Caching
@Caching注解可以让我们在一个方法或者类上同时指定多个Spring Cache相关的注解。其拥有三个属性:cacheable、put和evict,分别用于指定@Cacheable、@CachePut和@CacheEvict。如: @Caching(cacheable = @Cacheable("users"), evict = { @CacheEvict("cache2"),@CacheEvict(value = "cache3", allEntries = true) })

Key生成器

如果在Cache注解上没有指定key的话@CachePut(value = "user"),会使用KeyGenerator进行生成一个key: 

Java代码  图片 16

  1. public interface KeyGenerator {  
  2.     Object generate(Object target, Method method, Object... params);  
  3. }  

默认提供了DefaultKeyGenerator生成器(Spring 4之后使用SimpleKeyGenerator): 

Java代码  图片 17

  1. @Override  
  2. public Object generate(Object target, Method method, Object... params) {  
  3.     if (params.length == 0) {  
  4.         return SimpleKey.EMPTY;  
  5.     }  
  6.     if (params.length == 1 && params[0] != null) {  
  7.         return params[0];  
  8.     }  
  9.     return new SimpleKey(params);  
  10. }  

即如果只有一个参数,就使用参数作为key,否则使用SimpleKey作为key。

 

我们也可以自定义自己的key生成器,然后通过xml风格的<cache:annotation-driven key-generator=""/>或注解风格的CachingConfigurer中指定keyGenerator。 

二、实例

 

使用map集合实现缓存管理,演示spring cache的使用。

条件缓存

根据运行流程,如下@Cacheable将在执行方法之前( #result还拿不到返回值)判断condition,如果返回true,则查缓存; 

Java代码  图片 18

  1. @Cacheable(value = "user", key = "#id", condition = "#id lt 10")  
  2. public User conditionFindById(final Long id)  

 

根据运行流程,如下@CachePut将在执行完方法后(#result就能拿到返回值了)判断condition,如果返回true,则放入缓存; 

Java代码  图片 19

  1. @CachePut(value = "user", key = "#id", condition = "#result.username ne 'zhang'")  
  2. public User conditionSave(final User user)   

  

根据运行流程,如下@CachePut将在执行完方法后(#result就能拿到返回值了)判断unless,如果返回false,则放入缓存;(即跟condition相反)

Java代码  图片 20

  1. @CachePut(value = "user", key = "#user.id", unless = "#result.username eq 'zhang'")  
  2.     public User conditionSave2(final User user)   

 

根据运行流程,如下@CacheEvict, beforeInvocation=false表示在方法执行之后调用(#result能拿到返回值了);且判断condition,如果返回true,则移除缓存;

Java代码  图片 21

  1. @CacheEvict(value = "user", key = "#user.id", beforeInvocation = false, condition = "#result.username ne 'zhang'")  
  2. public User conditionDelete(final User user)   

 

1.创建缓存对象实例

@Caching

有时候我们可能组合多个Cache注解使用;比如用户新增成功后,我们要添加id-->user;username--->user;email--->user的缓存;此时就需要@Caching组合多个注解标签了。

 

如用户新增成功后,添加id-->user;username--->user;email--->user到缓存; 

Java代码  图片 22

  1. @Caching(  
  2.         put = {  
  3.                 @CachePut(value = "user", key = "#user.id"),  
  4.                 @CachePut(value = "user", key = "#user.username"),  
  5.                 @CachePut(value = "user", key = "#user.email")  
  6.         }  
  7. )  
  8. public User save(User user) {  

  

@Caching定义如下: 

Java代码  图片 23

  1. public @interface Caching {  
  2.     Cacheable[] cacheable() default {}; //声明多个@Cacheable  
  3.     CachePut[] put() default {};        //声明多个@CachePut  
  4.     CacheEvict[] evict() default {};    //声明多个@CacheEvict  
  5. }  

 

package org.springframework.cache.demo;

自定义缓存注解

比如之前的那个@Caching组合,会让方法上的注解显得整个代码比较乱,此时可以使用自定义注解把这些注解组合到一个注解中,如: 

Java代码  图片 24

  1. @Caching(  
  2.         put = {  
  3.                 @CachePut(value = "user", key = "#user.id"),  
  4.                 @CachePut(value = "user", key = "#user.username"),  
  5.                 @CachePut(value = "user", key = "#user.email")  
  6.         }  
  7. )  
  8. @Target({ElementType.METHOD, ElementType.TYPE})  
  9. @Retention(RetentionPolicy.RUNTIME)  
  10. @Inherited  
  11. public @interface UserSaveCache {  
  12. }  

 

这样我们在方法上使用如下代码即可,整个代码显得比较干净。 

Java代码  图片 25

  1. @UserSaveCache  
  2. public User save(User user)  

  

import java.io.Serializable;

示例

新增/修改数据时往缓存中写 

Java代码  图片 26

  1. @Caching(  
  2.         put = {  
  3.                 @CachePut(value = "user", key = "#user.id"),  
  4.                 @CachePut(value = "user", key = "#user.username"),  
  5.                 @CachePut(value = "user", key = "#user.email")  
  6.         }  
  7. )  
  8. public User save(User user)  

 

Java代码  图片 27

  1. @Caching(  
  2.         put = {  
  3.                 @CachePut(value = "user", key = "#user.id"),  
  4.                 @CachePut(value = "user", key = "#user.username"),  
  5.                 @CachePut(value = "user", key = "#user.email")  
  6.         }  
  7. )  
  8. public User update(User user)   

删除数据时从缓存中移除

Java代码  图片 28

  1. @Caching(  
  2.         evict = {  
  3.                 @CacheEvict(value = "user", key = "#user.id"),  
  4.                 @CacheEvict(value = "user", key = "#user.username"),  
  5.                 @CacheEvict(value = "user", key = "#user.email")  
  6.         }  
  7. )  
  8. public User delete(User user)   

Java代码  图片 29

  1. @CacheEvict(value = "user", allEntries = true)  
  2.  public void deleteAll()  

 

查找时从缓存中读

Java代码  图片 30

  1. @Caching(  
  2.         cacheable = {  
  3.                 @Cacheable(value = "user", key = "#id")  
  4.         }  
  5. )  
  6. public User findById(final Long id)   

 

Java代码  图片 31

  1. @Caching(  
  2.          cacheable = {  
  3.                  @Cacheable(value = "user", key = "#username")  
  4.          }  
  5.  )  
  6.  public User findByUsername(final String username)   

 

Java代码  图片 32

  1. @Caching(  
  2.           cacheable = {  
  3.                   @Cacheable(value = "user", key = "#email")  
  4.           }  
  5.   )  
  6.   public User findByEmail(final String email)  

  

 

//缓存对象
public class User implements Serializable{
 /**
  *
  */
 private static final long serialVersionUID = 1L;
 private int id;
 private String name;
 
 public User(){
 }
 
 public User(String name){
  this.name= name;
 }
 
 public int getId() {
  return id;
 }
 public void setId(int id) {
  this.id = id;
 }
 public String getName() {
  return name;
 }
 public void setName(String name) {
  this.name = name;
 }
}
2.对象服务实现类

问题及解决方案

一、比如findByUsername时,不应该只放username-->user,应该连同id--->user和email--->user一起放入;这样下次如果按照id查找直接从缓存中就命中了;这需要根据之前的运行流程改造CacheAspectSupport: 

Java代码  图片 33

  1. // We only attempt to get a cached result if there are no put requests  
  2. if (cachePutRequests.isEmpty() && contexts.get(CachePutOperation.class).isEmpty()) {  
  3.     result = findCachedResult(contexts.get(CacheableOperation.class));  
  4. }  

改为:

Java代码  图片 34

  1. Collection<CacheOperationContext> cacheOperationContexts = contexts.get(CacheableOperation.class);  
  2. if (!cacheOperationContexts.isEmpty()) {  
  3.     result = findCachedResult(cacheOperationContexts);  
  4. }  

然后就可以通过如下代码完成想要的功能: 

Java代码  图片 35

  1. @Caching(  
  2.         cacheable = {  
  3.                 @Cacheable(value = "user", key = "#username")  
  4.         },  
  5.         put = {  
  6.                 @CachePut(value = "user", key = "#result.id", condition = "#result != null"),  
  7.                 @CachePut(value = "user", key = "#result.email", condition = "#result != null")  
  8.         }  
  9. )  
  10. public User findByUsername(final String username) {  
  11.     System.out.println("cache miss, invoke find by username, username:" + username);  
  12.     for (User user : users) {  
  13.         if (user.getUsername().equals(username)) {  
  14.             return user;  
  15.         }  
  16.     }  
  17.     return null;  
  18. }  

  

 

二、缓存注解会让代码看上去比较乱;应该使用自定义注解把缓存注解提取出去;

 

三、往缓存放数据/移除数据是有条件的,而且条件可能很复杂,考虑使用SpEL表达式:

Java代码  图片 36

  1. @CacheEvict(value = "user", key = "#user.id", condition = "#root.target.canCache() and #root.caches[0].get(#user.id).get().username ne #user.username", beforeInvocation = true)  
  2. public void conditionUpdate(User user)  

 或更复杂的直接调用目标对象的方法进行操作(如只有修改了某个数据才从缓存中清除,比如菜单数据的缓存,只有修改了关键数据时才清空菜单对应的权限数据) 

Java代码  图片 37

  1. @Caching(  
  2.         evict = {  
  3.                 @CacheEvict(value = "user", key = "#user.id", condition = "#root.target.canEvict(#root.caches[0], #user.id, #user.username)", beforeInvocation = true)  
  4.         }  
  5. )  
  6. public void conditionUpdate(User user)   

Java代码  图片 38

  1. public boolean canEvict(Cache userCache, Long id, String username) {  
  2.     User cacheUser = userCache.get(id, User.class);  
  3.     if (cacheUser == null) {  
  4.         return false;  
  5.     }  
  6.     return !cacheUser.getUsername().equals(username);  
  7. }  

如上方式唯一不太好的就是缓存条件判断方法也需要暴露出去;而且缓存代码和业务代码混合在一起,不优雅;因此把canEvict方法移到一个Helper静态类中就可以解决这个问题了:

Java代码  图片 39

  1. @CacheEvict(value = "user", key = "#user.id", condition = "T(com.sishuok.spring.service.UserCacheHelper).canEvict(#root.caches[0], #user.id, #user.username)", beforeInvocation = true)  
  2. public void conditionUpdate(User user)  

 

四、其实对于:id--->user;username---->user;email--->user;更好的方式可能是:id--->user;username--->id;email--->id;保证user只存一份;如:

Java代码  图片 40

  1. @CachePut(value="cacheName", key="#user.username", cacheValue="#user.username")  
  2. public void save(User user)   

Java代码  图片 41

  1. @Cacheable(value="cacheName", ley="#user.username", cacheValue="#caches[0].get(#caches[0].get(#username).get())")  
  2. public User findByUsername(String username)  

 

五、使用Spring3.1注解 缓存 模糊匹配Evict的问题 

缓存都是key-value风格的,模糊匹配本来就不应该是Cache要做的;而是通过自己的缓存代码实现;

 

六、spring cache的缺陷:例如有一个缓存存放 list<User>,现在你执行了一个 update(user)的方法,你一定不希望清除整个缓存而想替换掉update的元素

这个在现有的抽象上没有很好的方案,可以考虑通过condition在之前的Helper方法中解决;当然不是很优雅。

 

也就是说Spring Cache注解还不是很完美,我认为可以这样设计:

@Cacheable(cacheName = "缓存名称",key="缓存key/SpEL", value="缓存值/SpEL/不填默认返回值",  beforeCondition="方法执行之前的条件/SpEL", afterCondition="方法执行后的条件/SpEL", afterCache="缓存之后执行的逻辑/SpEL")

value也是一个SpEL,这样可以定制要缓存的数据;afterCache定制自己的缓存成功后的其他逻辑。

 

 

当然Spring Cache注解对于大多数场景够用了,如果场景复杂还是考虑使用AOP吧;如果自己实现请考虑使用Spring Cache API进行缓存抽象。

 

欢迎加入spring群134755960进行交流。

package org.springframework.cache.demo;

import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.Cacheable;

/**
 * 业务服务
 *
 */
public class UserService {

 @Cacheable(value = "userCache",key="#userName")
 // 使用了一个缓存名叫 userCache
 public User getUserByName(String userName) {
  // 方法内部实现不考虑缓存逻辑,直接实现业务
  return getFromDB(userName);
 }

 @CacheEvict(value = "userCache", key = "#user.name")
 // 清空 accountCache 缓存
 public void updateUser(User user) {
  updateDB(user);
 }

 @CacheEvict(value = "userCache", allEntries = true,beforeInvocation=true)
 // 清空 accountCache 缓存
 public void reload() {
 }

本文由宝马娱乐在线112222发布于网络应用,转载请注明出处:Spring Cache缓存介绍

关键词:

上一篇:没有了

下一篇:没有了