开启缓存@EnableCaching 和使用缓存@Cacheable

梦里梦外; 2023-02-15 12:39 18阅读 0赞

##### springboot中的缓存注解支持Spel表达式，因此这里展示常用的SpEL表达式 #####

###### `SpEL运算符` ######

<table> 
 <thead> 
  <tr> 
   <th>类型</th> 
   <th>运算符</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>关系运算符</td> 
   <td>&lt; ，&gt; ， &lt;= ，&gt;=，==，!=,lt，gt，le，ge，eq，ne</td> 
  </tr> 
  <tr> 
   <td>算数运算符</td> 
   <td>+，-，*，/ ，%，^</td> 
  </tr> 
  <tr> 
   <td>逻辑运算符</td> 
   <td>&amp;&amp;，||，and，or，not，between，instanceof</td> 
  </tr> 
  <tr> 
   <td>条件运算符</td> 
   <td>? : (ternary),? : (elvis)</td> 
  </tr> 
  <tr> 
   <td>正则表达式</td> 
   <td>matches</td> 
  </tr> 
  <tr> 
   <td>其他类型</td> 
   <td>?. ，?[…] ，![…] ，^[…]，$[…]</td> 
  </tr> 
 </tbody> 
</table>

> 在一个springboot项目中通过在入口main方法得类上标注@EnableCaching注解开启springboot的缓存功能

<table> 
 <thead> 
  <tr> 
   <th>名称</th> 
   <th>描述</th> 
   <th>位置</th> 
   <th>示例</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>methodName</td> 
   <td>当前调用的方法名</td> 
   <td>root object</td> 
   <td><code>#root.methodName</code></td> 
  </tr> 
  <tr> 
   <td>method</td> 
   <td>当前被调用的方法</td> 
   <td>root object</td> 
   <td><code>#root.method.name</code></td> 
  </tr> 
  <tr> 
   <td>target</td> 
   <td>当前被调用的目标对象</td> 
   <td>root object</td> 
   <td><code>#root.target</code></td> 
  </tr> 
  <tr> 
   <td>targetClass</td> 
   <td>当前被调用的目标对象类</td> 
   <td>root object</td> 
   <td><code>#root.targetClass</code></td> 
  </tr> 
  <tr> 
   <td>args</td> 
   <td>当前被调用的方法的参数列表</td> 
   <td>root object</td> 
   <td><code>#root.args[0]</code></td> 
  </tr> 
  <tr> 
   <td>caches</td> 
   <td>当前方法调用使用的缓存列表 <code>@Cacheable(value={"cache1","cache1"})</code></td> 
   <td>root object</td> 
   <td><code>#root.cache[0].name</code></td> 
  </tr> 
  <tr> 
   <td>argument name</td> 
   <td>方法参数的名字，可以直接#参数名，也可以使用<code>#p0</code>或<code>#a0</code>的形式，<code>0</code>表示索引下标。</td> 
   <td>evluation context</td> 
   <td><code>#iban</code>、<code>#a0</code>、<code>#p0</code>、<code>#root.args[0]</code></td> 
  </tr> 
  <tr> 
   <td>result</td> 
   <td>方法执行后的放回值<br>（仅当执行之后的判断有效，如<code>unless</code>，<code>cache put</code>的表达式‘cache evict的表达式<code>beforeInvocation=false</code>）</td> 
   <td>evluation context</td> 
   <td><code>#result</code></td> 
  </tr> 
 </tbody> 
</table>

### 1、开启缓存 ###

示例

###### `@EnableCaching` ######

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cache.annotation.EnableCaching;
    
    @SpringBootApplication
    @EnableCaching
    public class DemoApplication { 
        public static void main(String[] args) { 
            SpringApplication.run(DemoApplication.class, args);
        }
    
    }

### 2、使用缓存 ###

###### `@Cacheable` ######

该注解的作用是将方法的返回结果做缓存  
**`在需要缓存的地方使用@Cacheable注解，例如在service中使用`**

默认情况 key就是参数名，key可以指定哪个参数名作为缓存的键

使用方式是`#a0 #p0 #参数名 #root.args[0]`都是指定同一个参数，后面的数字就是选择哪个参数作为键  
`@Cacheable中的方法`  
使用方式都是`@Cacheable(key=xxx, cacheNames={"name1","name2"} ...)`，根据需要添加

//与cacheNames相同，@AliasFor是取别名
        @AliasFor("cacheNames")
        String[] value() default { };
        @AliasFor("value")
        //缓存组件名，数据存在缓存组件中以key:value的形式存储
        String[] cacheNames() default { };
        
    	//与keyGenerator 2选1只能用一个，就是缓存的key
        String key() default "";
    	//key的生成器；可以自己指定key的组件id 与上面的key二选一使用
        String keyGenerator() default "";
    	//指定缓存管理器；或者cacheResolver指定获取解析器
        String cacheManager() default "";
        //
        String cacheResolver() default "";
        //指定符合条件的情况才缓存，例如condition="#id>0"
        String condition() default "";
        /* 否定缓存，当unless指定条件为true，方法返回值就不会被缓存； 可以获取到结果进行判断。 unless="#result==null" */
        String unless() default "";
        //是否使用异步模式
        boolean sync() default false;