概述

Spring Cache是一个用于增强缓存功能的框架，它可以通过注解的方式方便地实现方法级别的缓存。其中，缓存的key是决定缓存数据存储位置的重要因素。

缓存Key的定义

缓存Key是用来唯一标识缓存数据的字符串。在Spring Cache中，通过SpEL表达式的方式来定义缓存Key。默认情况下，SpEL表达式可以直接使用方法参数或者方法名来进行拼接。但有时候，简单的拼接方式可能无法满足我们的需求。

缓存Key的拼接

在实际项目中，我们常常需要使用多个参数来进行缓存Key的拼接。这时，可以通过SpEL表达式的“+”运算符来实现。例如，假设我们有一个查询用户信息的方法，需要根据用户名和用户角色来查询用户信息，我们可以这样定义缓存Key：

@Cacheable(value = "userInfoCache", key = "'user:' + #username + ':' + #role")
public User getUserInfo(String username, String role) {
    // 查询用户信息的逻辑
}

在上述代码中，我们通过“+”运算符将用户名和用户角色拼接在一起，形成了一个唯一的缓存Key。

自定义KeyGenerator

有时候，我们需要更加灵活地定义缓存Key。这时，可以通过自定义KeyGenerator来实现。KeyGenerator是Spring Cache框架中用来生成缓存Key的接口，我们可以通过实现该接口来自定义Key的生成方式。

示例

假设我们有一个查询用户信息的方法，需要根据用户的所属部门和年龄来查询用户信息，我们可以通过自定义KeyGenerator来生成缓存Key：

@Component
public class CustomKeyGenerator implements KeyGenerator {

    @Override
    public Object generate(Object target, Method method, Object... params) {
        StringBuilder sb = new StringBuilder();
        for (Object param : params) {
            if (param instanceof Department) {
                Department department = (Department) param;
                sb.append(department.getId()).append(":");
            } else if (param instanceof Integer) {
                Integer age = (Integer) param;
                sb.append(age).append(":");
            } else {
                sb.append(param).append(":");
            }
        }
        return sb.toString();
    }
}

在上述代码中，我们首先创建了一个StringBuilder对象，然后遍历方法参数，根据参数的类型进行判断，最后将参数值拼接在一起形成缓存Key的一部分。

接下来，我们需要将自定义的KeyGenerator注册到Spring Cache中：

@Configuration
@EnableCaching
public class CacheConfig extends CachingConfigurerSupport {

    @Autowired
    private CustomKeyGenerator customKeyGenerator;

    @Override
    public KeyGenerator keyGenerator() {
        return customKeyGenerator;
    }

    // 其他配置...
}

在上述代码中，我们通过覆写CachingConfigurerSupport类的keyGenerator()方法将自定义的KeyGenerator注册到Spring Cache中。

最后，我们可以在需要缓存的方法上使用自定义的缓存Key生成规则：

@Cacheable(value = "userInfoCache")
public User getUserInfo(Department department, int age) {
    // 查询用户信息的逻辑
}

在上述代码中，我们直接使用自定义的KeyGenerator生成缓存Key。

总结

通过完善的缓存Key的拼接方法，我们可以更加灵活地实现缓存数据的存储和使用，提升系统的性能和响应速度。合理的缓存Key的设计可以有效地增加缓存的命中率，减少查询数据库的次数，从而提升系统的整体性能。

参考资料：

• Spring Cache Documentation

本文来自极简博客，作者：蓝色海洋，转载请注明原文链接：Spring Cache的Key拼接