使用MockWebServer测试FeignClient：如何搭建Spring配置？

一、依赖准备 #

首先确保你的项目中包含以下核心依赖（以Maven为例）：

<!-- Feign核心依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!-- Spring Boot测试依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<!-- MockWebServer依赖（用于模拟HTTP服务） -->
<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>mockwebserver</artifactId>
    <scope>test</scope>
</dependency>

二、FeignClient定义示例 #

假设你已定义了如下FeignClient：

@FeignClient(name = "demo-client", url = "${feign.client.config.demo-client.url}")
public interface DemoFeignClient {
    @GetMapping("/api/data")
    String fetchData();

    // 如果是返回JSON对象的接口
    @GetMapping("/api/user")
    User fetchUser();
}

三、测试方案1：全Spring上下文测试（@SpringBootTest） #

适合需要完整上下文的场景，比如依赖其他Spring Bean的FeignClient：

import okhttp3.mockwebserver.MockResponse;
import okhttp3.mockwebserver.MockWebServer;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import static org.junit.jupiter.api.Assertions.*;

@SpringBootTest
public class DemoFeignClientFullTest {

    private static MockWebServer mockWebServer;

    @Autowired
    private DemoFeignClient demoFeignClient;

    // 启动MockWebServer
    @BeforeAll
    static void setUp() throws Exception {
        mockWebServer = new MockWebServer();
        mockWebServer.start();
    }

    // 关闭MockWebServer，清理资源
    @AfterAll
    static void tearDown() throws Exception {
        mockWebServer.shutdown();
    }

    // 动态覆盖FeignClient的URL配置，指向MockWebServer
    @DynamicPropertySource
    static void configureProperties(DynamicPropertyRegistry registry) {
        registry.add("feign.client.config.demo-client.url", mockWebServer::url);
    }

    @Test
    void fetchData_returnsMockedResponse() {
        // 模拟200响应
        mockWebServer.enqueue(new MockResponse()
                .setResponseCode(200)
                .setBody("Mocked Response Content"));

        String result = demoFeignClient.fetchData();
        assertEquals("Mocked Response Content", result);
    }

    @Test
    void fetchUser_returnsMockedUser() {
        // 模拟JSON响应，需设置正确Content-Type
        mockWebServer.enqueue(new MockResponse()
                .setResponseCode(200)
                .setBody("{\"id\":1,\"name\":\"TestUser\"}")
                .addHeader("Content-Type", "application/json"));

        User user = demoFeignClient.fetchUser();
        assertEquals(1, user.getId());
        assertEquals("TestUser", user.getName());
    }
}

四、测试方案2：轻量级FeignClient测试（@FeignClientTest） #

Spring Cloud提供了@FeignClientTest注解，仅加载Feign相关Bean，测试速度更快，适合单独测试FeignClient的逻辑：

import okhttp3.mockwebserver.MockResponse;
import okhttp3.mockwebserver.MockWebServer;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.openfeign.test.FeignClientTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;
import static org.junit.jupiter.api.Assertions.assertEquals;

@FeignClientTest(DemoFeignClient.class)
public class DemoFeignClientLightTest {

    private static MockWebServer mockWebServer;

    @Autowired
    private DemoFeignClient demoFeignClient;

    @BeforeAll
    static void setUp() throws Exception {
        mockWebServer = new MockWebServer();
        mockWebServer.start();
    }

    @AfterAll
    static void tearDown() throws Exception {
        mockWebServer.shutdown();
    }

    @DynamicPropertySource
    static void configureProperties(DynamicPropertyRegistry registry) {
        registry.add("feign.client.config.demo-client.url", mockWebServer::url);
    }

    @Test
    void fetchData_returnsExpectedResult() {
        mockWebServer.enqueue(new MockResponse()
                .setResponseCode(200)
                .setBody("Light Mocked Data"));

        String result = demoFeignClient.fetchData();
        assertEquals("Light Mocked Data", result);
    }
}

五、进阶配置：自定义Feign组件 #

如果你的FeignClient使用了自定义编码器、解码器或请求拦截器，可以通过@TestConfiguration注入测试用组件：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.test.FeignClientTest;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.TestConfiguration;
import org.springframework.context.annotation.Import;
import feign.codec.Decoder;
import feign.codec.Encoder;
import feign.jackson.JacksonDecoder;
import feign.jackson.JacksonEncoder;
import feign.RequestInterceptor;

@FeignClientTest(DemoFeignClient.class)
@Import(DemoFeignClientLightTest.TestFeignConfig.class)
public class DemoFeignClientLightTest {

    // ... 测试代码省略

    @TestConfiguration
    static class TestFeignConfig {
        @Bean
        public Decoder feignDecoder() {
            return new JacksonDecoder();
        }

        @Bean
        public Encoder feignEncoder() {
            return new JacksonEncoder();
        }

        // 如果需要模拟请求拦截器
        @Bean
        public RequestInterceptor testInterceptor() {
            return template -> template.header("X-Test-Header", "test-value");
        }
    }
}

关键注意事项 #

• 模拟响应时，务必设置匹配接口的Content-Type，否则Feign的解码器可能无法正确解析响应。
• 若需模拟错误状态（如404、500），直接使用setResponseCode(404)即可，可配合测试Feign的异常处理逻辑。
• 使用mockWebServer.enqueue()可以排队模拟多次请求的响应，适合测试批量调用场景。

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