SpringBoot詳解整合Spring Cache實現Redis緩存流程

Posted on by

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("套餐修改成功");
}

4、測試

代碼編寫完成之後,重啟工程,然後訪問後臺管理系統,對套餐數據進行新增以及刪除，而後觀察Redis中的數據發現寫的代碼是能正常跑到！成功！

到此這篇關於SpringBoot詳解整合Spring Cache實現Redis緩存流程的文章就介紹到這瞭,更多相關SpringBoot Redis緩存內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：