Spring Cache 介绍及使用方法

ゞ浴缸里的玫瑰 2024-03-26 19:41 70阅读 0赞

**目录**

一、Spring Cache介绍

1、Spring Cache常用注解

二、Spring Cache使用redis缓存步骤

1、添加依赖

2、添加配置

3、使用注解

--------------------

### 一、Spring Cache介绍 ###

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

功能。Spring Cache提供了一层抽象，底层可以切换不同的cache实现。具体就是CacheManager

接口来统一不同的缓存技术。

CacheManager是Spring提供的各种缓存技术抽象接口。

针对不同的缓存技术需要实现不同的CacheManager:

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>CacheManager</td> 
   <td>描述</td> 
  </tr> 
  <tr> 
   <td>EhcachecacheManager</td> 
   <td>使用EhCache作为缓存技术</td> 
  </tr> 
  <tr> 
   <td>GuavaCacheManager</td> 
   <td>使用Google的GuavaCache作为缓存技术</td> 
  </tr> 
  <tr> 
   <td>RedisCacheManager</td> 
   <td>使用Redis作为缓存技术</td> 
  </tr> 
 </tbody> 
</table>

#### 1、Spring Cache常用注解 ####

<table style="width:500px;"> 
 <tbody> 
  <tr> 
   <td>注解</td> 
   <td>说明</td> 
  </tr> 
  <tr> 
   <td>@EnableCaching</td> 
   <td>开启缓存注解功能</td> 
  </tr> 
  <tr> 
   <td>@Cacheable</td> 
   <td>在方法执行前spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据若没有数据，调用方法并将方法返回值放到缓存中</td> 
  </tr> 
  <tr> 
   <td>@CachePut</td> 
   <td>将方法的返回值放到缓存中</td> 
  </tr> 
  <tr> 
   <td>@CacheEvict</td> 
   <td>将一条或多条数据从缓存中删除</td> 
  </tr> 
 </tbody> 
</table>

在spring boot项目中，使用缓存技术只需在项目中导入相关缓存技术的依赖包，并在启动类上使用

@EnableCaching开启缓存支持即可。

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

### 二、Spring Cache使用redis缓存步骤 ###

#### 1、添加依赖 ####

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

#### 2、添加配置 ####

spring
      redis:
        host: 172.17.2.94  #ip地址
        port: 6379         #端口
        password: root@123456  #redis密码
        database: 0        #指定数据库
      cache:
        redis:
          time-to-live: 1800000 #设置缓存过期时间，可选

#### 3、使用注解 ####

**启动类加注解：@EnableCaching**

@Slf4j
    @SpringBootApplication
    @EnableCaching
    public class CacheDemoApplication {
        public static void main(String[] args) {
            SpringApplication.run(CacheDemoApplication.class,args);
            log.info("项目启动成功...");
        }
    }

**注解** **@CachePut：将方法返回值放入缓存**

/**
         * CachePut：将方法返回值放入缓存
         * value：缓存的名称，每个缓存名称下面可以有多个key
         * key：缓存的key
         */
        //@CachePut(value = "userCache",key = "#result.id")//result带表返回值
        @CachePut(value = "userCache",key = "#user.id")//可以直接获取参数，参数名要保持一致
        @PostMapping
        public User save(User user){
            userService.save(user);
            return user;
        }

key支持Spring的表达式语言，可以动态计算key值，通过\#来获取，通常使用直接\#+参数

result：表示返回值，可以通过获取返回值获取key

![04ab33d6f0a4412f9433abde91a92ced.png][]

**注解 @CacheEvict：清理指定缓存**

/**
         * CacheEvict：清理指定缓存
         * value：缓存的名称，每个缓存名称下面可以有多个key
         * key：缓存的key
         */
        @CacheEvict(value = "userCache",key = "#p0")//p固定写法，0表示下表，第一个参数
        //@CacheEvict(value = "userCache",key = "#root.args[0]")//固定写法，0表示下表，第一个参数
        //@CacheEvict(value = "userCache",key = "#id")//直接获取参数
        @DeleteMapping("/{id}")
        public void delete(@PathVariable Long id){
            userService.removeById(id);
        }

//@CacheEvict(value = "userCache",key = "#p0.id")//p0第一个参数，id参数的属性
        //@CacheEvict(value = "userCache",key = "#user.id")//直接获取参数属性
        //@CacheEvict(value = "userCache",key = "#root.args[0].id")//获取第一个参数，id参数的属性
        @CacheEvict(value = "userCache",key = "#result.id")//从返回值获取
        @PutMapping
        public User update(User user){
            userService.updateById(user);
            return user;
        }

**注解 @Cacheable：在方法执行前spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据若没有数据，调用方法并将方法返回值放到缓存中**

/**
         * Cacheable：在方法执行前spring先查看缓存中是否有数据，如果有数据，则直接返回缓存数据；若没有数据，调用方法并将方法返回值放到缓存中
         * value：缓存的名称，每个缓存名称下面可以有多个key
         * key：缓存的key
         * condition：条件，满足条件时才缓存数据
         * unless：满足条件则不缓存
         */
        @Cacheable(value = "userCache",key = "#id",unless = "#result == null")
        @GetMapping("/{id}")
        public User getById(@PathVariable Long id){
            User user = userService.getById(id);
            return user;
        }
    
        @Cacheable(value = "userCache",key = "#user.id + '_' + #user.name")//动态拼接key
        @GetMapping("/list")
        public List<User> list(User user){
            LambdaQueryWrapper<User> queryWrapper = new LambdaQueryWrapper<>();
            queryWrapper.eq(user.getId() != null,User::getId,user.getId());
            queryWrapper.eq(user.getName() != null,User::getName,user.getName());
            List<User> list = userService.list(queryWrapper);
            return list;
        }

[04ab33d6f0a4412f9433abde91a92ced.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/26/8eaf4b0bb07d40ebab360e253a38874e.png