Spring cache注解：缓存与业务解耦实战

Spring缓存机制通过@EnableCaching开启，配合@Cacheable、@CachePut、@CacheEvict等注解，为Java应用提供了一种声明式管理缓存的方式。这些注解使得缓存配置变得简洁明了，允许开发者轻松实现数据的自动缓存、更新和清除，从而优化应用性能，减少不必要的计算和数据访问开销。

1. 启用缓存支持

@EnableCaching

• 注解作用介绍

@EnableCaching 注解用于在Spring配置类上启用缓存管理功能。

• 注解属性介绍

无属性。

• 注解业务案例

@Configuration
@EnableCaching
public class CacheConfig {// 配置其他Bean
}

2. 缓存结果

@Cacheable

• 注解作用介绍

@Cacheable 注解用于声明一个方法的结果是可缓存的。

• 注解属性介绍
  • value 或 cacheNames: 指定缓存名称，可以是单个或多个。
  • key: 指定缓存键的SpEL表达式。
  • condition: 指定缓存的条件SpEL表达式。
  • unless: 指定不缓存的条件SpEL表达式。
• 注解业务案例 单一缓存名称和键：

@Cacheable("books")
public Book findBookById(String id) {// 业务逻辑
}

多个缓存名称和条件：

@Cacheable(value = {"books", "archivedBooks"}, condition = "#id.length() > 10")
public Book findBookWithComplexKey(String id) {// 业务逻辑
}@Service
public class MyService {/*** 一个使用 @Cacheable 所有属性的案例。* * @param id 用户ID* @return 返回用户对象*/@Cacheable(value = "users",          // 缓存名称key = "#id",              // 缓存键，使用SpEL表达式condition = "#id.length() > 3",  // 缓存条件，只有当ID长度大于3时才缓存unless = "#result == null" // 除非条件，如果结果为null，则不缓存)public User findUserById(String id) {// 模拟数据库查询操作，这里假设ID长度小于3时没有结果if (id == null || id.length() <= 3) {return null;}return performDatabaseQuery(id);}private User performDatabaseQuery(String id) {// 模拟数据库查询逻辑return new User(id, "Name based on ID");}
}

3. 更新缓存

@CachePut

• 注解作用介绍

@CachePut 注解用于在方法执行后更新缓存。

• 注解属性介绍

与@Cacheable相同。

• 注解业务案例

@CachePut("books")
public Book updateBookDetails(String id, Book details) {// 业务逻辑
}@Service
public class MyService {/*** 使用 @CachePut 所有属性的案例。** @param user 用户对象，包含ID* @return 更新后的用户对象*/@CachePut(value = "users",      // 缓存名称key = "#user.id",     // 缓存键，使用SpEL表达式condition = "#user.age > 18"  // 条件，只有当用户年龄大于18时才更新缓存)public User updateUserProfile(User user) {// 模拟更新用户信息的业务逻辑return performUpdate(user);}private User performUpdate(User user) {// 模拟更新逻辑user.setName("Updated Name");return user;}
}

4. 清除缓存

@CacheEvict

• 注解作用介绍

@CacheEvict 注解用于在方法执行后清除缓存。

• 注解属性介绍
  • value 或 cacheNames: 指定缓存名称，可以是单个或多个。
  • allEntries: 清除所有缓存项。
  • condition: 指定清除缓存的条件SpEL表达式。
• 注解业务案例

清除特定缓存名称的条目：

@CacheEvict("books")
public void deleteBook(String id) {// 业务逻辑
}

清除所有缓存名称的所有条目：

@CacheEvict(allEntries = true)
public void clearAllCaches() {// 业务逻辑
}

5. 组合缓存操作

@Caching

• 注解作用介绍

@Caching 注解用于组合多个缓存操作。

• 注解属性介绍

