深入理解Spring缓存注解：@Cacheable与@CacheEvict

news2025/5/12 2:51:28

在现代应用程序开发中，缓存是提升系统性能的重要手段。Spring框架提供了一套简洁而强大的缓存抽象，其中@Cacheable和@CacheEvict是两个最常用的注解。本文将深入探讨这两个注解的工作原理、使用场景以及最佳实践。

1. @Cacheable注解

基本概念

@Cacheable注解用于标记方法的返回值应该被缓存。当方法首次被调用时，Spring会执行方法并将返回值存入指定的缓存中；后续调用时，如果缓存中存在相应数据，则直接返回缓存值而不执行方法。

基本用法

@Cacheable("books")
public Book findBookByIsbn(String isbn) {
    // 从数据库或其他数据源获取书籍信息
    return bookRepository.findByIsbn(isbn);
}

关键属性

value/cacheNames：指定缓存名称，可以指定多个
key：自定义缓存键的生成策略
condition：基于方法参数的缓存条件
unless：基于返回值的缓存条件
keyGenerator：自定义键生成器
cacheManager：指定缓存管理器
cacheResolver：自定义缓存解析器

示例：带条件的缓存

@Cacheable(value = "books", key = "#isbn", unless = "#result == null")
public Book findBookByIsbn(String isbn) {
    return bookRepository.findByIsbn(isbn);
}

2. @CacheEvict注解

基本概念

@CacheEvict用于从缓存中移除已存储的数据。通常在数据更新或删除操作时使用，确保缓存与数据源保持一致。

基本用法

@CacheEvict(value = "books", key = "#isbn")
public void updateBook(Book book) {
    bookRepository.update(book);
}

关键属性

value/cacheNames：指定要清除的缓存名称
key：指定要清除的缓存键
condition：清除缓存的条件
allEntries：是否清除缓存中的所有条目（默认为false）
beforeInvocation：是否在方法执行前清除缓存（默认为false）

示例：清除所有缓存条目

@CacheEvict(value = "books", allEntries = true)
public void reloadAllBooks() {
    // 重新加载所有书籍数据
}

3. @Cacheable与@CacheEvict的协同工作

在实际应用中，这两个注解通常需要配合使用：

@Service
public class BookService {

    @Cacheable("books")
    public Book getBook(String isbn) {
        // 从数据库获取
    }

    @CacheEvict(value = "books", key = "#book.isbn")
    public void updateBook(Book book) {
        // 更新数据库
    }
    
    @CacheEvict(value = "books", allEntries = true)
    public void clearCache() {
        // 仅清除缓存，不执行其他操作
    }
}

4. 高级用法与最佳实践

自定义键生成

@Cacheable(value = "books", keyGenerator = "customKeyGenerator")
public Book findBook(BookQuery query) {
    // ...
}

多缓存操作

@Caching(
    evict = {
        @CacheEvict(value = "books", key = "#book.isbn"),
        @CacheEvict(value = "authors", key = "#book.author.id")
    }
)
public void updateBook(Book book) {
    // ...
}