SpringBoot詳解整合Spring Cache實現Redis快取流程

2022-07-05 10:00:16

1、簡介

Spring Cache 是一個框架，實現了基於註解的快取功能，只需要簡單地加一個註解，就能實現快取功能。

Spring Cache 提供了一層抽象，底層可以切換不同的cache實現。

具體就是通過 CacheManager 介面來統一不同的快取技術。

CacheManager 是 Spring 提供的各種快取技術抽象介面，這是預設的快取技術，是快取在Map中的，這也說明當服務掛掉的時候，快取的資料就沒了。

針對不同的快取技術需要實現不同的 CacheManager

CacheManager	描述
EhCacheCacheManager	使用 EhCache 作為快取技術
GuavaCacheManager	使用 Google 的 GuavaCache 作為快取技術
RedisCacheManager	使用 Redis 作為快取技術

2、常用註解

在 Spring Boot 專案中，使用快取技術只需在專案中匯入相關快取技術的依賴包，並在啟動類上使用 @EnableCaching 開啟快取支援即可。例如，使用 Redis 作為快取技術，只需要匯入 Spring data Redis 的 maven 座標即可。常用的註解有如下幾個：

註解	說明
@EnableCaching	開啟快取註解功能
@Cacheable	在方法執行前 spring 先檢視快取中是否有資料，如果有資料，則直接返回快取資料;若沒有資料，呼叫方法並將方法返回值放到快取中
@CachePut	將方法的返回值放到快取中
@CacheEvict	將一條或多條資料從快取中刪除

2.1、@EnableCaching

該註解的主要功能就是開啟快取註解的功能，讓 Spring Cache 中的其他註解生效。使用方式也十分簡單，直接將其加在專案的啟動類上方即可。

@Slf4j
@SpringBootApplication
@EnableCaching
public class CacheDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(CacheDemoApplication.class, args);
        log.info("專案啟動成功...");
    }
}

2.2、@Cacheable

@Cacheable註解主要是在方法執行前先檢視快取中是否有資料。如果有資料，則直接返回快取資料；若沒有資料，呼叫方法並將方法返回值放到快取中。

註解中的引數傳遞主要使用的是**SpEL（Spring Expression Language）**對資料進行獲取傳遞，這有點類似於JSP中的EL表示式，常用方式如下幾種：

“#p0”：獲取參數列中的第一個引數。其中的“#p”為固定寫法，0為下標，代表第一個；
“#root.args[0]”：獲取方法中的第一個引數。其中0為下標，代表第一個。
“#user.id”：獲取引數 user 的 id 屬性。注意的是這裡的 user 必須要和參數列中的引數名一致
“#result.id”：獲取返回值中的 id 屬性。

來自Spring Cache原始碼：Spring Expression Language (SpEL) expression used for making the method

在@Cacheable註解中有幾種常用的屬性可進行需求性設定：

value：快取的名稱，每個快取名稱下面可以有多個 key
key：快取的key。
condition：條件判斷，滿足條件時對資料進行快取，值得注意的是該引數在Redis中無效
unless：條件判斷，滿足條件時則不對資料進行快取，Redis中可使用該引數替代condition

/**
 * @description 通過id獲取使用者資訊
 * @author xBaozi
 * @date 14:23 2022/7/3
 **/
@Cacheable(value = "userCache", key = "#id", unless = "#result == null")
@GetMapping("/{id}")
public User getById(@PathVariable Long id) {
    User user = userService.getById(id);
    return user;
}

2.3、@CachePut

@CachPut註解主要是將方法的返回值放到快取中。這裡同樣是使用SpEL獲取資料，常用的屬性如下：

value：快取的名稱，每個快取名稱下面可以有多個 key
key：快取的key。
condition：條件判斷，滿足條件時對資料進行快取，值得注意的是該引數在Redis中無效
unless：條件判斷，滿足條件時則不對資料進行快取，Redis中可使用該引數替代condition

