30分钟上手WireMock：接口模拟工具拯救你的联调效率

30分钟上手WireMock：接口模拟工具拯救你的联调效率

【免费下载链接】wiremock 项目地址: https://gitcode.com/gh_mirrors/wir/wiremock

你是否还在为第三方API不稳定导致开发阻塞而烦恼？是否在前端开发时苦等后端接口就绪？WireMock作为开源的API模拟工具，能让你脱离真实服务独立开发。本文将带你从零开始使用WireMock，掌握接口模拟核心技能，解决90%的联调痛点。

什么是WireMock

WireMock是一个轻量级的HTTP模拟服务（Mock Server），允许开发者创建虚拟API接口来模拟后端服务行为。通过WireMockServer.java核心类实现HTTP请求的拦截与响应，支持请求匹配、动态响应、录制回放等高级功能。

快速启动服务

独立运行模式

从官网下载最新版JAR包后，执行以下命令启动：

java -jar wiremock-jre8-standalone-2.35.0.jar --port 8080

服务启动后可通过 http://localhost:8080/__admin 访问管理界面。

集成到Java项目

在Maven项目中添加依赖：

<dependency>
    <groupId>com.github.tomakehurst</groupId>
    <artifactId>wiremock</artifactId>
    <version>2.35.0</version>
    <scope>test</scope>
</dependency>

通过Java代码启动服务：

WireMockServer wireMockServer = new WireMockServer(WireMockConfiguration.options().port(8080));
wireMockServer.start();

创建第一个模拟接口

JSON配置方式

在mappings目录下创建hello-world.json文件：

{
  "request": {
    "method": "GET",
    "url": "/api/hello"
  },
  "response": {
    "status": 200,
    "jsonBody": {
      "message": "Hello from WireMock"
    },
    "headers": {
      "Content-Type": "application/json"
    }
  }
}

配置文件存放路径：sample-war/src/main/webapp/WEB-INF/wiremock/mappings/mytest-mapping.json

编程方式创建

使用Java客户端API：

WireMock.stubFor(get(urlEqualTo("/api/hello"))
    .willReturn(aResponse()
        .withStatus(200)
        .withHeader("Content-Type", "application/json")
        .withJsonBody(new JsonObject().put("message", "Hello from WireMock"))));

请求匹配规则

WireMock支持多种请求匹配策略，常用匹配规则如下表：

匹配类型	用法示例	适用场景
URL精确匹配	urlEqualTo("/api/user/1")	固定路径请求
URL正则匹配	urlMatching("/api/user/[0-9]+")	动态参数路径
请求头匹配	withHeader("Authorization", matching("Bearer .+"))	认证校验
请求体匹配	withRequestBody(containing("username"))	表单提交验证

高级功能应用

延迟响应模拟

模拟网络延迟场景：

.willReturn(aResponse()
    .withStatus(200)
    .withFixedDelay(3000) // 延迟3秒响应
    .withBody("Delayed response"))

状态场景管理

模拟多步骤业务流程：

stubFor(post(urlEqualTo("/api/order"))
    .inScenario("Order Process")
    .whenScenarioStateIs(Scenario.STARTED)
    .willReturn(aResponse().withStatus(201).withBody("Order created"))
    .willSetStateTo("ORDER_CREATED"));

stubFor(put(urlEqualTo("/api/order/1"))
    .inScenario("Order Process")
    .whenScenarioStateIs("ORDER_CREATED")
    .willReturn(aResponse().withStatus(200).withBody("Order updated")));

请求录制与回放

录制真实API交互：

java -jar wiremock-jre8-standalone.jar --proxy-all="https://api.example.com" --record-mappings --verbose

录制的请求将自动保存为映射文件，位于sample-war/src/main/webapp/WEB-INF/wiremock/mappings/目录。

测试集成方案

JUnit 5集成

使用WireMockExtension.java实现测试隔离：

@RegisterExtension
static WireMockExtension wireMock = WireMockExtension.newInstance()
    .options(wireMockConfig().dynamicPort())
    .build();

@Test
void shouldReturnHelloWorld() {
    wireMock.stubFor(get("/hello").willReturn(ok("Hello World")));
    
    String response = new RestTemplate()
        .getForObject(wireMock.baseUrl() + "/hello", String.class);
    
    assertEquals("Hello World", response);
}

常见问题解决

跨域问题处理

添加全局响应头配置：

{
  "globalResponseHeaders": {
    "Access-Control-Allow-Origin": "*",
    "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE"
  }
}

动态响应内容

使用Handlebars模板引擎：

{
  "request": { "method": "GET", "url": "/api/user/:id" },
  "response": {
    "status": 200,
    "jsonBody": {
      "id": "{{request.pathSegments.[1]}}",
      "timestamp": "{{now}}"
    }
  }
}

生产级应用建议

1. 版本控制映射文件，存放在mappings/目录进行团队共享
2. 使用环境变量区分配置：--env-mappings-dir=staging-mappings
3. 结合CI/CD流程自动部署：scripts/create-ca-keystore.sh
4. 监控模拟服务健康状态：访问/__admin/health端点

通过本文介绍的方法，你已经掌握WireMock的核心使用技巧。合理运用接口模拟技术，可将前端开发效率提升40%，减少80%的联调阻塞时间。更多高级特性可参考官方文档及示例项目。

提示：定期清理__files/目录下的临时文件，避免磁盘空间占用过大。

【免费下载链接】wiremock 项目地址: https://gitcode.com/gh_mirrors/wir/wiremock