  • value: 包含多个缓存操作的数组。

• 注解业务案例

@Caching(cacheable = {@Cacheable("books")},put = {@CachePut("books")},evict = {@CacheEvict("archivedBooks")}
)
public Book processBook(String id, Book details) {// 业务逻辑
}

6. 类级别缓存配置

@CacheConfig

• 注解作用介绍

@CacheConfig 注解用于在类级别提供缓存相关的共享配置。

• 注解属性介绍
  • cacheNames: 指定类中所有缓存操作的默认缓存名称。
  • keyGenerator: 指定默认的缓存键生成器。
  • condition: 指定类中所有缓存操作的默认条件。
• 注解业务案例

@CacheConfig(cacheNames = "books", keyGenerator = "customKeyGenerator")
public class BookService {// 类中的方法可以使用缓存注解
}

7. @CacheResult (非官方)

• 注解作用介绍

@CacheResult 是一个非官方的注解，用于替代 @Cacheable，提供额外的配置选项，如超时时间。

• 注解属性介绍
  • cacheName: 缓存名称。
  • condition: 缓存条件。
  • timeout: 缓存超时时间（毫秒）。
• 注解业务案例

public @interface CacheResult {String cacheName() default "";String condition() default "";long timeout() default -1;
}// 使用 @CacheResult 注解
public class MyService {@CacheResult(cacheName = "myCache", timeout = 3600000) // 设置超时时间为1小时public MyObject getExpensiveResource(String key) {// 模拟耗时操作return performExpensiveOperation(key);}
}

8. @CacheResolver

• 注解作用介绍

@CacheResolver 允许自定义缓存解析器，可以决定使用哪个缓存。

• 注解属性介绍

无属性，通常与自定义的缓存解析器类一起使用。

• 注解业务案例

public interface CacheResolver {Cache resolveCache(String cacheName);
}@Service
public class MyCustomCacheResolver implements CacheResolver {@Overridepublic Cache resolveCache(String cacheName) {// 根据cacheName返回不同的缓存实现if ("primaryCache".equals(cacheName)) {return primaryCacheManager.getCache(cacheName);} else if ("secondaryCache".equals(cacheName)) {return secondaryCacheManager.getCache(cacheName);}// 默认返回一个通用缓存return defaultCacheManager.getCache(cacheName);}
}@Configuration
@EnableCaching
public class CacheConfig {@Beanpublic CacheResolver myCustomCacheResolver() {return new MyCustomCacheResolver();}@Beanpublic CacheManager cacheManager(CacheResolver cacheResolver) {return new CustomCacheManager(cacheResolver); // 假设CustomCacheManager使用CacheResolver}
}

9.@CacheAspect

• 注解作用介绍

@CacheAspect 是一个自定义注解，用于定义自定义的缓存切面。

• 注解属性介绍

通常不直接使用，而是在切面类上定义。

• 注解业务案例

@Aspect
public class MyCacheAspect {@Before("execution(* com.example.service.*.*(..))")public void cacheBeforeAdvice() {// 缓存逻辑}
}@Aspect
@Component
@CacheAspect
public class CacheAspectForProductService {@Before("@cacheableMethod execution(* com.example.product.ProductService.get*(..))")public void cacheBeforeAdvice(JoinPoint joinPoint) {// 逻辑：在调用 ProductService 中所有 get 开头的方法前，检查缓存Object[] args = joinPoint.getArgs();String methodName = joinPoint.getSignature().getName();String cacheKey = methodName + ":" + Arrays.toString(args);// 这里可以添加缓存检查和缓存填充逻辑}
}

10.@CacheNamespace

• 注解作用介绍

@CacheNamespace 用于定义缓存命名空间。

• 注解属性介绍
  • value: 命名空间的值。
• 注解业务案例

@CacheNamespace("myAppCache")
public class MyCacheConfig {// 缓存配置
}//在一个多租户应用中，我们希望为不同的租户使用不同的缓存命名空间。@Configuration
@CacheNamespace("tenant1Cache")
public class Tenant1CacheConfig {// 配置针对租户1的缓存相关Bean
}@Configuration
@CacheNamespace("tenant2Cache")
public class Tenant2CacheConfig {// 配置针对租户2的缓存相关Bean
}

11.@CacheCondition

• 注解作用介绍

@CacheCondition 用于定义缓存的条件。

• 注解属性介绍
  • condition: 缓存条件表达式。
• 注解业务案例

public @interface CacheCondition {String condition();
}
//只想在用户登录后缓存其个人信息。
@Service
public class UserService {@Cacheable(value = "userProfile", condition = "#user.getId() != null")public UserProfile getUserProfile(User user) {// 查询数据库获取用户信息return userRepository.findProfileById(user.getId());}
}

12.@CacheKeyGenerator

• 注解作用介绍

@CacheKeyGenerator 用于指定生成缓存键的策略。

• 注解属性介绍
  • value: 指定缓存键生成器Bean的名称。
• 注解业务案例

@Component("myKeyGenerator")
public class MyKeyGenerator implements KeyGenerator {// 实现缓存键生成逻辑
}//有一个方法，根据多个参数查询数据，我们希望自定义缓存键的生成方式
@Service
public class CustomCacheKeyService {@Cacheable(value = "customData", keyGenerator = "customKeyGenerator")public Data getData(String param1, int param2) {// 查询数据return dataRepository.findByParam1AndParam2(param1, param2);}
}
//在配置类中定义自定义的 `KeyGenerator`：
@Bean
public KeyGenerator customKeyGenerator() {return new KeyGenerator() {@Overridepublic Object generate(Object target, Method method, Object... params) {return Arrays.deepToString(params); // 使用参数的字符串表示作为缓存键}};
}

13.@CacheKey

• 注解作用介绍

@CacheKey 用于指定方法参数作为缓存键。

• 注解属性介绍
  • value: 指定参数名称作为缓存键。
• 注解业务案例

public void someMethod(@CacheKey String id) {// 业务逻辑
}
//返回一个对象列表，我们希望使用请求参数的一部分作为缓存键
public class SearchService {@Cacheable(value = "searchResults", key = "#query")public List<SearchResult> search(String query) {// 执行搜索并返回结果return performSearch(query);}
}

14.@CacheableCustomCondition

• 注解作用介绍

@CacheableCustomCondition 用于定义自定义的缓存条件。

• 注解属性介绍
  • condition: 自定义条件表达式。
• 注解业务案例

public @interface CacheableCustomCondition {String condition();
}
//只在特定条件下缓存方法结果
@Service
public class ConditionalService {@Cacheable(value = "conditionalResults", condition = "#param > 100")public Result processWithCustomCondition(int param) {// 处理业务逻辑return performProcessing(param);}
}

缓存注解综合案例

import org.springframework.cache.annotation.CacheConfig;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.stereotype.Service;@Service
@CacheConfig(cacheNames = "products", keyGenerator = "customKeyGenerator") // 类级别的缓存配置
public class ProductService {// 假设有一个自定义的Key生成器Bean// @Bean// public KeyGenerator customKeyGenerator() { ... }/*** 根据商品ID获取商品详情，结果会被缓存。* @param productId 商品ID* @return 商品对象*/@Cacheable(value = "productDetails", key = "#productId")public Product getProductDetails(String productId) {// 数据库查询操作return performDatabaseQuery(productId);}/*** 更新商品信息，同时更新缓存。* @param product 更新后的商品对象* @return 更新后的商品对象*/@CachePut(value = "productDetails", key = "#product.id")public Product updateProductDetails(Product product) {// 更新数据库操作performDatabaseUpdate(product);return product;}/*** 删除商品，同时清除缓存中的相关条目。*/@CacheEvict(value = "productDetails", allEntries = true) // 清除所有缓存条目public void deleteProduct(String productId) {// 删除数据库记录操作performDatabaseDelete(productId);}/*** 批量删除商品，同时清除缓存中的所有条目。*/@CacheEvict(value = "productDetails", allEntries = true) // 清除所有缓存条目public void deleteProducts(List<String> productIds) {// 批量删除数据库记录操作productIds.forEach(this::performDatabaseDelete);}/*** 特定条件下的缓存更新，例如当库存发生变化时。* @param productId 商品ID* @param newStock 新库存数量*/@CachePut(value = "productDetails", key = "#productId", condition = "#newStock > 0")public void updateProductStock(String productId, int newStock) {// 更新库存操作performStockUpdate(productId, newStock);}// 数据库操作的方法private Product performDatabaseQuery(String productId) { /* ... */ }private void performDatabaseUpdate(Product product) { /* ... */ }private void performDatabaseDelete(String productId) { /* ... */ }private void performStockUpdate(String productId, int newStock) { /* ... */ }
}