/**
 * @description 新增使用者資訊並返回儲存的資訊
 * @author xBaozi
 * @date 14:38 2022/7/3
 **/
@CachePut(value = "userCache", key = "#user.id")
@PostMapping
public User save(User user) {
    userService.save(user);
    return user;
}

2.4、@CacheEvict

@CacheeEvict主要是將一條或多條資料從快取中刪除，同樣使用SpEL獲取資料，常用的屬性如下：

value：快取的名稱，每個快取名稱下面可以有多個 key
key：快取的key。
condition：條件判斷，滿足條件時對資料進行快取，值得注意的是該引數在Redis中無效
unless：條件判斷，滿足條件時則不對資料進行快取，Redis中可使用該引數替代condition

/**
 * @description 更新使用者資訊
 * @author xBaozi
 * @date 14:41 2022/7/3
 **/
@CacheEvict(value = "userCache", key = "#result.id")
@PutMapping
public User update(User user) {
    userService.updateById(user);
    return user;
}

3、使用Redis當作快取產品

因為 Spring 預設的快取技術無法持久化儲存快取資料，即服務掛了快取也掛了，因此就需要使用Redis進行操作（其實也是因為學習了Redis）

前面的SpringBoot整合Redis快取驗證碼裡面有記錄著一些Redis的基本操作。

3.1、座標匯入

匯入 maven 座標：spring-boot-starter-data-redis、spring-boot-starter-cache

<!--Spring Data Redis-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!--Spring Cache-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

3.2、yml設定

spring:
redis:
host: localhost
port: 6379
password: 123456
database: 0
cache:
redis:
time-to-live: 1800000 # 設定快取有效期

3.3、開啟註解功能

在啟動類 com/itheima/CacheDemoApplication.java 上加入 @EnableCaching 註解，開啟快取註解功能

@Slf4j
@SpringBootApplication
@ServletComponentScan
@EnableCaching
public class ReggieApplication {
    public static void main(String[] args) {
        SpringApplication.run(ReggieApplication.class, args);
        log.info("springBoot專案啟動成功……");
    }
}

3.4、使用@Cacheable

這裡提一下有個坑就是使用的快取時，返回值必須實現 Serializable 序列化介面，否則將會報錯。

這是因為在 NoSql 資料庫中，並沒有與我們 Java 基本型別對應的資料結構，所以在往 NoSql 資料庫中儲存時，我們就必須將物件進行序列化，同時在網路傳輸中我們要注意到兩個應用中 javabean 的 serialVersionUID 要保持一致，不然就不能正常的進行反序列化。

/**
 * @description 新增套餐資訊
 * @author xBaozi
 * @date 17:55 2022/5/13
 * @param setmealDto    需要新增套餐的資料
 **/
@CacheEvict(value = "setmealCache",allEntries = true)
@PostMapping
public Result<String> save(@RequestBody SetmealDto setmealDto) {
    log.info("套餐資訊為{}", setmealDto);
    setmealService.saveWithDish(setmealDto);
    return Result.success("套餐" + setmealDto.getName() + "新增成功");
}

3.5、使用@CacheEvict

這裡用到了一個新屬性allEntries，其是boolean型別，表示是否需要清除快取中的所有元素。預設為false，表示不需要。當指定了 allEntries 為 true 時，Spring Cache將忽略指定的 key。有的時候我們需要 Cache 一下清除所有的元素，這比一個一個清除元素更有效率。

/**
 * @description 更新套餐資訊並更新其關聯的菜品
 * @author xBaozi
 * @date 11:28 2022/5/14
 * @param setmealDto    需要更新的套餐資訊
 **/
@CacheEvict(value = "setmealCache",allEntries = true)
@PutMapping
public Result<String> updateWithDish(@RequestBody SetmealDto setmealDto) {
    log.info(setmealDto.toString());
    setmealService.updateWithDish(setmealDto);
    return Result.success("套餐修改成功");
}