在 Spring Boot 應用中，緩存是提升性能的重要手段之一。為了更方便地使用緩存，我們可以設計一套通用的本地緩存工具類，封裝常見的緩存操作，簡化開發流程。本文將詳細介紹如何設計并實現一套 Spring Boot 本地緩存工具類，并提供完整代碼示例。

---

1. 工具類設計目標

在設計緩存工具類時，我們需要考慮以下目標：

1. 通用性：工具類應支持多種緩存操作，如獲取、添加、更新、刪除等。
2. 易用性：通過簡單的 API 調用即可完成緩存操作，減少重復代碼。
3. 靈活性：支持自定義緩存過期時間、緩存鍵生成策略等。
4. 可擴展性：工具類應易于擴展，支持不同的緩存實現（如 Caffeine、Guava 等）。

---

2. 工具類實現

2.1 添加依賴

首先，在 pom.xml 中添加 Spring Boot 緩存支持的依賴：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency><groupId>com.github.ben-manes.caffeine</groupId><artifactId>caffeine</artifactId>
</dependency>

2.2 啟用緩存

在 Spring Boot 啟動類上添加 @EnableCaching 注解，啟用緩存功能：

@SpringBootApplication
@EnableCaching
public class MyApplication {public static void main(String[] args) {SpringApplication.run(MyApplication.class, args);}
}

2.3 緩存工具類實現

以下是一個通用的本地緩存工具類實現，基于 Spring 的 CacheManager 和 Caffeine 緩存庫：

package com.example.cache;import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;import javax.annotation.Resource;
import java.util.concurrent.Callable;/*** 本地緩存工具類*/
@Component
public class LocalCacheUtil {@Resourceprivate CacheManager cacheManager;/*** 獲取緩存值** @param cacheName 緩存名稱* @param key       緩存鍵* @return 緩存值*/public <T> T get(String cacheName, Object key) {Cache cache = getCache(cacheName);if (cache != null) {Cache.ValueWrapper valueWrapper = cache.get(key);if (valueWrapper != null) {return (T) valueWrapper.get();}}return null;}/*** 獲取緩存值，如果不存在則通過 loader 加載** @param cacheName 緩存名稱* @param key       緩存鍵* @param loader    緩存加載器* @return 緩存值*/public <T> T get(String cacheName, Object key, Callable<T> loader) {Cache cache = getCache(cacheName);if (cache != null) {return cache.get(key, loader);}return null;}/*** 添加緩存** @param cacheName 緩存名稱* @param key       緩存鍵* @param value     緩存值*/public void put(String cacheName, Object key, Object value) {Cache cache = getCache(cacheName);if (cache != null) {cache.put(key, value);}}/*** 刪除緩存** @param cacheName 緩存名稱* @param key       緩存鍵*/public void evict(String cacheName, Object key) {Cache cache = getCache(cacheName);if (cache != null) {cache.evict(key);}}/*** 清空緩存** @param cacheName 緩存名稱*/public void clear(String cacheName) {Cache cache = getCache(cacheName);if (cache != null) {cache.clear();}}/*** 獲取緩存對象** @param cacheName 緩存名稱* @return 緩存對象*/private Cache getCache(String cacheName) {if (!StringUtils.hasText(cacheName)) {throw new IllegalArgumentException("緩存名稱不能為空");}return cacheManager.getCache(cacheName);}
}

---

3. 工具類使用示例

3.1 配置緩存

在 application.yml 中配置 Caffeine 緩存：

spring:cache:type: caffeinecaffeine:spec: maximumSize=1000,expireAfterWrite=10m

3.2 使用工具類

在業務代碼中，可以通過注入 LocalCacheUtil 來使用緩存工具類：

@Service
public class BookService {@Resourceprivate LocalCacheUtil localCacheUtil;/*** 獲取書籍信息*/public Book getBookById(Long id) {// 先從緩存中獲取Book book = localCacheUtil.get("books", id);if (book == null) {// 如果緩存中不存在，則從數據庫加載book = loadBookFromDatabase(id);// 將結果放入緩存localCacheUtil.put("books", id, book);}return book;}/*** 更新書籍信息*/public void updateBook(Book book) {// 更新數據庫updateBookInDatabase(book);// 更新緩存localCacheUtil.put("books", book.getId(), book);}/*** 刪除書籍信息*/public void deleteBookById(Long id) {// 刪除數據庫記錄deleteBookFromDatabase(id);// 刪除緩存localCacheUtil.evict("books", id);}// 模擬從數據庫加載書籍信息private Book loadBookFromDatabase(Long id) {// 這里模擬數據庫查詢return new Book(id, "Spring Boot Guide", "Author Name");}// 模擬更新數據庫private void updateBookInDatabase(Book book) {// 這里模擬數據庫更新}// 模擬刪除數據庫記錄private void deleteBookFromDatabase(Long id) {// 這里模擬數據庫刪除}
}

---

4. 工具類的優勢

1. 簡化緩存操作：通過工具類封裝，業務代碼中只需調用簡單的方法即可完成緩存操作。
2. 統一管理緩存：所有緩存操作都通過工具類進行，便于維護和擴展。
3. 支持多種緩存策略：可以通過配置靈活調整緩存過期時間、最大容量等參數。
4. 易于擴展：如果需要切換緩存實現（如從 Caffeine 切換到 Ehcache），只需修改配置，無需改動業務代碼。

---

5. 總結

本文設計并實現了一套 Spring Boot 本地緩存工具類，通過封裝 Spring 的 CacheManager 和 Caffeine 緩存庫，提供了簡單易用的緩存操作 API。該工具類可以顯著簡化緩存的使用，提升開發效率，同時具備良好的擴展性和靈活性。希望本文能幫助你更好地理解和使用 Spring Boot 中的本地緩存功能。

如果你有任何問題或建議，歡迎在評論區留言討論！