如何使用StringBuilder方法传递缓存key，解决@Cacheable注解key报错问题

报错根本原因 #

Java 注解的属性值必须是编译期可确定的常量，你当前的两种写法都不符合注解语法要求：

• 调用cacheKey()方法属于运行时逻辑，编译阶段无法得到固定值，天然不允许作为注解属性值
• 字符串拼接写法如果报错，说明CACHE_MEMBERSHIP_STATUSES不是public static final修饰的编译期字符串常量
  注意：这个错误是编译阶段抛出的，不是运行时错误，本质是Java注解的语法限制

解决方案 #

方案1：用编译期常量直接赋值（适合固定key的场景）

先确保CACHE_MEMBERSHIP_STATUSES是public static final修饰的字符串常量，直接提前拼接成最终的key常量即可：

// 常量定义处
public static final String CACHE_MEMBERSHIP_STATUSES = "membership_statuses";
// 两个static final String拼接的结果依然是编译期常量
public static final String MEMBERSHIP_STATUS_CACHE_KEY = "'" + CACHE_MEMBERSHIP_STATUSES + "'";

// 注解处直接引用常量即可
@Cacheable(value = SETTINGS_CACHE, key = MEMBERSHIP_STATUS_CACHE_KEY)

方案2：用SpEL表达式引用常量（适合不想额外定义常量的场景）

如果不想额外定义拼接后的常量，可以直接在key属性里用Spring SpEL表达式引用静态常量：

// 替换为你自己的常量所在类的全限定名
@Cacheable(value = SETTINGS_CACHE, key = "#{T(com.yourpackage.YourConstantsClass).CACHE_MEMBERSHIP_STATUSES}")
// 需要加单引号的话直接在SpEL里拼接即可
@Cacheable(value = SETTINGS_CACHE, key = "#{'\'' + T(com.yourpackage.YourConstantsClass).CACHE_MEMBERSHIP_STATUSES + '\''}")

方案3：自定义KeyGenerator（适合动态生成key的场景）

如果你的key需要结合方法参数、类名等动态信息生成，可以自定义KeyGenerator实现，然后在注解中指定：

1. 实现KeyGenerator接口

@Component("customCacheKeyGenerator")
public class CustomCacheKeyGenerator implements KeyGenerator {
    private static final String STR_APOSTROPHE = "'";

    @Override
    public Object generate(Object target, Method method, Object... params) {
        // 这里实现你自己的key生成逻辑，示例：取第一个参数拼接前后单引号
        String baseKey = params.length > 0 ? params[0].toString() : "defaultKey";
        return STR_APOSTROPHE + baseKey + STR_APOSTROPHE;
    }
}

2. 注解中指定keyGenerator

@Cacheable(value = SETTINGS_CACHE, keyGenerator = "customCacheKeyGenerator")

内容的提问来源于stack exchange，提问作者selvi