Java 单元测试怎么用 WireMock 模拟外部接口

小敏酱_4101

小敏酱_4101

2026-11-19

773人浏览

原创

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

Java 单元测试怎么用 WireMock 模拟外部接口

如何配置 WireMock 实例以拦截特定 URL 的请求

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

Java 单元测试怎么用 WireMock 模拟外部接口

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 即可。

如何定义复杂的请求匹配规则与动态响应

定义 Stub 时,除了基础的 URL 路径匹配,还可以针对 HTTP 方法、Header 头信息以及 Query 参数进行精细化控制。对于需要返回不同响应的场景,可以使用 `aResponse()` 链式调用设置状态码、延迟时间和响应体。若需根据请求内容动态生成响应,可结合 `DynamicResponseTransformer` 实现更灵活的处理逻辑,但在大多数单元测试中,静态 Stub 已足够覆盖边界条件。

Java基础版
Java基础版

编写健壮 Java 代码的基础能力,覆盖空指针防护、相等性判断与基础异常处理。

下载

Java 单元测试怎么用 WireMock 模拟外部接口

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 值,以及业务逻辑是否对空列表进行了防御性编程。通过这种方式,可以在不依赖真实外部服务的情况下,全面覆盖异常路径的测试需求。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

12937

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

10002

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

8492

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1344

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1068

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1616

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3389

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20611

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1475

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习