自定义WireMock扩展实践指南

2501_90323865

491人浏览 · 2025-11-13 00:52:54

2501_90323865 · 2025-11-13 00:52:54 发布

引言

在现代软件开发中，测试是确保代码质量的关键步骤之一。WireMock作为一个流行的API模拟工具，允许我们模拟各种HTTP响应来测试我们的应用。最近，我在尝试使用WireMock时遇到了一个挑战：如何使用Java类而不是JSON来定义复杂的模拟逻辑。本文将通过我的实践经验，详细介绍如何在WireMock中集成Java自定义逻辑。

背景知识

WireMock默认使用JSON文件来定义模拟响应，但有时我们需要更复杂的逻辑，这时Java类便派上了用场。通过扩展WireMock，我们可以编写自定义的模拟逻辑，提高模拟的灵活性和可控性。

准备工作

启动WireMock容器：首先，我们需要在Docker中启动WireMock容器。
```
docker run -d --name wiremock -p 8080:8080 wiremock/wiremock
```

下载并配置扩展：从WireMock的文档网站下载Webhooks扩展，并将其放入extensions文件夹中。

docker cp wiremock-webhooks-extension-3.4.0.jar wiremock:/home/wiremock/extensions/

然后添加启动参数：

docker run -d --name wiremock -p 8080:8080 -e WIREMOCK_OPTIONS="--extensions org.wiremock.webhooks.Webhooks" wiremock/wiremock

实现自定义模拟逻辑

编写自定义模拟类：我选择使用Kotlin来编写一个简单的模拟类：

class WireMockStub : ResponseDefinitionTransformerV2 {
    override fun getName(): String {
        return "WireMockStub"
    }

    override fun transform(serveEvent: ServeEvent): ResponseDefinition {
        return if (serveEvent.request.url == "/api/webhook/test") {
            ResponseDefinitionBuilder
                .responseDefinition()
                .withStatus(200)
                .withBody("{\"testField\": true}")
                .build()
        } else {
            ResponseDefinition()
        }
    }
}

编译和打包：确保使用Java 11编译该类，然后将生成的JAR文件放置在合适的位置。
- 在mappings文件夹中：
```
docker cp my_jarnik.jar wiremock:/home/wiremock/mappings/
```
- 在extensions文件夹中：
```
docker cp my_jarnik.jar wiremock:/home/wiremock/extensions/
```
配置WireMock：
- 如果放在extensions中，需要在启动参数中指定：
```
WIREMOCK_OPTIONS="--extensions org.wiremock.webhooks.Webhooks,ru.rubbles.gap.wiremock.webhook.WireMockStub"
```
- 如果放在mappings中，WireMock会自动识别。