在 Spring 3.1 中使用 @Cacheable 实现缓存

在软件开发中使用缓存已经有一个非常久的历史了。缓存是一种很好的设计思想，一旦你用了他，你将会发现他确实很有用。Spring3.1版本的核心对缓 存做了实现。在Java推出Annotation特性之前，实现缓存的一个难点在于它与业务逻辑代码的耦合性太强。
       然而，Spring3.1中使用@Cacheable 和@CacheEvict实现缓存在某种程度上解决了这个问题，基本思想是在方法加上@Cacheable注解，这个方法的返回值 将具有缓存特性。
       @Cacheable注解可以用在方法或者类级别。当他应用于方法级别的时候，就是如上所说的缓存返回值了。当应用在类级别的时候，这个类的所有方法的 返回值都将被缓存。

 

?

1 2 3 4 5 6 7 8 9 10 11 12 13

@Cacheable (value =  "employee" ) public class EmployeeDAO {      public Person findEmployee(String firstName, String surname,  int age) {        return new Person(firstName, surname, age);    }      public Person findAnotherEmployee(String firstName, String surname,  int age) {        return new Person(firstName, surname, age);    } }

       @Cacheable注解有三个参数，value是必须的，还有key和condition。第一个参数，也就是value指明了缓存将被存到什么地方。

?

1 2 3 4 5

@Cacheable (value =  "employee" )   public Person findEmployee(String firstName, String surname,  int age) {       return new Person(firstName, surname, age);   }

       任何存储在缓存中的数据为了高速访问都需要一个key。Spring默认使用被@Cacheable注解的方法的签名来作为key，当然你可以重写key，自定义key可以使用SpEL表达式。

?

1 2 3 4

<span style= "font-size:14px;" > @Cacheable (value =  "employee" , key =  "#surname" )</span>    public Person findEmployeeBySurname(String firstName, String surname,  int age) {        return new Person(firstName, surname, age);    }

       在findEmployeeBySurname()的注解中"#surname"是一个SpEL表达式，他将使用findEmployeeBySurname()方法中的surname参数作为key。

       @Cacheable的最后一个参数是condition（可选），同样的，也是引用一个SpEL表达式。但是这个参数将指明方法的返回结果是否被缓存。

?

1 2 3 4 5

@Cacheable (value =  "employee" , condition =  "#age < 25" )   public Person findEmployeeByAge(String firstName, String surname,  int age) {       return new Person(firstName, surname, age);   }

上面的例子中，只有年龄小于25的时候才被缓存。

在快速看完了如何使用缓存后，我们接下来看看缓存带来的效果。

?

1 2 3 4 5 6 7 8

@Test    public void testCache() {        Person employee1 = instance.findEmployee( "John" ,  "Smith" ,  33 );      Person employee2 = instance.findEmployee( "John" ,  "Smith" ,  33 );        assertEquals(employee1, employee2);    }

       上面的例子很简单，第一次调用findEmployee，findEmployee方法将被执行，Spring将他的返回值一个person对象存入缓存。第二次调用findEmployee的时候findEmployee将不被执行，Spring直接将缓存中的数据作为返回值返回。所以employee1 和employee2引用了同样的对象。

       而下面的例子中，我们将年龄小于25作为缓存条件，就将得到不同的结果。

?

1 2 3 4 5 6 7 8

@Test   public void testCacheWithAgeAsCondition() {       Person employee1 = instance.findEmployeeByAge( "John" ,  "Smith" ,  33 );     Person employee2 = instance.findEmployeeByAge( "John" ,  "Smith" ,  33 );       assertEquals(employee1, employee2);   }

       下面的例子我们在findEmployeeBySurname的方法的注解中自定义了key，我们使用了自定义的key生成方式，以确保不同的surname将会指向不同的人。看下面的程序：

?

1 2 3 4 5 6 7 8

