spring boot @Cacheable key生成策略(keyGenerator配置)

本文介绍了如何通过继承CachingConfigurerSupport在Spring Cache中自定义KeyGenerator,以活动缓存前缀为例子,详细展示了如何为不同操作生成特定的Redis缓存键。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

Sring cache缓存的key默认是通过KeyGenerator生成的,

通过继承CachingConfigurerSupport类实现对KeyGenerator的灵活配置

1.前期工作-缓存前缀枚举的创建

package com.sgcc.config;
/** 

* @author 作者 Your-Name:***

* @version 创建时间:2020年9月23日 下午2:07:52 

* 类说明 活动缓存前缀枚举

*/
public enum AcOperatorEnum {
	PROVINCE_OF_ACTIVITY("PROVINCE_OF_ACTIVITY","活动"),
	AC_ACTIVITY("ACTIVITY_OPERATOR","活动"),
	AC_RULE_R("RULE_R_OPERATOR","活动子项"),
	AC_AULE("RULE_OPERATOR","活动规则"),
	AC_RULE_ITEM("RULE_ITEM_OPERATOR","活动规则子项"),
	AC_REWARD("REWARD_OPERATOR","活动奖励");
	
	private String value ;
	private String desc;
	private AcOperatorEnum(String value, String desc) {
		this.value = value;
		this.desc = desc;
	}
	public String getValue() {
		return value;
	}
	public void setValue(String value) {
		this.value = value;
	}
	public String getDesc() {
		return desc;
	}
	public void setDesc(String desc) {
		this.desc = desc;
	}
	
	public static AcOperatorEnum getAcOperatorEnum(String value){
		AcOperatorEnum[] values = AcOperatorEnum.values();
		for (AcOperatorEnum acOperatorEnum : values) {
			if(acOperatorEnum.value.equals(value)){
				return acOperatorEnum;
			}
		}
		return null;
	}
	
	
	
}

2.配置类编写

package com.sgcc.config;

import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/** 

* @author 作者 Your-Name:*** 

* @version 创建时间:2020年9月24日 下午3:52:36 

* 类说明 key生成

*/
@Configuration
public class ActivityRedisConfig extends CachingConfigurerSupport{
	@Bean
    public KeyGenerator activityKeyGenerator() {
        return (target, method, params) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(RedisLockPrefix.getOsgRedisPrefix(2*60*60));
            sb.append(AcOperatorEnum.AC_ACTIVITY.getValue());
            sb.append(":");
            sb.append(params[0]);
            return sb.toString();
        };
    }
	
	@Bean
    public KeyGenerator ruleRKeyGenerator() {
        return (target, method, params) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(RedisLockPrefix.getOsgRedisPrefix(2*60*60));
            sb.append(AcOperatorEnum.AC_RULE_R.getValue());
            sb.append(":");
            sb.append(params[0]);
            return sb.toString();
        };
    }
	@Bean
    public KeyGenerator ruleKeyGenerator() {
        return (target, method, params) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(RedisLockPrefix.getOsgRedisPrefix(2*60*60));
            sb.append(AcOperatorEnum.AC_RULE_R.getValue());
            sb.append(":");
            sb.append(params[0]);
            return sb.toString();
        };
    }
	@Bean
    public KeyGenerator ruleItemKeyGenerator() {
        return (target, method, params) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(RedisLockPrefix.getOsgRedisPrefix(2*60*60));
            sb.append(AcOperatorEnum.AC_RULE_ITEM.getValue());
            sb.append(":");
            sb.append(params[0]);
            return sb.toString();
        };
    }
	@Bean
    public KeyGenerator rewardKeyGenerator() {
        return (target, method, params) -> {
            StringBuilder sb = new StringBuilder();
            sb.append(RedisLockPrefix.getOsgRedisPrefix(2*60*60));
            sb.append(AcOperatorEnum.AC_REWARD.getValue());
            sb.append(":");
            sb.append(params[0]);
            return sb.toString();
        };
    }
}

3引用

    @Cacheable(value = "redisDemo",keyGenerator = "activityKeyGenerator")
    public Activity findAcActivitiesById(String paramId) {
        return (Activity) mybatisDao.queryForObject("ActivityMapper.getActivityByAcIdNew", paramId);
    }

方法在执行到这里是会根据activityKeyGenerator自动生成key并存进redis

4总结

缓存cache注解开启见下一篇,

另:新技术的学习需要勇气!

### Spring Boot 中 `@Cacheable` 注解不触发的原因及解决方案 #### 配置缺失 为了使 `@Cacheable` 正常工作,项目中必须启用缓存支持。这通常通过在主类或其他配置类上添加 `@EnableCaching` 来完成[^2]。 ```java import org.springframework.cache.annotation.EnableCaching; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication @EnableCaching public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` #### 缓存管理器未正确配置 如果应用程序没有合适的缓存提供者,则即使存在 `@Cacheable` 注解也不会起作用。确保已经配置了一个具体的缓存实现(如 Redis 或 Ehcache),并且该实现已被注册到应用上下文中作为 `CacheManager` 实现的一部分[^1]。 对于Redis来说,在application.properties文件里设置如下属性: ```properties spring.redis.host=localhost spring.redis.port=6379 spring.cache.type=redis ``` 同时还需要引入相应的依赖项以便能够连接至Redis服务器并利用其存储能力。 #### 方法签名变化影响缓存生成 当被标记的方法参数列表发生变化时,默认情况下会改变用于查找缓存条目的key值,从而导致每次调用都被视为新请求而绕过了现有缓存数据。可以通过自定义 keyGenerator 解决此问题或者显式指定 cacheKey 属性来保持一致性[^3]。 ```java @Service public class UserService { @Autowired private UserRepository userRepository; @Cacheable(value="users", key="#userId") public User getUserById(Long userId){ return userRepository.findById(userId).orElse(null); } } ``` 在此例子中,“value”指定了要使用的缓存名称;“key”则表示用来区分不同记录的唯一标识符表达式。 #### AOP代理模式的影响 默认情况下,Spring 使用 JDK 动态代理机制创建目标对象实例。这意味着只有外部对该服务方法的调用才会经过AOP拦截器处理进而激活缓存逻辑。因此,内部同一组件内的自我调用不会触发展开行为。可以考虑调整为基于 CGLIB 的子类化方式以覆盖这种情况下的局限性。 ```yaml spring.aop.proxy-target-class=true ``` 上述 YAML 设置告知框架优先采用 CGLIB 技术而非标准接口导向型代理方案。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值