Spring Boot组件测试中如何清除Ehcache数据并通过MockRestServiceServer测试？

一、清除Ehcache缓存的实用方案 #

1. 手动通过CacheManager清理指定缓存 #

在测试方法执行前后，直接操作Spring的CacheManager清除目标缓存。这种方式精准可控，不会影响测试速度，是优先推荐的方案。

示例代码：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.CacheManager;
import org.junit.jupiter.api.BeforeEach;

class YourComponentTest {

    @Autowired
    private CacheManager cacheManager;

    @BeforeEach
    void clearTargetCache() {
        // 清除业务代码中@Cacheable指定的缓存
        cacheManager.getCache("user-data-cache").clear();
        
        // 如果需要清空所有缓存，遍历所有缓存名称即可
        // cacheManager.getCacheNames().forEach(name -> cacheManager.getCache(name).clear());
    }

    // 测试方法...
}

2. 用@DirtiesContext重置应用上下文 #

如果缓存关联的配置过于复杂，手动清理困难，可以用@DirtiesContext让Spring在每个测试后重置上下文。注意：这个操作会增加测试耗时，适合小型测试类。

示例：

import org.springframework.test.annotation.DirtiesContext;
import org.junit.jupiter.api.Test;

@DirtiesContext(classMode = DirtiesContext.ClassMode.AFTER_EACH_TEST_METHOD)
class YourComponentTest {

    // 测试方法...
}

3. 测试环境直接禁用缓存 #

在测试专用配置里替换为无操作缓存管理器，从根源避免缓存干扰。

创建测试缓存配置类：

import org.springframework.cache.CacheManager;
import org.springframework.cache.support.NoOpCacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;

@Configuration
@Profile("test")
public class TestCacheConfig {

    @Bean
    public CacheManager cacheManager() {
        return new NoOpCacheManager();
    }
}

然后在测试类激活test环境：

import org.springframework.test.context.ActiveProfiles;

@ActiveProfiles("test")
class YourComponentTest {
    // 测试方法...
}

二、结合MockRestServiceServer完成隔离测试 #

MockRestServiceServer用于模拟REST服务调用，确保测试不依赖外部服务，同时避免真实请求数据写入缓存。

完整测试示例： #

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.web.client.RestTemplate;
import org.springframework.test.web.client.MockRestServiceServer;
import static org.springframework.test.web.client.match.MockRestRequestMatchers.*;
import static org.springframework.test.web.client.response.MockRestResponseCreators.*;

class YourComponentTest {

    @Autowired
    private RestTemplate restTemplate;
    @Autowired
    private CacheManager cacheManager;

    private MockRestServiceServer mockServer;

    @BeforeEach
    void setup() {
        // 绑定RestTemplate到MockServer
        mockServer = MockRestServiceServer.bindTo(restTemplate).build();
        // 每次测试前清空缓存
        cacheManager.getCache("user-data-cache").clear();
    }

    @Test
    void testFetchData() {
        // 定义Mock服务的预期请求和响应
        mockServer.expect(requestTo("https://external-api.com/users/1"))
                  .andExpect(method(HttpMethod.GET))
                  .andRespond(withSuccess("{\"id\":1,\"username\":\"test-user\"}", MediaType.APPLICATION_JSON));

        // 执行被测试组件的逻辑
        UserService userService = new UserService(restTemplate);
        User user = userService.getUserById(1);

        // 验证结果和Mock服务调用情况
        assert user.getUsername().equals("test-user");
        mockServer.verify(); // 确保预期请求被调用
    }
}

三、关键注意点 #

• 缓存名称要和业务代码中@Cacheable注解的value属性完全一致，否则无法清理目标缓存
• MockRestServiceServer的请求匹配规则（路径、请求方法、请求参数等）必须和实际代码中的请求严格对齐，否则会触发断言失败
• 优先使用手动清理缓存的方式，尽量避免@DirtiesContext带来的性能开销

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