spring cache 使用指南
spring有一套和各种缓存的集成方式。类似于sl4j，你可以选择log框架实现，也一样可以实现缓存实现，比如ehcache,guava cache.
首先，缓存是为了省略消耗时间的步骤，比如io。当我需要从数据库查询的数据几乎没有变化，或者变化很少的时候，我就没必要每次都去数据库里拿数据了。大可以放到本地，直接取出来就可以了。这时候需要注意的是数据一致性问题，缓存的数据是否被更改了，数据是否有效。
名字 |
位置 |
描述 |
示例 |
methodName |
root对象 |
当前被调用的方法名 |
|
method |
root对象 |
当前被调用的方法 |
|
target |
root对象 |
当前被调用的目标对象 |
|
targetClass |
root对象 |
当前被调用的目标对象类 |
|
args |
root对象 |
当前被调用的方法的参数列表 |
|
caches |
root对象 |
当前方法调用使用的缓存列表（如@Cacheable(value={"cache1", "cache2"})），则有两个cache |
|
argument name |
执行上下文 |
当前被调用的方法的参数，如findById(Long id)，我们可以通过#id拿到参数 |
#user.id |
result |
执行上下文 |
方法执行后的返回值（仅当方法执行之后的判断有效，如‘unless’，'cache evict'的beforeInvocation=false） |
|
@Caching
自定义缓存注解
示例
private final CacheOperationContextcontext;
private final Object key;
public CachePutRequest(CacheOperationContext context, Objectkey) {
this.context = context;
this.key = key;
}
public void apply(Object result) {
if (this.context.canPutToCache(result)) {
for (Cache cache : this.context.getCaches()) {
cache.put(this.key, result); //保存key,value,cache有EhCache、guavaCache、redisCache
}
}
}
}
Spring提供的核心Cache接口：
package org.springframework.cache;
public interface Cache {
String getName(); //缓存的名字
Object getNativeCache(); //得到底层使用的缓存，如Ehcache
ValueWrapper get(Object key); //根据key得到一个ValueWrapper，然后调用其get方法获取值
void put(Object key, Object value);//往缓存放数据
void evict(Object key);//从缓存中移除key对应的缓存
void clear(); //清空缓存
interface ValueWrapper { //缓存值的Wrapper
Object get(); //得到真实的value
}
}
默认提供了如下实现：
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，@sincespring 3.2；spring4将此类更新到JCache 0.11版本；
另外，因为我们在应用中并不是使用一个Cache，而是每种Cache多个，因此Spring还提供了CacheManager抽象，用于缓存的管理：
package org.springframework.cache;
import java.util.Collection;
public interface CacheManager {
Cache getCache(String name); //根据Cache名字获取Cache
Collection
}
默认提供的实现：
ConcurrentMapCacheManager/ConcurrentMapCacheFactoryBean：管理ConcurrentMapCache；
GuavaCacheManager；
EhCacheCacheManager/EhCacheManagerFactoryBean；
JCacheCacheManager/JCacheManagerFactoryBean；
另外还提供了CompositeCacheManager用于组合CacheManager，即可以从多个CacheManager中轮询得到相应的Cache，如
当我们调用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代码
@Test
public void test() throws IOException {
//创建底层Cache
net.sf.ehcache.CacheManager ehcacheManager
= new net.sf.ehcache.CacheManager(new ClassPathResource("ehcache.xml").getInputStream());
//创建Spring的CacheManager
EhCacheCacheManager cacheCacheManager = new EhCacheCacheManager();
//设置底层的CacheManager
cacheCacheManager.setCacheManager(ehcacheManager);
Long id = 1L;
User user = new User(id, "zhang", "[email protected]");
//根据缓存名字获取Cache
Cache cache = cacheCacheManager.getCache("user");
//往缓存写数据
cache.put(id, user);
//从缓存读数据
Assert.assertNotNull(cache.get(id, User.class));
}
此处直接使用Spring提供的API进行操作；我们也可以通过xml/注解方式配置到spring容器；
xml风格的（spring-cache.xml）：
Java代码
spring提供EhCacheManagerFactoryBean来简化ehcache cacheManager的创建，这样注入configLocation，会自动根据路径从classpath下找，比编码方式简单多了，然后就可以从spring容器获取cacheManager进行操作了。此处的transactionAware表示是否事务环绕的，如果true，则如果事务回滚，缓存也回滚，默认false。
注解风格的（AppConfig.java）：
Java代码
@Bean
public CacheManager cacheManager() {
try {
net.sf.ehcache.CacheManager ehcacheCacheManager
= new net.sf.ehcache.CacheManager(new ClassPathResource("ehcache.xml").getInputStream());
EhCacheCacheManager cacheCacheManager = new EhCacheCacheManager(ehcacheCacheManager);
return cacheCacheManager;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
和编程方式差不多就不多介绍了。
另外，除了这些默认的Cache之外，我们可以写自己的Cache实现；而且即使不用之后的Spring Cache注解，我们也尽量使用Spring Cache API进行Cache的操作，如果要替换底层Cache也是非常方便的。到此基本的Cache API就介绍完了，接下来我们来看看使用Spring Cache注解来简化Cache的操作。
XML风格的（spring-cache.xml）：
Java代码
另外还可以指定一个 key-generator，即默认的key生成策略，后边讨论；
注解风格的（AppConfig.java）：
Java代码
@Configuration
@ComponentScan(basePackages = "com.sishuok.spring.service")
@EnableCaching(proxyTargetClass = true)
public class AppConfig implements CachingConfigurer {
@Bean
@Override
public CacheManager cacheManager() {
try {
net.sf.ehcache.CacheManager ehcacheCacheManager
= new net.sf.ehcache.CacheManager(new ClassPathResource("ehcache.xml").getInputStream());
EhCacheCacheManager cacheCacheManager = new EhCacheCacheManager(ehcacheCacheManager);
return cacheCacheManager;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
@Bean
@Override
public KeyGenerator keyGenerator() {
return new SimpleKeyGenerator();
}
}
1、使用@EnableCaching启用Cache注解支持；
2、实现CachingConfigurer，然后注入需要的cacheManager和keyGenerator；从spring4开始默认的keyGenerator是SimpleKeyGenerator；
应用到写数据的方法上，如新增/修改方法，调用方法时会自动把相应的数据放入缓存：
Java代码
@CachePut(value = "user", key = "#user.id")
public User save(User user) {
users.add(user);
return user;
}
即调用该方法时，会把user.id作为key，返回值作为value放入缓存；
@CachePut注解：
Java代码
public @interface CachePut {
String[] value(); //缓存的名字，可以把数据写到多个缓存
String key() default ""; //缓存key，如果不指定将使用默认的KeyGenerator生成，后边介绍
String condition() default ""; //满足缓存条件的数据才会放入缓存，condition在调用方法之前和之后都会判断
String unless() default ""; //用于否决缓存更新的，不像condition，该表达只在方法执行之后判断，此时可以拿到返回值result进行判断了
}
即应用到移除数据的方法上，如删除方法，调用方法时会从缓存中移除相应的数据：
Java代码
@CacheEvict(value = "user", key = "#user.id") //移除指定key的数据
public User delete(User user) {
users.remove(user);
return user;
}
@CacheEvict(value = "user", allEntries = true) //移除所有数据
public void deleteAll() {
users.clear();
}
@CacheEvict注解：
Java代码
public @interface CacheEvict {
String[] value(); //请参考@CachePut
String key() default ""; //请参考@CachePut
String condition() default ""; //请参考@CachePut
boolean allEntries() default false; //是否移除所有数据
boolean beforeInvocation() default false;//是调用方法之前移除/还是调用之后移除
应用到读取数据的方法上，即可缓存的方法，如查找方法：先从缓存中读取，如果没有再调用方法获取数据，然后把数据添加到缓存中：
Java代码
@Cacheable(value = "user", key = "#id")
public User findById(final Long id) {
System.out.println("cache miss, invoke find by id, id:" + id);
for (User user : users) {
if (user.getId().equals(id)) {
return user;
}
}
return null;
}
@Cacheable注解：
Java代码
public @interface Cacheable {
String[] value(); //请参考@CachePut
String key() default ""; //请参考@CachePut
String condition() default "";//请参考@CachePut
String unless() default ""; //请参考@CachePut
Java代码
1、首先执行@CacheEvict（如果beforeInvocation=true且condition 通过），如果allEntries=true，则清空所有
2、接着收集@Cacheable（如果condition 通过，且key对应的数据不在缓存），放入cachePutRequests（也就是说如果cachePutRequests为空，则数据在缓存中）
3、如果cachePutRequests为空且没有@CachePut操作，那么将查找@Cacheable的缓存，否则result=缓存数据（也就是说只要当没有cache put请求时才会查找缓存）
4、如果没有找到缓存，那么调用实际的API，把结果放入result
5、如果有@CachePut操作(如果condition 通过)，那么放入cachePutRequests
6、执行cachePutRequests，将数据写入缓存（unless为空或者unless解析结果为false）；
7、执行@CacheEvict（如果beforeInvocation=false 且 condition 通过），如果allEntries=true，则清空所有
流程中需要注意的就是2/3/4步：
如果有@CachePut操作，即使有@Cacheable也不会从缓存中读取；问题很明显，如果要混合多个注解使用，不能组合使用@CachePut和@Cacheable；官方说应该避免这样使用（解释是如果带条件的注解相互排除的场景）；不过个人感觉还是不要考虑这个好，让用户来决定如何使用，否则一会介绍的场景不能满足。
提供的SpEL上下文数据
Spring Cache提供了一些供我们使用的SpEL上下文数据，下表直接摘自Spring官方文档：
通过这些数据我们可能实现比较复杂的缓存逻辑了，后边再来介绍。
Key生成器
如果在Cache注解上没有指定key的话@CachePut(value= "user")，会使用KeyGenerator进行生成一个key：
Java代码
public interface KeyGenerator {
Object generate(Object target, Method method, Object... params);
}
默认提供了DefaultKeyGenerator生成器（Spring4之后使用SimpleKeyGenerator）：
Java代码
@Override
public Object generate(Object target, Method method, Object... params) {
if (params.length == 0) {
return SimpleKey.EMPTY;
}
if (params.length == 1 && params[0] != null) {
return params[0];
}
return new SimpleKey(params);
}
即如果只有一个参数，就使用参数作为key，否则使用SimpleKey作为key。
我们也可以自定义自己的key生成器，然后通过xml风格的
根据运行流程，如下@Cacheable将在执行方法之前( #result还拿不到返回值)判断condition，如果返回true，则查缓存；
Java代码
@Cacheable(value = "user", key = "#id", condition = "#id lt 10")
public User conditionFindById(final Long id)
根据运行流程，如下@CachePut将在执行完方法后（#result就能拿到返回值了）判断condition，如果返回true，则放入缓存；
Java代码
@CachePut(value = "user", key = "#id", condition = "#result.username ne 'zhang'")
public User conditionSave(final User user)
根据运行流程，如下@CachePut将在执行完方法后（#result就能拿到返回值了）判断unless，如果返回false，则放入缓存；（即跟condition相反）
Java代码
@CachePut(value = "user", key = "#user.id", unless = "#result.username eq 'zhang'")
public User conditionSave2(final User user)
根据运行流程，如下@CacheEvict， beforeInvocation=false表示在方法执行之后调用（#result能拿到返回值了）；且判断condition，如果返回true，则移除缓存；
Java代码
@CacheEvict(value = "user", key = "#user.id", beforeInvocation = false, condition = "#result.username ne 'zhang'")
public User conditionDelete(final User user)
有时候我们可能组合多个Cache注解使用；比如用户新增成功后，我们要添加id-->user；username--->user；email--->user的缓存；此时就需要@Caching组合多个注解标签了。
如用户新增成功后，添加id-->user；username--->user；email--->user到缓存；
Java代码
@Caching(
put = {
@CachePut(value = "user", key = "#user.id"),
@CachePut(value = "user", key = "#user.username"),
@CachePut(value = "user", key = "#user.email")
}
)
public User save(User user) {
@Caching定义如下：
Java代码
public @interface Caching {
Cacheable[] cacheable() default {}; //声明多个@Cacheable
CachePut[] put() default {}; //声明多个@CachePut
CacheEvict[] evict() default {}; //声明多个@CacheEvict
}
比如之前的那个@Caching组合，会让方法上的注解显得整个代码比较乱，此时可以使用自定义注解把这些注解组合到一个注解中，如：
Java代码
@Caching(
put = {
@CachePut(value = "user", key = "#user.id"),
@CachePut(value = "user", key = "#user.username"),
@CachePut(value = "user", key = "#user.email")
}
)
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
public @interface UserSaveCache {
}
这样我们在方法上使用如下代码即可，整个代码显得比较干净。
Java代码
@UserSaveCache
public User save(User user)
新增/修改数据时往缓存中写
Java代码
@Caching(
put = {
@CachePut(value = "user", key = "#user.id"),
@CachePut(value = "user", key = "#user.username"),
@CachePut(value = "user", key = "#user.email")
}
)
public User save(User user)
Java代码
@Caching(
put = {
@CachePut(value = "user", key = "#user.id"),
@CachePut(value = "user", key = "#user.username"),
@CachePut(value = "user", key = "#user.email")
}
)
public User update(User user)
删除数据时从缓存中移除
Java代码
@Caching(
evict = {
@CacheEvict(value = "user", key = "#user.id"),
@CacheEvict(value = "user", key = "#user.username"),
@CacheEvict(value = "user", key = "#user.email")
}
)
public User delete(User user)
Java代码
@CacheEvict(value = "user", allEntries = true)
public void deleteAll()
查找时从缓存中读
Java代码
@Caching(
cacheable = {
@Cacheable(value = "user", key = "#id")
}
)
public User findById(final Long id)
Java代码
@Caching(
cacheable = {
@Cacheable(value = "user", key = "#username")
}
)
public User findByUsername(final String username)
Java代码
@Caching(
cacheable = {
@Cacheable(value = "user", key = "#email")
}
)
public User findByEmail(final String email)
问题及解决方案
一、比如findByUsername时，不应该只放username-->user，应该连同id--->user和email--->user一起放入；这样下次如果按照id查找直接从缓存中就命中了；这需要根据之前的运行流程改造CacheAspectSupport：
Java代码
// We only attempt to get a cached result if there are no put requests
if (cachePutRequests.isEmpty() && contexts.get(CachePutOperation.class).isEmpty()) {
result = findCachedResult(contexts.get(CacheableOperation.class));
}
改为：
Java代码
Collection
if (!cacheOperationContexts.isEmpty()) {
result = findCachedResult(cacheOperationContexts);
}
然后就可以通过如下代码完成想要的功能：
Java代码
@Caching(
cacheable = {
@Cacheable(value = "user", key = "#username")
},
put = {
@CachePut(value = "user", key = "#result.id", condition = "#result != null"),
@CachePut(value = "user", key = "#result.email", condition = "#result != null")
}
)
public User findByUsername(final String username) {
System.out.println("cache miss, invoke find by username, username:" + username);
for (User user : users) {
if (user.getUsername().equals(username)) {
return user;
}
}
return null;
}
二、缓存注解会让代码看上去比较乱；应该使用自定义注解把缓存注解提取出去；
三、往缓存放数据/移除数据是有条件的，而且条件可能很复杂，考虑使用SpEL表达式：
Java代码
@CacheEvict(value = "user", key = "#user.id", condition = "#root.target.canCache() and #root.caches[0].get(#user.id).get().username ne #user.username", beforeInvocation = true)
public void conditionUpdate(User user)
或更复杂的直接调用目标对象的方法进行操作（如只有修改了某个数据才从缓存中清除，比如菜单数据的缓存，只有修改了关键数据时才清空菜单对应的权限数据）
Java代码
@Caching(
evict = {
@CacheEvict(value = "user", key = "#user.id", condition = "#root.target.canEvict(#root.caches[0], #user.id, #user.username)", beforeInvocation = true)
}
)
public void conditionUpdate(User user)
Java代码
public boolean canEvict(Cache userCache, Long id, String username) {
User cacheUser = userCache.get(id, User.class);
if (cacheUser == null) {
return false;
}
return !cacheUser.getUsername().equals(username);
}
如上方式唯一不太好的就是缓存条件判断方法也需要暴露出去；而且缓存代码和业务代码混合在一起，不优雅；因此把canEvict方法移到一个Helper静态类中就可以解决这个问题了：
Java代码
@CacheEvict(value = "user", key = "#user.id", condition = "T(com.sishuok.spring.service.UserCacheHelper).canEvict(#root.caches[0], #user.id, #user.username)", beforeInvocation = true)
public void conditionUpdate(User user)
四、其实对于：id--->user；username---->user；email--->user；更好的方式可能是：id--->user；username--->id；email--->id；保证user只存一份；如：
Java代码
@CachePut(value="cacheName", key="#user.username", cacheValue="#user.username")
public void save(User user)
Java代码
@Cacheable(value="cacheName", ley="#user.username", cacheValue="#caches[0].get(#caches[0].get(#username).get())")
public User findByUsername(String username)
五、使用Spring3.1注解缓存模糊匹配Evict的问题
缓存都是key-value风格的，模糊匹配本来就不应该是Cache要做的；而是通过自己的缓存代码实现；
六、spring cache的缺陷：例如有一个缓存存放 list
这个在现有的抽象上没有很好的方案，可以考虑通过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进行缓存抽象。
https://github.com/zhangkaitao/spring4-showcase/tree/master/spring-cache
这里采用guava cache作为本地缓存。将guava cache注册到cacheManger里就可以调用了。
1.配置cacheManger
首先针对要缓存的类型，配置缓存策略。这里设置最大缓存数量和缓存过期时间
public static final String HOTEL_POSTION = "hotel_position"; //cache key
@Value("${cache.guavaCache.hotelPosition.maxSize}")
private longhotelPositionMaxSize;
@Value("${cache.guavaCache.hotelPosition.duration}")
private longhotelPositionDuration;
private GuavaCache buildHotelPositionCache(){
returnnew GuavaCache(HOTEL_POSTION,
CacheBuilder.newBuilder()
.recordStats()
.maximumSize(hotelPositionMaxSize)
.expireAfterWrite(hotelPositionDuration,TimeUnit.DAYS)
.build());
}
将刚才创建的缓存策略添加到cacheManger:
@Bean
publicCacheManager cacheManager() {
SimpleCacheManager manager = new SimpleCacheManager();
List list = newArrayList();
list.add(buildHotelPositionCache());
manager.setCaches( list );
returnmanager;
}
2.配置要缓存的方法
在需要使用这个缓存的地方，增加一行注解
@Cacheable(value = CacheManagementConfig.HOTEL_POSTION, key = "{#hotelId}", condition = "", unless = "!#result.isSuccessful()")
publicBaseDomainResponse
//......
}
@Cacheable表示这个方法要被缓存
value string,表示这个方法缓存的唯一性标识，即这方法缓存的key。语法为SpEL. 为配置文件中的缓存池名称 key 为键名
key String,表示每条请求缓存的key，即如果key相同，则返回缓存中对应的数据
condition boolean,可以额外添加缓存的条件.语法为SpEL.
unless boolean, 配置哪些条件下的记录不缓存。语法为SpEL.
result表示return的这个对象，可以同result来调用这个对象的属性，比如isSuccessful()就是我返回对象的一个方法。