Spring Cloud项目集成测试：Feign客户端Stub实现咨询

嘿，这个场景我太熟了！在Spring Cloud项目里，要测试Controller层但依赖的Feign目标服务还没部署？用Feign Stub来搞定完全没问题，我给你梳理几个适配你层级结构的靠谱方案：

方案1：用@MockBean直接Mock Feign客户端（最简单直接） #

这个方案不需要额外引入依赖，利用Spring Boot自带的Mockito支持，直接Mock最底层的Feign客户端，上层的flow、service逻辑会正常执行，完美匹配你的层级关联。

步骤很简单：

• 在测试类中用@MockBean注入你的Feign客户端接口
• 用Mockito的when().thenReturn()来Stub Feign方法的返回值（甚至可以模拟异常）
• 用MockMvc调用Controller端点，验证业务逻辑和响应

示例代码：

@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerIntegrationTest {

    @Autowired
    private MockMvc mockMvc;

    // Mock你的Feign客户端
    @MockBean
    private UserFeignClient userFeignClient;

    @Test
    public void testGetUserEndpoint() throws Exception {
        // Stub Feign调用的正常返回值
        when(userFeignClient.getUserById(1L)).thenReturn(new User(1L, "Alice"));

        // 调用Controller端点并验证响应
        mockMvc.perform(get("/users/1"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.id").value(1))
                .andExpect(jsonPath("$.name").value("Alice"));
    }

    @Test
    public void testGetUserWithFallback() throws Exception {
        // 模拟Feign调用抛出异常，触发Hystrix降级
        when(userFeignClient.getUserById(2L)).thenThrow(new RuntimeException("Service Unavailable"));

        mockMvc.perform(get("/users/2"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name").value("Fallback User"));
    }
}

方案2：用Spring Cloud Contract Stub Runner（贴近真实服务契约） #

如果你的Feign客户端对应的目标服务已经定义了Spring Cloud Contract契约，这个方案会更贴近真实场景——它会启动一个Stub服务器，让Feign客户端自动指向这个Stub，模拟真实的服务交互。

步骤： #

1. 添加依赖到你的pom.xml（或build.gradle）：

<!-- Maven -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-contract-stub-runner</artifactId>
    <scope>test</scope>
</dependency>

2. 在测试类上添加@AutoConfigureStubRunner，指定Stub的坐标（或本地路径）
3. 直接测试Controller端点，Feign会自动调用Stub服务器

示例代码：

@SpringBootTest
@AutoConfigureMockMvc
// 指定Stub的groupId、artifactId、版本（+表示最新版）、端口
@AutoConfigureStubRunner(ids = "com.example:user-service:+:stubs:8081")
public class UserControllerIntegrationTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testGetUserEndpoint() throws Exception {
        // Feign会自动调用Stub服务器的预设响应，无需手动Mock
        mockMvc.perform(get("/users/1"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.id").value(1))
                .andExpect(jsonPath("$.name").value("Stubbed Alice"));
    }
}

方案3：用WireMock实现灵活Stub（适合复杂场景测试） #

如果需要模拟更复杂的场景——比如HTTP 500错误、网络超时、不同的响应头，或者要验证Hystrix降级逻辑，WireMock是最佳选择。它允许你精细控制Stub的行为。

步骤： #

1. 添加WireMock依赖：

<!-- Maven -->
<dependency>
    <groupId>com.github.tomakehurst</groupId>
    <artifactId>wiremock-jre8</artifactId>
    <scope>test</scope>
</dependency>

2. 在测试类中启动/停止WireMock服务器
3. 配置Feign客户端的URL指向WireMock端口
4. 定义Stub规则来模拟各种服务行为

示例代码：

@SpringBootTest(properties = {"user.feign.url=http://localhost:8082"})
@AutoConfigureMockMvc
public class UserControllerIntegrationTest {

    @Autowired
    private MockMvc mockMvc;

    private WireMockServer wireMockServer;

    // 测试前启动WireMock
    @BeforeEach
    void setup() {
        wireMockServer = new WireMockServer(8082);
        wireMockServer.start();
        WireMock.configureFor("localhost", 8082);
    }

    // 测试后停止WireMock
    @AfterEach
    void teardown() {
        wireMockServer.stop();
    }

    @Test
    public void testGetUserEndpoint() throws Exception {
        // 定义正常响应的Stub规则
        stubFor(get(urlEqualTo("/users/1"))
                .willReturn(aResponse()
                        .withStatus(200)
                        .withHeader("Content-Type", "application/json")
                        .withBody("{\"id\":1,\"name\":\"WireMock Alice\"}")));

        mockMvc.perform(get("/users/1"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.id").value(1))
                .andExpect(jsonPath("$.name").value("WireMock Alice"));
    }

    @Test
    public void testHystrixFallbackOnServiceError() throws Exception {
        // 模拟服务返回500错误，触发降级
        stubFor(get(urlEqualTo("/users/2"))
                .willReturn(aResponse()
                        .withStatus(500)
                        .withBody("Internal Server Error")));

        mockMvc.perform(get("/users/2"))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.name").value("Fallback User"));
    }
}

方案选择建议 #

• 如果你只是快速验证Controller和核心业务逻辑：选方案1（@MockBean），简单高效
• 如果目标服务已有契约定义：选方案2（Spring Cloud Contract），最贴近真实生产场景
• 如果需要测试异常、降级、超时等复杂场景：选方案3（WireMock），灵活性拉满

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