在 java 单元测试中,使用 wiremock 模拟外部接口最稳妥的方式是启动一个独立的 http 服务器,将测试代码中的 http 客户端指向该服务器的本地回环地址。通过配置 `wiremockconfiguration` 指定端口并调用 `start()` 方法即可运行服务,随后利用 `stubfor()` 定义请求匹配规则与响应内容,最后由 junit 的 `@aftereach` 钩子执行 `reset()` 清理状态以保证测试隔离性。

如何配置 WireMock 实例以拦截特定 URL 的请求
配置的核心在于创建 `WireMockServer` 对象并绑定到具体的端口,同时确保测试类能够访问该实例以便进行 Stub 注册和状态重置。通常的做法是在测试类的成员变量中声明该实例,并在 `@BeforeEach` 阶段完成初始化与启动操作。这样当被测代码发起网络请求时,流量会被路由至这个本地进程,从而避免真实的网络 I/O 开销。

import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
public class ExternalApiTest {
private WireMockServer wireMockServer;
@BeforeEach
void setUp() {
// 配置端口为 8089 并启动服务
wireMockServer = new WireMockServer(WireMockConfiguration.options().port(8089));
wireMockServer.start();
// 设置全局基础 URL,供被测代码使用
System.setProperty("api.base.url", "http://localhost:8089");
}
@AfterEach
void tearDown() {
// 清除所有已注册的 stub 和请求记录
wireMockServer.resetAll();
wireMockServer.stop();
}
}
上述代码展示了标准的生命周期管理。在 `setUp` 中,我们实例化了 `WireMockServer` 并传入 `WireMockConfiguration` 来固定监听端口。这一步至关重要,因为如果不指定端口,WireMock 可能会随机分配端口,导致测试不稳定。在 `tearDown` 中,`resetAll()` 方法不仅停止服务,还会清空内存中存储的所有 Stub 映射和请求日志,确保下一个测试用例在一个干净的环境中运行。被测代码只需读取系统属性或环境变量获取 `http://localhost:8089` 作为 Base URL 即可。
立即学习“Java免费学习笔记(深入)”;
如何定义复杂的请求匹配规则与动态响应
定义 Stub 时,除了基础的 URL 路径匹配,还可以针对 HTTP 方法、Header 头信息以及 Query 参数进行精细化控制。对于需要返回不同响应的场景,可以使用 `aResponse()` 链式调用设置状态码、延迟时间和响应体。若需根据请求内容动态生成响应,可结合 `DynamicResponseTransformer` 实现更灵活的处理逻辑,但在大多数单元测试中,静态 Stub 已足够覆盖边界条件。

import static com.github.tomakehurst.wiremock.client.WireMock.*;
// 在 @BeforeEach 或具体测试方法中注册 Stub
wireMockServer.stubFor(get(urlEqualTo("/users/123"))
.withHeader("Authorization", equalTo("Bearer token-abc"))
.willReturn(aResponse()
.withStatus(200)
.withHeader("Content-Type", "application/json")
.withBody("{\"id\": 123, \"name\": \"Alice\"}")))
// 模拟错误场景
wireMockServer.stubFor(post(urlPathEqualTo("/orders"))
.withQueryParam("type", equalTo("express"))
.willReturn(aResponse()
.withStatus(500)
.withBody("Internal Server Error")));
在代码片段中,第一个 Stub 使用了 `get` 方法和 `urlEqualTo` 精确匹配 `/users/123` 路径,并通过 `withHeader` 要求请求必须携带特定的 Authorization 头。如果请求不匹配这些条件,WireMock 将不会返回此 Stub 定义的响应。第二个 Stub 演示了 POST 请求的处理,它匹配 `/orders` 路径且查询参数 `type` 必须为 `express`。通过 `willReturn` 可以自定义 HTTP 状态码、响应头和 Body 内容。这种细粒度的控制使得我们可以轻松模拟成功、参数缺失、权限不足或服务端异常等多种情况,而无需修改被测系统的业务逻辑。
当外部接口返回空值或超时异常时测试代码如何处理
在处理外部接口时,空值(如 JSON 中的 null 字段)和超时是常见的异常情况。WireMock 可以通过配置极短的延迟或直接返回空 JSON 对象来模拟这两种行为。对于超时,可以设置 `withFixedDelay` 为一个大于客户端超时常量的值;对于空值,只需在 `withBody` 中构造包含 null 值的 JSON 字符串。被测代码应当具备相应的容错机制,例如检查 Optional 返回值或捕获 TimeoutException。
// 模拟超时:设置延迟为 5000ms,假设客户端超时时间为 3000ms
wireMockServer.stubFor(get(urlEqualTo("/slow-data"))
.willReturn(aResponse()
.withFixedDelay(5000)
.withBody("{\"data\": null}")));
// 模拟空值响应
wireMockServer.stubFor(get(urlEqualTo("/empty-data"))
.willReturn(aResponse()
.withStatus(200)
.withBody("{\"result\": null, \"items\": []}")));
在上述示例中,第一个 Stub 模拟了一个慢速接口。当被测代码发起请求时,由于 WireMock 强制等待 5000 毫秒才返回响应,如果客户端配置的超时时间小于 5000 毫秒(例如 3000 毫秒),客户端将抛出连接超时或读取超时异常。这有助于验证代码在遇到网络延迟时的重试策略或降级逻辑。第二个 Stub 则返回了一个结构完整但字段为空的 JSON 响应。这用于测试反序列化器是否能正确处理 null 值,以及业务逻辑是否对空列表进行了防御性编程。通过这种方式,可以在不依赖真实外部服务的情况下,全面覆盖异常路径的测试需求。


















