简介
在基于spring cloud的微服务架构中，feignclient是声明式http客户端的重要组成部分，它极大地简化了服务间通信。为了保证feignclient的正确性与稳定性，对其进行单元测试至关重要。传统的单元测试可能需要启动实际的服务，但这会增加测试的复杂性、运行时间和资源消耗。mockwebserver作为square公司提供的一个http服务器，允许我们在测试中模拟http响应，是测试http客户端的理想选择。结合spring cloud loadbalancer，我们可以巧妙地将feignclient指向mockwebserver，实现完全隔离的单元测试。
准备工作：引入依赖
要实现FeignClient与MockWebServer的集成测试，除了spring-cloud-starter-openfeign（FeignClient的基础依赖）外，我们还需要引入spring-cloud-starter-loadbalancer。这是因为我们将利用Spring Cloud LoadBalancer的服务发现机制，将FeignClient指向我们本地启动的MockWebServer。
在Gradle项目中，请在build.gradle文件中添加以下测试依赖：
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'
}配置FeignClient指向MockWebServer
核心思路是在Spring测试上下文中，通过ServiceInstanceListSupplier接口告诉Spring Cloud LoadBalancer，我们的FeignClient所指向的服务实例实际上是MockWebServer。
以下是一个完整的测试配置示例：
dmSOBC SHOP网店系统
下载
dmSOBC SHOP网店系统由北京时代胜腾信息技术有限公司（http://www.webzhan.com）历时6个月开发完成，本着简单实用的理念，商城在功能上摒弃了外在装饰的一些辅助功能，尽可能的精简各项模块开发，做到有用的才开发，网店V1.0.0版本开发完成后得到了很多用户的使用并获得了好评，公司立即对网店进行升级，其中包括修正客户提出的一些意见和建议，现对广大用户提供免费试用版本，如您在使用
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，则需要反序列化后断言
}
}代码解析：
- @SpringBootTest: 启动一个完整的Spring Boot测试上下文。
- MockWebServer demoServer: 静态声明MockWebServer实例，确保在整个测试类生命周期中只有一个实例，并在所有测试方法之间共享。
- @AfterAll static void stopMockServer(): 在所有测试方法执行完毕后，调用demoServer.shutdown()关闭MockWebServer，释放资源。
-
static class Config: 这是一个嵌套的静态配置类，用于定制当前测试的Spring上下文。
- static { ... }: 静态代码块在类加载时执行，用于初始化并启动MockWebServer。
- @EnableAutoConfiguration: 确保Spring Boot的自动配置机制在此测试配置中生效。
- @EnableFeignClients(clients = DemoClient.class): 启用Feign客户端，并明确指定要测试的DemoClient接口。
-
@Bean ServiceInstanceListSupplier serviceInstanceListSupplier(): 这是核心配置。
- 它创建了一个ServiceInstanceListSupplier Bean，Spring Cloud LoadBalancer会使用它来查找服务实例。
- ServiceInstanceListSuppliers.from("demo-server", ...)：这里的"demo-server"必须与你的@FeignClient注解中name属性的值完全一致。它告诉负载均衡器，当FeignClient请求"demo-server"时，应该使用提供的服务实例。
- new DefaultServiceInstance(...)：创建一个指向MockWebServer的服务实例。demoServer.getHostName()和demoServer.getPort()动态获取MockWebServer的地址和端口。
编写单元测试
有了上述配置，你就可以像下面这样编写针对FeignClient的单元测试了：
- 排队响应: 在每个测试方法中，使用demoServer.enqueue(new MockResponse()...)来定义MockWebServer将返回的下一个HTTP响应。你可以设置状态码、响应头、响应体等。
- 调用FeignClient: 直接调用你注入的FeignClient实例的方法。
- 断言结果: 根据你排队的响应，断言FeignClient的行为是否符合预期，例如是否抛出了异常（如FeignException）、是否返回了正确的业务数据等。
注意事项与最佳实践
- 服务名匹配: 确保ServiceInstanceListSupplier中提供的服务名（例如"demo-server"）与你的@FeignClient(name = "...")注解中的name属性值完全一致，这是将FeignClient请求路由到MockWebServer的关键。
- 资源清理: 务必在测试结束后关闭MockWebServer，推荐使用@AfterAll注解配合demoServer.shutdown()方法，以避免资源泄露和端口占用问题。
- 测试隔离性: 每个测试方法都应该独立地配置MockWebServer的响应队列，确保测试之间的隔离性。enqueue方法是先进先出（FIFO）的，因此响应的顺序很重要。
-
模拟复杂场景: MockWebServer支持模拟各种复杂的HTTP场景，例如：
- 延迟响应: setBodyDelay(long delay, TimeUnit unit)
- 网络故障: throttleBody(long bytesPerSecond, long period, TimeUnit unit)
- 重定向: setResponseCode(301).addHeader("Location", "/new/path")
- 认证: 模拟401/403响应。
- FeignClient配置: 如果你的FeignClient有自定义的配置（如超时、重试等），这些配置在@SpringBootTest环境中依然会生效，你需要确保你的MockWebServer响应能够配合这些配置进行测试。
总结
通过将MockWebServer与Spring Cloud LoadBalancer集成，我们为FeignClient提供了一种强大且高效的单元测试方法。这种方法不仅能够隔离外部服务依赖，显著提升测试的执行速度和稳定性，还能让我们精确控制HTTP响应，从而全面验证FeignClient在各种正常和异常场景下的行为。掌握这种测试策略对于构建健壮的微服务应用至关重要。
