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注解来保证缓存写操作的原子性。