Spring Cache使用

在我们查询部门数据的时候，特别是树形结构，要把所有的属性结构数据都展示出来，这个是会对数据库的访问造成一定的压力，并且从数据库查询效率也不是很高，所以我们通常都会添加缓存来提升效率

添加缓存的基本逻辑：

关于缓存的添加，我们可以直接使用redis来管理缓存，不过一般企业开发中，我们更多的是使用统一管理缓存的框架来实现，主要是更加的低耦合，并且切换缓存的成本的很低

1.  介绍

Spring Cache 是一个框架，实现了基于注解的缓存功能，只需要简单地加一个注解，就能实现缓存功能。

Spring Cache 提供了一层抽象，底层可以切换不同的缓存实现，例如：

• EHCache

• Caffeine

• Redis(常用)

2.常用注解

在SpringCache中提供了很多缓存操作的注解，常见的是以下几个：

注解	说明
@EnableCaching	开启缓存注解功能，通常加在启动类上
@Cacheable	在方法执行前先查询缓存中是否有数据，如果有数据，则直接返回缓存数据；如果没有缓存数据，调用方法并将方法返回值放到缓存中
@CachePut	将方法的返回值放到缓存中
@CacheEvict	将一条或多条数据从缓存中删除
@Caching	缓存的结合体，可以组合以上注解在一个方法中使用，比如有新增，有删除

在spring boot项目中，使用缓存技术只需在项目中导入相关缓存技术的依赖包，并在启动类上使用@EnableCaching开启缓存支持即可。

例如，使用Redis作为缓存技术，只需要导入Spring data Redis的maven坐标即可。

3. 入门案例

   3.1 项目在实现Redis缓存上导入spring cache 依赖

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

   3.2  在启动类上添加@EnableCaching注解用于开启缓存

4. Spring  Cache注解

   4.1 @CachePut注解

• 作用: 将方法返回值，放入缓存

• value: 缓存的名称, 每个缓存名称下面可以有很多key

• key: 缓存的key ----------> 支持Spring的表达式语言SPEL语法

在save方法上加注解@CachePut

当前UserController的save方法是用来保存用户信息的，我们希望在该用户信息保存到数据库的同时，也往缓存中缓存一份数据，我们可以在save方法上添加注解 @CachePut，用法如下：

    /**
    * CachePut：将方法返回值放入缓存
    * value：缓存的名称，每个缓存名称下面可以有多个key
    * key：缓存的key
    */
    @PostMapping
    @CachePut(value = "userCache", key = "#user.id")//key的生成：userCache::1
    public User save(@RequestBody User user){
        userMapper.insert(user);
        return user;
    }

说明：key的写法如下

• #user.id : #user指的是方法形参的名称, id指的是user的id属性 , 也就是使用user的id属性作为key ;

• #result.id : #result代表方法返回值，该表达式 代表以返回对象的id属性作为key ；

• #p0.id：#p0指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key

• #a0.id：#a0指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key

• #root.args[0].id:#root.args[0]指的是方法中的第一个参数，id指的是第一个参数的id属性,也就是使用第一个参数的id属性作为key ;

启动服务,通过swagger接口文档测试，访问UserController的save()方法

因为id是自增，所以不需要设置id属性

我们现在分别查看用户表和缓存中的数据，如果都能保存，则说明集成成功

   4.2 @Cacheable注解

作用: 在方法执行前，spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据；若没有数据，调用方法并将方法返回值放到缓存中

• value: 缓存的名称，每个缓存名称下面可以有多个key

• key: 缓存的key ----------> 支持Spring的表达式语言SPEL语法

在UserController上找到getById，添加注解@Cacheable

     /**
    * Cacheable：在方法执行前spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据；若没有数据，      *调用方法并将方法返回值放到缓存中
    * value：缓存的名称，每个缓存名称下面可以有多个key
    * key：缓存的key
    */
    @GetMapping
    @Cacheable(cacheNames = "userCache",key="#id")
    public User getById(Long id){
        User user = userMapper.getById(id);
        return user;
    }

重启服务,通过swagger接口文档测试，访问UserController的getById()方法

第一次访问，会请求我们controller的方法，查询数据库。后面再查询相同的id，就直接从Redis中查询数据，不用再查询数据库了，就说明缓存生效了。

测试步骤：

• 提前在redis中手动删除掉id=${id}的用户数据

• 查看控制台sql语句：说明从数据库查询的用户数据

• 查看Redis中的缓存数据：说明已成功缓存

• 再次查询相同id的数据时，直接从redis中直接获取，不再查询数据库。

多条件使用案例

@Cacheable(value = "userCache",key="#userDto.hashCode()",unless = "#result.size() == 0")
public List<User> getList(UserDto userDto){
    List<User> list = userMapper.getList("%" + userDto.getName() + "%", userDto.getAge());
    return list;
}

如果返回结果为空，则不缓存unless = "#result == null"或unless = "#result.size() == 0"

4.3 @CacheEvict注解

• 作用: 清理指定缓存

• value: 缓存的名称，每个缓存名称下面可以有多个key

• key: 缓存的key ----------> 支持Spring的表达式语言SPEL语法

在 delete 方法上加注解@CacheEvict

    @DeleteMapping
    @CacheEvict(cacheNames = "userCache",key = "#id")//删除某个key对应的缓存数据
    public void deleteById(Long id){
        userMapper.deleteById(id);
    }
​
    @DeleteMapping("/delAll")
    @CacheEvict(cacheNames = "userCache",allEntries = true)//删除userCache下所有的缓存数据
    public void deleteAll(){
        userMapper.deleteAll();
    }

重启服务,通过swagger接口文档测试，访问UserController的deleteAll()方法

查看数据库和缓存是否删除了数据

4.4 @Caching注解

作用: 组装其他缓存注解

• cacheable 组装一个或多个@Cacheable注解

• put 组装一个或多个@CachePut注解

• evict 组装一个或多个@CacheEvict注解

我们可以修改getById方法，下面就使用@Caching组装使用了多种注解

@Caching(
        cacheable = {
                @Cacheable(value = "userCache",key = "#id")
        },
        put = {
                @CachePut(value = "userCache",key = "#result.name"),
                @CachePut(value = "userCache",key = "#result.age")
        }
)
public User getById(Long id){
    User user = userMapper.getById(id);
    if(user == null){
        throw new RuntimeException("用户不存在");
    }
    return user;
}

当调用getById方法之后，首先到缓存中根据id查询数据，如果查询不成功还是会到数据库中找数据，同时会再往redis中set两个缓存，key分别是name和age