CaffeineCacheManager使用詳解

一、介紹

CaffeineCacheManager是Spring Framework提供的一個緩存管理工具，它基於Caffeine實現，是一個高效的緩存管理工具。

相比於傳統的緩存，如ConcurrentHashMap，Caffeine支持更多的緩存策略，並且可以非常容易地進行配置和擴展。

CaffeineCacheManager支持將數據存儲在本地內存中，也可以與Redis等外部緩存系統進行集成。

二、使用方法

1. 添加依賴

在Maven項目中使用CaffeineCacheManager需要添加以下依賴：

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

<dependency>
    <groupId>com.github.ben-manes.caffeine</groupId>
    <artifactId>caffeine</artifactId>
    <version>2.7.0</version>
</dependency>

2. 配置CaffeineCacheManager

在Spring Boot項目中，可以通過application.properties進行配置。以下是一個簡單的配置示例：

spring.cache.type=caffeine
spring.cache.cache-names=users,products
spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s

其中：

spring.cache.type定義了緩存類型，這裡設置為caffeine。

spring.cache.cache-names定義了緩存名稱，可以定義多個緩存。上面的例子中定義了兩個緩存：users和products。

spring.cache.caffeine.spec定義了緩存策略。這裡的策略是：最大緩存數量為500，緩存時間為600秒。

3. 在代碼中使用緩存

在Spring Boot項目中，可以使用@Cacheable，@CachePut和@CacheEvict等註解來使用緩存。

3.1 @Cacheable

使用@Cacheable註解可以將方法的返回值緩存到指定的緩存中。

以下是一個示例：

@Service
public class UserService {
    @Cacheable("users")
    public User getUserById(Long id) {
        User user = userRepository.findUserById(id);
        return user;
    }
}

以上代碼會將getUserById方法返回的User對象緩存到名為“users”的緩存中。第一次調用getUserById時，會從數據源中獲取User對象，返回後會將該對象緩存到“users”緩存中。

當再次調用getUserById方法時，如果參數相同，會直接從緩存中獲取緩存的User對象，不會再次查詢數據源。

3.2 @CachePut

使用@CachePut註解可以將方法的返回值更新到指定的緩存中。

以下是一個示例：

@Service
public class UserService {
    @CachePut("users")
    public User updateUserById(Long id, User user) {
        userRepository.updateUserById(id, user);
        return user;
    }
}

以上代碼會將updateUserById方法返回的User對象更新到名為“users”的緩存中。第一次調用updateUserById時，會更新數據源中的User對象，並將該對象更新到“users”緩存中。

當再次調用getUserById方法時，如果參數相同，會直接從緩存中獲取緩存的User對象，不會再次更新數據源。

3.3 @CacheEvict

使用@CacheEvict註解可以將指定的緩存清空。

以下是一個示例：

@Service
public class UserService {
    @CacheEvict("users")
    public void deleteUserById(Long id) {
        userRepository.deleteUserById(id);
    }
}

以上代碼會清空名為“users”的緩存。當調用deleteUserById方法時，會從數據源中刪除對應的User對象，並將“users”緩存中對應的緩存清空。

3.4 自定義key生成器

在使用緩存時，默認的key生成器是根據方法參數和返回值生成的。如果需要自定義key生成器，可以實現KeyGenerator接口。

以下是一個示例：

public class MyKeyGenerator implements KeyGenerator {
    @Override
    public Object generate(Object target, Method method, Object... params) {
        String key = method.getName() + "_" + params[0];
        return key;
    }
}

以上實現了一個簡單的key生成器，生成的key為“方法名_第一個參數的值”。

在使用緩存時，可以通過@Cacheable等註解的keyGenerator屬性指定自定義的key生成器。

以下是一個示例：

@Service
public class UserService {
    @Cacheable(value = "users", keyGenerator = "myKeyGenerator")
    public User getUserById(Long id) {
        User user = userRepository.findUserById(id);
        return user;
    }
}

以上代碼中的value屬性指定了緩存的名稱，keyGenerator屬性指定了自定義的key生成器。

3.5 自定義緩存管理器

除了使用默認的CaffeineCacheManager外，我們還可以自定義緩存管理器來實現更多的緩存策略。

以下是一個示例：

@Configuration
@EnableCaching
public class CacheConfig {
    @Bean
    public CacheManager cacheManager() {
        SimpleCacheManager cacheManager = new SimpleCacheManager();
        List<Cache> caches = new ArrayList();
        caches.add(new MyCache());
        caches.add(new MyOtherCache());
        cacheManager.setCaches(caches);
        return cacheManager;
    }
}

public class MyCache implements Cache {
    @Override
    public String getName() {
        return "myCache";
    }

    @Override
    public Object getNativeCache() {
        return null;
    }

    @Override
    public ValueWrapper get(Object key) {
        // ...
    }

    @Override
    public <T> T get(Object key, Class<T> type) {
        // ...
    }

    @Override
    public void put(Object key, Object value) {
        // ...
    }

    @Override
    public void evict(Object key) {
        // ...
    }

    @Override
    public void clear() {
        // ...
    }
}

以上代碼實現了自定義的緩存管理器MyCache，並且在CacheConfig中將該管理器加入到了緩存管理器中。

注意，緩存管理器需要實現CacheManager接口，緩存需要實現Cache接口。

三、注意事項

1. 內存佔用和緩存數量

CaffeineCacheManager默認使用強引用緩存，這意味着存儲在緩存中的數據對象如果沒有被使用，仍會佔用內存。

如果需要在指定時間（例如5分鐘）內自動清除不被使用的緩存對象，可以在配置中添加expireAfterAccess或expireAfterWrite選項。

另外，由於CaffeineCacheManager默認最大緩存數量為10000個，如果超過這個數量，Caffeine會使用LRU（最近最少使用）算法清除不活躍的緩存對象。

2. 緩存策略

CaffeineCacheManager支持多種緩存策略，如：最大緩存數量、最大緩存時間、緩存是否可以為null等。

參考Caffeine的文檔可以找到更多的緩存策略選項。

3. 多線程並發問題

CaffeineCacheManager的緩存是線程安全的，但是如果要加鎖控制緩存讀寫，可以使用Spring的@CachePut註解來保證緩存寫操作的原子性。