如何在 Java Spring Boot 中輕鬆使用 @Cacheable 提高應用效能

文章最後更新於 2024 年 8 月 26 日

內容目錄

1. 什麼是 @Cacheable？

定義與功能

@Cacheable 是 Spring Framework 提供的一個註解，主要用於對方法的返回結果進行快取。當方法被標註為 @Cacheable 後，Spring 會在第一次調用該方法時執行實際的邏輯，並將返回結果存入快取中。隨後的調用將直接從快取中返回結果，而不會再次執行方法，這樣可以顯著提高應用程式的性能。

使用 @Cacheable 可以簡化快取的實現，開發者無需編寫繁瑣的快取邏輯，只需在需要快取的服務方法上添加註解即可。

快取的意義

在當今的應用程式中，數據的存取速度越來越重要。快取技術通過將頻繁訪問的數據保存在內存中，減少了對後端數據庫的訪問次數，從而降低了延遲和負載。以下是快取在現代應用中的幾個重要意義：

提高性能：快取能顯著提高應用的響應速度，特別是對於讀取操作頻繁的場景。
減少資源消耗：減少對數據庫的請求可以降低資源的使用，從而節省成本。
增強可擴展性：有效的快取策略可以使應用在高並發情況下保持穩定。

2. 如何使用 @Cacheable

基本用法

要使用 @Cacheable 註解，只需在目標方法上添加註解，並指定快取的名稱。例如：

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

@Service
public class UserService {

    @Cacheable(value = "users", key = "#userId")
    public User getUserById(Long userId) {
        // 模擬一個耗時的查詢
        simulateDatabaseAccess();
        return userRepository.findById(userId);
    }

    private void simulateDatabaseAccess() {
        try {
            Thread.sleep(3000); // 假設查詢耗時3秒
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

在這個範例中，getUserById 方法的返回結果會被快取在名為 "users" 的快取中，並且使用 userId 作為快取鍵。

參數配置

@Cacheable 提供了一些參數來進一步定制快取行為，例如：

key：自訂快取鍵的生成規則。
condition：定義條件，只有當條件為 true 時才會進行快取。

使用 SpEL（Spring 表達式語言）來自定義鍵的範例如下：

@Cacheable(value = "users", key = "#userId + '_' + #type")
public User getUserByIdAndType(Long userId, String type) {
    // ...
}

在這個示例中，快取鍵由 userId 和 type 組合而成，確保每個不同類型的用戶都會有獨特的快取鍵。

3. 配置快取管理器

Spring Boot 中的快取配置

在 Spring Boot 中，快取管理器可以通過在 application.properties 或 application.yml 文件中進行配置。以下是一些基本的配置示例：

spring.cache.type=simple

這將設定一個簡單的內存快取管理器。

整合其他快取方案

除了內建的快取解決方案，Spring Boot 還支持多種其他快取技術，如 Redis 和 Caffeine。以下是如何整合 Redis 的基本步驟：

在 pom.xml 中添加依賴：

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

在 application.properties 中配置 Redis：

spring.redis.host=localhost
spring.redis.port=6379

使用 @EnableCaching 啟用快取功能：

import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Configuration;

@EnableCaching
@Configuration
public class CacheConfig {
}

這樣，您就可以使用 Redis 作為快取後端。

4. @Cacheable 的進階使用

多級快取

使用 @Cacheable 可以設置多級快取，這對於高性能的應用非常有幫助。例如，您可以先使用本地快取，如果本地快取不存在，再查詢遠端快取（如 Redis）。以下是一個簡單的示例：

@Cacheable(value = "localCache", key = "#userId")
public User getUserFromLocalCache(Long userId) {
    // ...
}

@Cacheable(value = "remoteCache", key = "#userId")
public User getUserFromRemoteCache(Long userId) {
    // ...
}

失效與更新策略

快取的失效策略同樣重要。當數據更改時，舊的快取可能會導致不一致的結果。使用 @CacheEvict 註解可以清除不再需要的快取：

@CacheEvict(value = "users", key = "#userId")
public void updateUser(Long userId, User user) {
    // 更新用戶邏輯
}

這將在更新用戶後自動清除對應的快取。

5. 性能測試與優化

快取效益評估

對於任何快取策略，評估其效益是至關重要的。可以使用 APM（應用性能管理）工具來監控快取命中率，並評估快取的性能提升。例如，您可以比較使用快取前後的響應時間和數據庫訪問次數。

常見性能問題

快取系統中常見的性能問題包括快取穿透、雪崩等。以下是避免這些問題的一些策略：

快取穿透：使用布隆過濾器來避免對不存在的數據進行查詢。
快取雪崩：設置不同的過期時間，防止同一時間大量快取失效。

另外，快取的大小和過期時間的配置也需要根據實際情況進行調整，以達到最佳性能。

6. 實戰案例

簡單範例

以下是一個使用 @Cacheable 的簡單範例，展示如何在一個 Spring Boot 應用中實現快取：

import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

@Service
public class ProductService {

    @Cacheable(value = "products", key = "#productId")
    public Product getProductById(Long productId) {
        // 模擬查詢耗時
        simulateDatabaseAccess();
        return productRepository.findById(productId);
    }

    private void simulateDatabaseAccess() {
        try {
            Thread.sleep(2000); // 假設查詢耗時2秒
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

實際應用場景

@Cacheable 在實際應用中可以應用於各種場景，例如查詢用戶資料、商品列表等。對於經常變化的數據，如即時價格或庫存數量，則需要謹慎使用快取，並確保快取能夠及時更新。

在查詢用戶資料的場景中，使用 @Cacheable 可以極大地提高用戶查詢的性能，減少對數據庫的請求次數，從而提升用戶體驗。

這篇文章介紹了 Java Spring Boot 中 @Cacheable 的基本概念、使用方法、配置管理、進階使用及性能測試等，旨在幫助開發者更好地理解和應用快取技術。希望這些內容能對您的學習和實踐有所幫助！

關於作者

卡哥

我是Oscar (卡哥)，前Yahoo Lead Engineer、高智商同好組織Mensa會員，超過十年的工作經驗，服務過Yahoo關鍵字廣告業務部門、電子商務及搜尋部門，喜歡彈吉他玩音樂，也喜歡投資美股、虛擬貨幣，樂於與人分享交流！