然而,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);
}
|
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);
}
|
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);
}
|
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);
}
|
缓存注解有以下三个:
@Cacheable @CacheEvict @CachePut
@Cacheable(value=”accountCache”),这个注释的意思是,当调用这个方法的时候,会从一个名叫 accountCache 的缓存中查询,如果没有,则执行实际的方法(即查询数据库),并将执行的结果存入缓存中,否则返回缓存中的对象。这里的缓存中的 key 就是参数 userName,value 就是 Account 对象。“accountCache”缓存是在 spring*.xml 中定义的名称。
示例:
- @Cacheable(value="accountCache")// 使用了一个缓存名叫 accountCache
- public Account getAccountByName(String userName) {
- // 方法内部实现不考虑缓存逻辑,直接实现业务
- System.out.println("real query account."+userName);
- return getFromDB(userName);
- }
@CacheEvict 注释来标记要清空缓存的方法,当这个方法被调用后,即会清空缓存。注意其中一个 @CacheEvict(value=”accountCache”,key=”#account.getName()”),其中的 Key 是用来指定缓存的 key 的,这里因为我们保存的时候用的是 account 对象的 name 字段,所以这里还需要从参数 account 对象中获取 name 的值来作为 key,前面的 # 号代表这是一个 SpEL 表达式,此表达式可以遍历方法的参数对象,具体语法可以参考 Spring 的相关文档手册。
示例:
- @CacheEvict(value="accountCache",key="#account.getName()")// 清空accountCache 缓存
- public void updateAccount(Account account) {
- updateDB(account);
- }
- @CacheEvict(value="accountCache",allEntries=true)// 清空accountCache 缓存
- public void reload() {
- reloadAll()
- }
- @Cacheable(value="accountCache",condition="#userName.length() <=4")// 缓存名叫 accountCache
- public Account getAccountByName(String userName) {
- // 方法内部实现不考虑缓存逻辑,直接实现业务
- return getFromDB(userName);
- }
@CachePut 注释,这个注释可以确保方法被执行,同时方法的返回值也被记录到缓存中,实现缓存与数据库的同步更新。
示例:
- @CachePut(value="accountCache",key="#account.getName()")// 更新accountCache 缓存
- public Account updateAccount(Account account) {
- return updateDB(account);
- }
@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) |