spring缓存注解@Cache

╰半橙微兮° 2022-07-19 05:28 239阅读 0赞

缓存注解有以下三个：

@Cacheable      @CacheEvict     @CachePut

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

**示例：**

Java代码   ![收藏代码][icon_star.png]

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代码   ![收藏代码][icon_star.png]

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代码   ![收藏代码][icon_star.png]

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 的作用 主要针对方法配置，能够根据方法的请求参数对其结果进行缓存

##### 表 2. @CachePut 作用和配置方法 #####

@CachePut 的作用 主要针对方法配置，能够根据方法的请求参数对其结果进行缓存，和 @Cacheable 不同的是，它每次都会触发真实方法的调用

##### 表 3. @CacheEvict 作用和配置方法 #####

@CachEvict 的作用 主要针对方法配置，能够根据一定的条件对缓存进行清空

<table style="font-size:13px; margin:0px 0px 20px; padding:0px; vertical-align:baseline; border-collapse:collapse; border-bottom-width:1px; border-bottom-style:solid; border-bottom-color:rgb(204,204,204); border-left-width:0px; border-left-style:none; border-right-width:0px; border-right-style:none; font-family:Arial,sans-serif; line-height:15.36px; height:358px; width:780px!important"> 
 <tbody> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline; border-width:1px 0px 0px; border-style:solid none none; border-top-color:rgb(221,221,221)"></tr> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline"> 
   <td style="font-size:undefined; margin:0px; padding:8px 10px 5px 3px; vertical-align:top; border-left-width:0px; border-left-style:none; border-top-width:2px; border-top-style:solid; border-top-color:rgb(153,153,153); color:rgb(85,85,85); border-right-width:0px; border-right-style:none; text-align:center"> <span style="margin:0px; padding:0px; border:0px; font-size:undefined; vertical-align:baseline">@CacheEvict 主要的参数</span></td> 
  </tr> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline"> 
   <td style="font-size:undefined; margin:0px; padding:8px 10px 5px 3px; vertical-align:top; border-left-width:0px; border-left-style:none; border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> value</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 缓存的名称，在 spring 配置文件中定义，必须指定至少一个</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 例如：<br> @CachEvict(value=”mycache”) 或者&nbsp;<br> @CachEvict(value={”cache1”,”cache2”}</td> 
  </tr> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline"> 
   <td style="font-size:undefined; margin:0px; padding:8px 10px 5px 3px; vertical-align:top; border-left-width:0px; border-left-style:none; border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> key</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 例如：<br> @CachEvict(value=”testcache”,key=”#userName”)</td> 
  </tr> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline"> 
   <td style="font-size:undefined; margin:0px; padding:8px 10px 5px 3px; vertical-align:top; border-left-width:0px; border-left-style:none; border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> condition</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才清空缓存</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 例如：<br> @CachEvict(value=”testcache”,<br> condition=”#userName.length()&gt;2”)</td> 
  </tr> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline"> 
   <td style="font-size:undefined; margin:0px; padding:8px 10px 5px 3px; vertical-align:top; border-left-width:0px; border-left-style:none; border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> allEntries</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 例如：<br> @CachEvict(value=”testcache”,allEntries=true)</td> 
  </tr> 
  <tr style="margin:0px; padding:0px; font-size:undefined; vertical-align:baseline"> 
   <td style="font-size:undefined; margin:0px; padding:8px 10px 5px 3px; vertical-align:top; border-left-width:0px; border-left-style:none; border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> beforeInvocation</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存</td> 
   <td style="font-size:undefined; margin:0px; padding:8px 5px 5px 3px; vertical-align:top; border-left-width:3px; border-left-style:solid; border-left-color:rgb(255,255,255); border-top-width:1px; border-top-style:solid; border-top-color:rgb(221,221,221); color:rgb(85,85,85); border-right-width:0px; border-right-style:none"> 例如：<br> @CachEvict(value=”testcache”，beforeInvocation=true)<br> </td> 
  </tr> 
 </tbody> 
</table>

分享到：  ![sina.jpg][]

[icon_star.png]: /images/20220718/097e355e1e2a4123b97f7d80d743ee0f.png
[sina.jpg]: /images/20220718/3394f8f37782463387d7bcd03e5180ff.png