@Test   public void testCacheOnSurnameAsKey() {       Person employee1 = instance.findEmployeeBySurname( "John" ,  "Smith" ,  22 );     Person employee2 = instance.findEmployeeBySurname( "Jack" ,  "Smith" ,  55 );       assertEquals(employee1, employee2);   }

       我们想找到两个不同的人，但是两个人的surname是相同的，你将发现两次调用返回了相同的结果，这不是Spring的问题，而是我们的cache key的生成方式有问题。所以在我们定义key的时候要小心注意key的生成策略，避免造成这种问题。

        最后总结一下流程，当执行到一个被@Cacheable注解的方法时，Spring首先检查condition条件是否满足，如果不满足，执行方法，返回；如果满足，在value所命名的缓存空间中查找使用key存储的对象，如果找到，将找到的结果返回，如果没有找到执行方法，将方法的返回值以key-对象的方式存入value缓存中，然后方法返回。

上文仅仅是@Cacheable的使用方法，但是我们怎么使用@CacheEvict注解来清除缓存呢？另外，还有一个问题，如何选择一个缓存的实现，并配置Spring的缓存呢？欲知后事如何，且听下回分解。

缓存注解有以下三个：

@Cacheable      @CacheEvict     @CachePut

 

@Cacheable(value=”accountCache”)，这个注释的意思是，当调用这个方法的时候，会从一个名叫 accountCache 的缓存中查询，如果没有，则执行实际的方法（即查询数据库），并将执行的结果存入缓存中，否则返回缓存中的对象。这里的缓存中的 key 就是参数 userName，value 就是 Account 对象。“accountCache”缓存是在 spring*.xml 中定义的名称。

示例：

 

Java代码  

1. @Cacheable(value="accountCache")// 使用了一个缓存名叫 accountCache   
2. public Account getAccountByName(String userName) {  
3.      // 方法内部实现不考虑缓存逻辑，直接实现业务  
4.      System.out.println("real query account."+userName);   
5.      return getFromDB(userName);   
6. }   

 

 

@CacheEvict 注释来标记要清空缓存的方法，当这个方法被调用后，即会清空缓存。注意其中一个 @CacheEvict(value=”accountCache”,key=”#account.getName()”)，其中的 Key 是用来指定缓存的 key 的，这里因为我们保存的时候用的是 account 对象的 name 字段，所以这里还需要从参数 account 对象中获取 name 的值来作为 key，前面的 # 号代表这是一个 SpEL 表达式，此表达式可以遍历方法的参数对象，具体语法可以参考 Spring 的相关文档手册。

示例：

 

Java代码  

1. @CacheEvict(value="accountCache",key="#account.getName()")// 清空accountCache 缓存    
2. public void updateAccount(Account account) {  
3.      updateDB(account);   
4. }   
5.     
6. @CacheEvict(value="accountCache",allEntries=true)// 清空accountCache 缓存  
7. public void reload() {  
8.      reloadAll()  
9. }  
10.   
11. @Cacheable(value="accountCache",condition="#userName.length() <=4")// 缓存名叫 accountCache   
12. public Account getAccountByName(String userName) {   
13.  // 方法内部实现不考虑缓存逻辑，直接实现业务  
14.  return getFromDB(userName);   
15. }  

 

@CachePut 注释，这个注释可以确保方法被执行，同时方法的返回值也被记录到缓存中，实现缓存与数据库的同步更新。

示例：

 

Java代码  

1. @CachePut(value="accountCache",key="#account.getName()")// 更新accountCache 缓存  
2. public Account updateAccount(Account account) {   
3.    return updateDB(account);   
4. }   

 

@Cacheable、@CachePut、@CacheEvict 注释介绍

通过上面的例子，我们可以看到 spring cache 主要使用两个注释标签，即 @Cacheable、@CachePut 和 @CacheEvict，我们总结一下其作用和配置方法。

表 1. @Cacheable 作用和配置方法

@Cacheable 的作用主要针对方法配置，能够根据方法的请求参数对其结果进行缓存

@Cacheable 主要的参数
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”)

表 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)