Springboot中基于注解使用缓存

骑猪看日落 2024-04-17 06:27 54阅读 0赞

# 一、概述 #

Spring定义了org.springframework.cache.Cache  
和org.springframework.cache.CacheManager接口来统一不同的缓存技术，并支持使用JCache（JSR-107）注解简化我们开发；

1.  Cache接口为缓存的组件规范了定义，包含缓存的各种操作集合；
2.  Cache接口下Spring提供了各种xxxCache的实现；如RedisCache，EhCacheCache ,  
    ConcurrentMapCache等；

1.  每次调用需要缓存功能的方法时，Spring会检查指定参数所指定的目标方法是否  
    已经被调用过；如果有就直接从缓存中获取方法调用后的结果，如果没有就调用方法；  
    并缓存结果后返回给用户。下次调用直接从缓存中获取。
2.  使用Spring缓存抽象时我们需要关注以下两点；

*  确定方法需要被缓存以及他们的缓存策略
 *  从缓存中读取之前缓存存储的数据

# 二、常用注解及其参数 #

> 1.  注解简介

<table> 
 <thead> 
  <tr> 
   <th>注解</th> 
   <th>功能</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>@Cacheable</td> 
   <td>主要针对方法配置，能够根据方法的请求参数对其结果进行缓存</td> 
  </tr> 
  <tr> 
   <td>@CacheEvict</td> 
   <td>清空缓存</td> 
  </tr> 
  <tr> 
   <td>@CachePut</td> 
   <td>对存入缓存的数据进行更新</td> 
  </tr> 
  <tr> 
   <td>@EnableCaching</td> 
   <td>开启基于注解的缓存</td> 
  </tr> 
  <tr> 
   <td>@Caching</td> 
   <td>定义复杂的缓存规则</td> 
  </tr> 
 </tbody> 
</table>

> 1.  @Cacheable/@CachePut/@CacheEvict主要的参数

<table> 
 <thead> 
  <tr> 
   <th>常用参数</th> 
   <th>功能介绍</th> 
   <th>使用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>value/cacheNames</td> 
   <td>缓存的名称，在spring配置文件中定义，必须指定至少一个</td> 
   <td>@Cacheable(value =“user”)或者 @Cacheable(value={“user”,“mycache”};</td> 
  </tr> 
  <tr> 
   <td>key</td> 
   <td>缓存的key，可以为空，如果指定要按照SpEL表达式编写，如果不指定，则缺省按照方法的所有参数进行组合</td> 
   <td>@Cacheable(value = {“user”},key = “#id”)</td> 
  </tr> 
  <tr> 
   <td>condition</td> 
   <td>缓存的条件，可以为空，使用SpEL编写，返回true或者false，只有为true才进行缓存/清除缓存，在调用方法之前之后都能判断</td> 
   <td>@Cacheable(value=“user”,condition="#id&gt;2")</td> 
  </tr> 
  <tr> 
   <td>allEntries(@CacheEvict)</td> 
   <td>是否清空所有缓存内容，缺省为false，如果指定为true，则方法调用后将立即清空所有缓存</td> 
   <td>@CachEvict(value=“user”,allEntries=true)</td> 
  </tr> 
  <tr> 
   <td>beforeInvocation(@CacheEvict)</td> 
   <td>是否在方法执行前就清空，缺省为false，如果指定为true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存</td> 
   <td>@CachEvict(value=“user”，beforeInvocation=true)</td> 
  </tr> 
  <tr> 
   <td>unless(@CachePut)(@Cacheable)</td> 
   <td>用于否决缓存的，不像condition，该表达式只方法执行之后判断，此时可以拿到返回值result进行判断。条件为true不会缓存，fasle才缓存</td> 
   <td>@Cacheable(value=“user”,unless="#result == null")</td> 
  </tr> 
  <tr> 
   <td>sync</td> 
   <td>是否支持异步</td> 
   <td>@Cacheable(value = {“user”},key = “#id”,sync = true)</td> 
  </tr> 
  <tr> 
   <td>keyGenerator</td> 
   <td>指定key的生成策略,不能和key同时使用</td> 
   <td>@Cacheable(value ={“user”},keyGenerator = “myKeyGenerator”)</td> 
  </tr> 
  <tr> 
   <td>cacheManager</td> 
   <td>用来指定缓存管理器</td> 
   <td></td> 
  </tr> 
 </tbody> 
</table>

> 1.  Cache SpEL available metadata(可用的缓存元数据)

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

# 三、简单的使用 #

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>

package com.example.jpa.controller;
    
    import com.example.jpa.entity.User;
    import com.example.jpa.service.UserService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.cache.annotation.*;
    import org.springframework.data.domain.Page;
    import org.springframework.data.domain.PageRequest;
    import org.springframework.web.bind.annotation.*;
    
    import java.util.List;
    
    @RestController
    public class UserController { 
    
        @Autowired
        private UserService userService;
    
        @Cacheable(value = { "user"},key = "#id") //调用方法之前调用
        @GetMapping("/user")
        public User getUserById(@RequestParam Integer id){ 
            return userService.getUserById(id);
        }
    
        @GetMapping("/users")
        public List<User> getAll(){ 
            return userService.getAll();
        }
    
        @Cacheable(value = "user",key = "#pageOffset")
        @GetMapping("/usersByPage")
        public Page<User> getAllByPage(@RequestParam Integer pageOffset,@RequestParam Integer pageSize){ 
            return userService.getAll(PageRequest.of(pageOffset,pageSize));
        }
    
        @CachePut(value = "user",key = "#result.id") //即调用方法又更新缓存数据
        @PostMapping("/user")
        public User saveUser(@RequestBody User user){ 
            return userService.saveUser(user);
        }
    
        //@CachePut(value = "user",key = "#result.id") //即调用方法又更新缓存数据
        @Caching
        @PutMapping("/user")
        public User updateUser(@RequestBody User user){ 
            return userService.updateUser(user);
        }
    
        @CacheEvict(value = "user",key = "#id")
        @DeleteMapping("/user")
        public void deleteUser(Integer id){ 
            userService.deleteUserById(id);
        }
    
    
    }

在这里碰到了一个问题，在更新数据的时候怎么确保分页里面的缓存数据也随之更新而不是返回更新前的数据？