注释驱动的 Spring cache 缓存介绍.docx

注释驱动的 Spring cache 缓存介绍介绍 spring 3.1 激动人心的新特性：注释驱动的缓存，本文通过一个简单的例子进行展开，通过对比我们原来的自定义缓存和 spring 的基于注释的 cache 配置方法，展现了 spring cache 的强大之处，然后介绍了其基本的原理，扩展点和使用场景的限制。通过阅读本文，你可以短时间内掌握 spring 带来的强大缓存技术，在很少的配置下即可给既有代码提供缓存能力。6评论：赵 才文, 技术经理2013 年 3 月 15 日 内容概述Spring 3.1 引入了激动人心的基于注释（annotation）的缓存（cache）技术，它本质上不是一个具体的缓存实现方案（例如 EHCache 或者 OSCache），而是一个对缓存使用的抽象，通过在既有代码中添加少量它定义的各种 annotation，即能够达到缓存方法的返回对象的效果。Spring 的缓存技术还具备相当的灵活性，不仅能够使用 SpEL（Spring Expression Language）来定义缓存的 key 和各种 condition，还提供开箱即用的缓存临时存储方案，也支持和主流的专业缓存例如 EHCache 集成。其特点总结如下： 通过少量的配置 annotation 注释即可使得既有代码支持缓存 支持开箱即用 Out-Of-The-Box，即不用安装和部署额外第三方组件即可使用缓存 支持 Spring Express Language，能使用对象的任何属性或者方法来定义缓存的 key 和 condition 支持 AspectJ，并通过其实现任何方法的缓存支持 支持自定义 key 和自定义缓存管理者，具有相当的灵活性和扩展性本文将针对上述特点对 Spring cache 进行详细的介绍，主要通过一个简单的例子和原理介绍展开，然后我们将一起看一个比较实际的缓存例子，最后会介绍 spring cache 的使用限制和注意事项。OK，Let s begin!回页首原来我们是怎么做的这里先展示一个完全自定义的缓存实现，即不用任何第三方的组件来实现某种对象的内存缓存。场景是：对一个账号查询方法做缓存，以账号名称为 key，账号对象为 value，当以相同的账号名称查询账号的时候，直接从缓存中返回结果，否则更新缓存。账号查询服务还支持 reload 缓存（即清空缓存）。首先定义一个实体类：账号类，具备基本的 id 和 name 属性，且具备 getter 和 setter 方法清单 1. Account.java package cacheOfAnno; public class Account private int id; private String name; public Account(String 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) = name; 然后定义一个缓存管理器，这个管理器负责实现缓存逻辑，支持对象的增加、修改和删除，支持值对象的泛型。如下：清单 2. MyCacheManager.java package oldcache; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; public class MyCacheManager private Map cache = new ConcurrentHashMap(); public T getValue(Object key) return cache.get(key); public void addOrUpdateCache(String key,T value) cache.put(key, value); public void evictCache(String key) / 根据 key 来删除缓存中的一条记录 if(cache.containsKey(key) cache.remove(key); public void evictCache() / 清空缓存中的所有记录 cache.clear(); 好，现在我们有了实体类和一个缓存管理器，还需要一个提供账号查询的服务类，此服务类使用缓存管理器来支持账号查询缓存，如下：清单 3. MyAccountService.java package oldcache; import cacheOfAnno.Account; public class MyAccountService private MyCacheManager cacheManager; public MyAccountService() cacheManager = new MyCacheManager();/ 构造一个缓存管理器 public Account getAccountByName(String acctName) Account result = cacheManager.getValue(acctName);/ 首先查询缓存 if(result!=null) System.out.println(get from cache.+acctName); return result;/ 如果在缓存中，则直接返回缓存的结果 result = getFromDB(acctName);/ 否则到数据库中查询 if(result!=null) / 将数据库查询的结果更新到缓存中 cacheManager.addOrUpdateCache(acctName, result); return result; public void reload() cacheManager.evictCache(); private Account getFromDB(String acctName) System.out.println(real querying db.+acctName); return new Account(acctName); 现在我们开始写一个测试类，用于测试刚才的缓存是否有效清单 4. Main.java package oldcache; public class Main public static void main(String args) MyAccountService s = new MyAccountService(); / 开始查询账号 s.getAccountByName(somebody);/ 第一次查询，应该是数据库查询 s.getAccountByName(somebody);/ 第二次查询，应该直接从缓存返回 s.reload();/ 重置缓存 System.out.println(after reload.); s.getAccountByName(somebody);/ 应该是数据库查询 s.getAccountByName(somebody);/ 第二次查询，应该直接从缓存返回 按照分析，执行结果应该是：首先从数据库查询，然后直接返回缓存中的结果，重置缓存后，应该先从数据库查询，然后返回缓存中的结果，实际的执行结果如下：清单 5. 运行结果 real querying db.somebody/ 第一次从数据库加载 get from cache.somebody/ 第二次从缓存加载 after reload./ 清空缓存 real querying db.somebody/ 又从数据库加载 get from cache.somebody/ 从缓存加载可以看出我们的缓存起效了，但是这种自定义的缓存方案有如下劣势： 缓存代码和业务代码耦合度太高，如上面的例子，AccountService 中的 getAccountByName（）方法中有了太多缓存的逻辑，不便于维护和变更 不灵活，这种缓存方案不支持按照某种条件的缓存，比如只有某种类型的账号才需要缓存，这种需求会导致代码的变更 缓存的存储这块写的比较死，不能灵活的切换为使用第三方的缓存模块如果你的代码中有上述代码的影子，那么你可以考虑按照下面的介绍来优化一下你的代码结构了，也可以说是简化，你会发现，你的代码会变得优雅的多！回页首Hello World，注释驱动的 Spring CacheHello World 的实现目标本 Hello World 类似于其他任何的 Hello World 程序，从最简单实用的角度展现 spring cache 的魅力，它基于刚才自定义缓存方案的实体类 Account.java，重新定义了 AccountService.java 和测试类 Main.java（注意这个例子不用自己定义缓存管理器，因为 spring 已经提供了缺省实现）需要的 jar 包为了实用 spring cache 缓存方案，在工程的 classpath 必须具备下列 jar 包。图 1. 工程依赖的 jar 包图注意这里我引入的是最新的 spring 3.2.0.M1 版本 jar 包，其实只要是 spring 3.1 以上，都支持 spring cache。其中 spring-context-*.jar 包含了 cache 需要的类。定义实体类、服务类和相关配置文件实体类就是上面自定义缓存方案定义的 Account.java，这里重新定义了服务类，如下：清单 6. AccountService.java package cacheOfAnno; import org.springframework.cache.annotation.CacheEvict; import org.springframework.cache.annotation.Cacheable; public class AccountService Cacheable(value=accountCache)/ 使用了一个缓存名叫 accountCache public Account getAccountByName(String userName) / 方法内部实现不考虑缓存逻辑，直接实现业务 System.out.println(real query account.+userName); return getFromDB(userName); private Account getFromDB(String acctName) System.out.println(real querying db.+acctName); return new Account(acctName); 注意，此类的 getAccountByName 方法上有一个注释 annotation，即 Cacheable(value=”accountCache”)，这个注释的意思是，当调用这个方法的时候，会从一个名叫 accountCache 的缓存中查询，如果没有，则执行实际的方法（即查询数据库），并将执行的结果存入缓存中，否则返回缓存中的对象。这里的缓存中的 key 就是参数 userName，value 就是 Account 对象。“accountCache”缓存是在 spring*.xml 中定义的名称。好，因为加入了 spring，所以我们还需要一个 spring 的配置文件来支持基于注释的缓存清单 7. Spring-cache-anno.xml 注意这个 spring 配置文件有一个关键的支持缓存的配置项：，这个配置项缺省使用了一个名字叫 cacheManager 的缓存管理器，这个缓存管理器有一个 spring 的缺省实现，即 org.springframework.cache.support.SimpleCacheManager，这个缓存管理器实现了我们刚刚自定义的缓存管理器的逻辑，它需要配置一个属性 caches，即此缓存管理器管理的缓存集合，除了缺省的名字叫 default 的缓存，我们还自定义了一个名字叫 accountCache 的缓存，使用了缺省的内存存储方案 ConcurrentMapCacheFactoryBean，它是基于 java.util.concurrent.ConcurrentHashMap 的一个内存缓存实现方案。OK，现在我们具备了测试条件，测试代码如下：清单 8. Main.java package cacheOfAnno; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class Main public static void main(String args) ApplicationContext context = new ClassPathXmlApplicationContext( spring-cache-anno.xml);/ 加载 spring 配置文件 AccountService s = (AccountService) context.getBean(accountServiceBean); / 第一次查询，应该走数据库 System.out.print(first query.); s.getAccountByName(somebody); / 第二次查询，应该不查数据库，直接返回缓存的值 System.out.print(second query.); s.getAccountByName(somebody); System.out.println(); 上面的测试代码主要进行了两次查询，第一次应该会查询数据库，第二次应该返回缓存，不再查数据库，我们执行一下，看看结果清单 9. 执行结果 first query.real query account.somebody/ 第一次查询 real querying db.somebody/ 对数据库进行了查询 second query./ 第二次查询，没有打印数据库查询日志，直接返回了缓存中的结果可以看出我们设置的基于注释的缓存起作用了，而在 AccountService.java 的代码中，我们没有看到任何的缓存逻辑代码，只有一行注释：Cacheable(value=accountCache)，就实现了基本的缓存方案，是不是很强大？如何清空缓存好，到目前为止，我们的 spring cache 缓存程序已经运行成功了，但是还不完美，因为还缺少一个重要的缓存管理逻辑：清空缓存，当账号数据发生变更，那么必须要清空某个缓存，另外还需要定期的清空所有缓存，以保证缓存数据的可靠性。为了加入清空缓存的逻辑，我们只要对 AccountService.java 进行修改，从业务逻辑的角度上看，它有两个需要清空缓存的地方 当外部调用更新了账号，则我们需要更新此账号对应的缓存 当外部调用说明重新加载，则我们需要清空所有缓存清单 10. AccountService.java点击查看代码清单清单 11. Main.java点击查看代码清单清单 12. 运行结果 first query.real querying db.somebody second query. start testing clear cache. real querying db.somebody1 real querying db.somebody2 real update db.somebody1 real querying db.somebody1 real querying db.somebody1 real querying db.somebody2结果和我们期望的一致，所以，我们可以看出，spring cache 清空缓存的方法很简单，就是通过 CacheEvict 注释来标记要清空缓存的方法，当这个方法被调用后，即会清空缓存。注意其中一个 CacheEvict(value=”accountCache”,key=”#account.getName()”)，其中的 Key 是用来指定缓存的 key 的，这里因为我们保存的时候用的是 account 对象的 name 字段，所以这里还需要从参数 account 对象中获取 name 的值来作为 key，前面的 # 号代表这是一个 SpEL 表达式，此表达式可以遍历方法的参数对象，具体语法可以参考 Spring 的相关文档手册。如何按照条件操作缓存前面介绍的缓存方法，没有任何条件，即所有对 accountService 对象的 getAccountByName 方法的调用都会起动缓存效果，不管参数是什么值，如果有一个需求，就是只有账号名称的长度小于等于 4 的情况下，才做缓存，大于 4 的不使用缓存，那怎么实现呢？Spring cache 提供了一个很好的方法，那就是基于 SpEL 表达式的 condition 定义，这个 condition 是 Cacheable 注释的一个属性，下面我来演示一下清单 13. AccountService.java（getAccountByName 方法修订，支持条件） Cacheable(value=accountCache,condition=#userName.length() = 4)/ 缓存名叫 accountCache public Account getAccountByName(String userName) / 方法内部实现不考虑缓存逻辑，直接实现业务 return getFromDB(userName); 注意其中的 condition=”#userName.length() 2”)表 2. CachePut 作用和配置方法CachePut 的作用主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和 Cacheable 不同的是，它每次都会触发真实方法的调用CachePut 主要的参数value缓存的名称，在 spring 配置文件中定义，必须指定至少一个例如：Cacheable(value=”mycache”) 或者Cacheable(value=”cache1”,”cache2”key缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合例如：Cacheable(value=”testcache”,key=”#userName”)condition缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存例如：Cacheable(value=”testcache”,condition=”#userName.length()2”)表 3. CacheEvict 作用和配置方法CachEvict 的作用主要针对方法配置，能够根据一定的条件对缓存进行清空CacheEvict 主要的参数value缓存的名称，在 spring 配置文件中定义，必须指定至少一个例如：CachEvict(value=”mycache”) 或者CachEvict(value=”cache1”,”cache2”key缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合例如：CachEvict(value=”testcache”,key=”#userName”)condition缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才清空缓存例如：CachEvict(value=”testcache”,condition=”#userName.length()2”)allEntries是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存例如：CachEvict(value=”testcache”,allEntries=true)beforeInvocation是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存例如：CachEvict(value=”testcache”，beforeInvocation=true)回页首基本原理和 spring 的事务管理类似，spring cache 的关键原理就是 spring AOP，通过 spring AOP，其实现了在方法调用前、调用后获取方法的入参和返回值，进而实现了缓存的逻辑。我们来看一下下面这个图：图 2. 原始方法调用图上图显示，当客户端“Calling code”调用一个普通类 Plain Object 的 foo() 方法的时候，是直接作用在 pojo 类自身对象上的，客户端拥有的是被调用者的直接的引用。而 Spring cache 利用了 Spring AOP 的动态代理技术，即当客户端尝试调用 pojo 的 foo（）方法的时候，给他的不是 pojo 自身的引用，而是一个动态生成的代理类图 3. 动态代理调用图如上图所示，这个时候，实际客户端拥有的是一个代理的引用，那么在调用 foo() 方法的时候，会首先调用 proxy 的 foo() 方法，这个时候 proxy 可以整体控制实际的 pojo.foo() 方法的入参和返回值，比如缓存结果，比如直接略过执行实际的 foo() 方法等，都是可以轻松做到的。回页首扩展性直到现在，我们已经学会了如何使用开箱即用的 spring cache，这基本能够满足一般应用对缓存的需求，但现实总是很复杂，当你的用户量上去或者性能跟不上，总需要进行扩展，这个时候你或许对其提供的内存缓存不满意了，因为其不支持高可用性，也不具备持久化数据能力，这个时候，你就需要自定义你的缓存方案了，还好，spring 也想到了这一点。我们先不考虑如何持久化缓存，毕竟这种第三方的实现方案很多，我们要考虑的是，怎么利用 spring 提供的扩展点实现我们自己的缓存，且在不改原来已有代码的情况下进行扩展。首先，我们需要提供一个 CacheManager 接口的实现，这个接口告诉 spring 有哪些 cache 实例，spring 会根据 cache 的名字查找 cache 的实例。另外还需要自己实现 Cache 接口，Cache 接口负责实际的缓存逻辑，例如增加键值对、存储、查询和清空等。利用 Cache 接口，我们可以对接任何第三方的缓存系统，例如 EHCache、OSCache，甚至一些内存数据库例如 memcache 或者 h2db 等。下面我举一个简单的例子说明如何做。清单 23. MyCacheManager package cacheOfAnno; import java.util.Collection; import org.springframework.cache.support.AbstractCacheManager; public class MyCacheManager extends AbstractCacheManager private Collection caches; /* * Specify the collection of Cache instances to use for this CacheManager. */ public void setCaches(Collection caches) this.caches = caches; Override protected Collection loadCaches() return this.caches; 上面的自定义的 CacheManager 实际继承了 spring 内置的 AbstractCacheManager，实际上仅仅管理 MyCache 类的实例。清单 24. MyCache package cacheOfAnno; import java.util.HashMap; import java.util.Map; import org.springframework.cache.Cache; import org.springframework.cache.support.SimpleValueWrapper; public class MyCache implements Cache private String name; private Map store = new HashMap(); public MyCache() public MyCache(String name) = name; Override public String getName() return name; public void setName(String name) = name; Override public Object getNativeCache() return st