Spring Cache(Ehcache)中如何通过注解定义集合类型的缓存键？

正好之前在项目里折腾过Spring Cache处理集合类型的缓存键问题，给你分享几个实用的方案，都是原生支持或者简单扩展就能搞定的~

一、集合作为方法参数时的缓存键定义 #

1. 直接使用集合本身 #

如果你的集合元素是基本类型（比如List<Integer>、Set<String>）或者重写过equals()和hashCode()的自定义对象，直接用SpEL引用集合参数即可。Spring Cache会基于集合的内容生成对应的缓存键。

示例代码：

// 传入员工ID列表，缓存整个查询结果
@Cacheable(value="employeeCache", key="#employeeIds")
public List<Employee> getEmployeesByIds(List<Integer> employeeIds) {
    // 从数据库或其他数据源查询员工列表
    return employeeRepository.findAllById(employeeIds);
}

2. 提取集合元素的特定属性作为键 #

如果集合里是自定义对象（比如List<Employee>），你可以通过SpEL的投影语法（![property]）提取元素的指定属性，生成由这些属性组成的集合作为缓存键，这样更精准。

示例代码：

// 传入员工列表，以每个员工的ID拼接作为缓存键
@CachePut(value="employeeCache", key="#employees.![id]")
public void batchUpdateEmployees(List<Employee> employees) {
    employeeRepository.saveAll(employees);
}

这里的#employees.![id]会把所有员工的ID提取成一个新的集合，作为缓存键的核心部分。

3. 自定义KeyGenerator处理复杂场景 #

如果上面的原生SpEL满足不了你的需求（比如需要对集合元素做特殊处理、拼接额外信息），可以自定义一个KeyGenerator组件，然后在注解中指定使用它。

首先实现自定义KeyGenerator：

@Component("collectionKeyGenerator")
public class CollectionKeyGenerator implements KeyGenerator {
    @Override
    public Object generate(Object target, Method method, Object... params) {
        StringBuilder keyBuilder = new StringBuilder();
        // 加入方法名，避免不同方法的相同集合参数命中同一缓存
        keyBuilder.append(method.getName()).append("_");
        
        for (Object param : params) {
            if (param instanceof Collection<?>) {
                Collection<?> collection = (Collection<?>) param;
                collection.forEach(item -> {
                    // 根据实际业务处理元素：这里以Employee为例取ID
                    if (item instanceof Employee) {
                        keyBuilder.append(((Employee) item).getId()).append(",");
                    } else {
                        // 非自定义对象直接用toString()
                        keyBuilder.append(item.toString()).append(",");
                    }
                });
            } else {
                // 非集合参数直接拼接
                keyBuilder.append(param.toString()).append("_");
            }
        }
        return keyBuilder.toString();
    }
}

然后在缓存注解中指定这个生成器：

@Cacheable(value="employeeCache", keyGenerator="collectionKeyGenerator")
public List<Employee> batchGetEmployees(Set<Integer> employeeIds) {
    return employeeRepository.findAllById(employeeIds);
}

二、集合作为方法返回结果时的缓存键定义 #

当方法返回集合类型时，同样可以通过#result结合SpEL来定义缓存键：

1. 直接用返回的集合本身 #

// 缓存返回的员工列表，键为返回集合的内容标识
@Cacheable(value="employeeCache", key="#result")
public List<Employee> getDepartmentEmployees(String departmentId) {
    return employeeRepository.findByDepartmentId(departmentId);
}

2. 提取返回集合的属性作为键 #

如果需要基于返回集合里的元素属性生成键，同样用投影语法：

// 以返回的员工ID列表作为键，缓存对应的员工数据
@CachePut(value="employeeCache", key="#result.![id]")
public List<Employee> batchAddEmployees(List<Employee> employees) {
    return employeeRepository.saveAll(employees);
}

三、注意事项 #

• 对于自定义对象的集合，一定要重写equals()和hashCode()，否则Spring Cache可能无法正确识别相同内容的集合，导致缓存命中异常。
• 自定义KeyGenerator时要注意线程安全，避免多线程场景下生成的键出现混乱。
• 如果需要给集合中的每个元素单独缓存，建议在方法内部循环调用单个元素的缓存方法，或者结合自定义逻辑实现，因为Spring Cache本身是方法级别的缓存。

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