使用MockWebServer对FeignClient进行单元测试

dependencies {
    // FeignClient 核心依赖 (通常已存在)
    // implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'

    // MockWebServer (通常已存在于测试依赖中)
    testImplementation 'com.squareup.okhttp3:mockwebserver'

    // 用于将 FeignClient 指向 MockWebServer 的负载均衡器
    testImplementation 'org.springframework.cloud:spring-cloud-starter-loadbalancer'

    // Spring Boot Test 核心依赖
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
}

import com.squareup.okhttp3.mockwebserver.MockResponse;
import com.squareup.okhttp3.mockwebserver.MockWebServer;
import feign.FeignException;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
import org.springframework.cloud.loadbalancer.support.ServiceInstanceListSuppliers;
import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.io.IOException;
import java.util.Collections;
import java.util.List;

import static org.junit.jupiter.api.Assertions.assertThrows;

// 假设有一个名为 DemoClient 的 FeignClient 接口
// @FeignClient(name = "demo-server", url = "http://demo-server")
// interface DemoClient {
//     @GetMapping("/demo-endpoint")
//     String demoEndpoint();
// }

@SpringBootTest
class DemoClientTest {

    @Autowired
    DemoClient client; // 注入需要测试的 FeignClient

    static MockWebServer demoServer; // 静态声明 MockWebServer

    /**
     * 在所有测试执行完毕后关闭 MockWebServer
     */
    @AfterAll
    static void stopMockServer() throws IOException {
        if (demoServer != null) {
            demoServer.shutdown(); // 使用 shutdown 替代 close，更优雅地关闭
        }
    }

    /**
     * 测试配置类，用于在 Spring Boot Test 环境中启动 MockWebServer
     * 并将其注册为 FeignClient 的服务实例
     */
    @Configuration
    @EnableAutoConfiguration // 启用 Spring Boot 自动配置
    @EnableFeignClients(clients = DemoClient.class) // 启用 FeignClient，并指定要扫描的客户端
    static class Config {
        static {
            demoServer = new MockWebServer();
            try {
                demoServer.start(); // 启动 MockWebServer
            } catch (IOException e) {
                throw new AssertionError("Failed to start MockWebServer", e);
            }
        }

        /**
         * 定义 ServiceInstanceListSupplier Bean，将 FeignClient 的服务名映射到 MockWebServer 实例。
         *
         * @return ServiceInstanceListSupplier 实例
         */
        @Bean
        ServiceInstanceListSupplier serviceInstanceListSupplier() {
            // "demo-server" 应该与 FeignClient 接口上 @FeignClient 注解的 name 属性值一致
            return ServiceInstanceListSuppliers.from("demo-server",
                new DefaultServiceInstance(
                    "instance1", // 实例ID
                    "demo-server", // 服务名，与 @FeignClient 的 name 匹配
                    demoServer.getHostName(), // MockWebServer 的主机名
                    demoServer.getPort(), // MockWebServer 的端口
                    false // 是否使用 HTTPS
                )
            );
        }
    }

    /**
     * 示例测试方法：测试当后端返回 500 错误时 FeignClient 的行为
     */
    @Test
    void demoEndpoint_500_throws() {
        // 在 MockWebServer 中排队一个 500 错误响应
        demoServer.enqueue(new MockResponse()
            .setResponseCode(500)
            .setBody("Internal Server Error"));

        // 调用 FeignClient 的方法，并断言它会抛出 FeignException
        assertThrows(FeignException.class, () -> client.demoEndpoint());
    }

    /**
     * 示例测试方法：测试当后端返回成功响应时 FeignClient 的行为
     */
    @Test
    void demoEndpoint_200_success() {
        // 在 MockWebServer 中排队一个 200 成功响应及响应体
        demoServer.enqueue(new MockResponse()
            .setResponseCode(200)
            .addHeader("Content-Type", "application/json")
            .setBody("{\"message\":\"Hello from Mock Server!\"}"));

        // 调用 FeignClient 的方法
        String response = client.demoEndpoint();

        // 断言返回结果是否符合预期
        // 根据实际的 FeignClient 返回类型调整断言
        // 例如，如果 FeignClient 返回 String，则：
        // assertEquals("{\"message\":\"Hello from Mock Server!\"}", response);
        // 如果 FeignClient 返回一个 DTO，则需要反序列化后断言
    }
}