Spring声明式缓存服务的集成测试方法咨询

我完全懂你遇到的这个痛点——缓存和事务回滚的不一致确实会搞砸集成测试，用@DirtiesContext虽然能解决，但每次重启上下文太影响测试速度了。下面给你几个更优雅的解决方案：

1. 正确注入CacheManager并手动清理缓存 #

你之前自动装配CacheManager失败，大概率是因为测试上下文里的缓存配置没生效，或者你没指定具体要操作的缓存名称。试试这样调整你的测试类：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureTestEntityManager
@Transactional
public class TenantEndpointIT {

    @Autowired
    private TestRestTemplate template;
    @Autowired
    private TestEntityManager entityManager;
    @Autowired
    private CacheManager cacheManager;

    // 每个测试执行后清理目标缓存，避免污染后续测试
    @AfterEach
    void clearTargetCache() {
        // 替换成你的@Cacheable注解里指定的cacheNames值
        Cache tenantCache = cacheManager.getCache("tenantCache");
        if (tenantCache != null) {
            tenantCache.clear();
        }
    }

    @Test
    public void nok_updateValueForbidden() {
        // 你的测试逻辑
    }
}

如果你的项目用了自定义缓存配置（比如Redis），要确保测试环境的缓存配置正常加载——不要在测试里直接禁用缓存，否则CacheManager会找不到对应的实例。

2. 用@CacheEvict创建测试专用的缓存清理方法 #

你也可以借助Spring的缓存注解，写一个专门清理缓存的方法，在测试前后调用，风格更贴合Spring生态：

@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@AutoConfigureTestEntityManager
@Transactional
public class TenantEndpointIT {

    // ... 其他注入和测试方法

    // 清理指定缓存的所有条目
    @CacheEvict(value = "tenantCache", allEntries = true)
    public void clearTenantCache() {}

    @AfterEach
    void setUp() {
        clearTenantCache();
    }
}

这种方式不需要直接操作CacheManager实例，代码更简洁直观。

3. 自定义TestExecutionListener实现全局缓存清理 #

如果多个测试类都需要处理缓存清理，可以自定义一个TestExecutionListener，让它在每个测试执行后自动清理缓存，避免重复代码：

public class CacheCleanupTestExecutionListener extends AbstractTestExecutionListener {

    @Autowired
    private CacheManager cacheManager;

    @Override
    public void afterTestMethod(TestContext testContext) throws Exception {
        // 可以选择清理所有缓存，或者指定特定缓存
        cacheManager.getCacheNames().forEach(name -> {
            Cache cache = cacheManager.getCache(name);
            if (cache != null) {
                cache.clear();
            }
        });
    }
}

然后在测试类上添加这个监听器：

@TestExecutionListeners(mergeMode = TestExecutionListeners.MergeMode.MERGE_WITH_DEFAULTS,
        listeners = CacheCleanupTestExecutionListener.class)

为什么不推荐一直用@DirtiesContext？ #

@DirtiesContext会在测试结束后重启Spring上下文，虽然能彻底清除缓存，但重启上下文的开销极大，当测试用例数量较多时，会大幅拖慢整体测试速度。上面的方法都是在现有上下文内清理缓存，效率高很多。

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