1. why
开发一个web服务时不可避免得会涉及到对其他服务的api调用，可能是内部开发的一个微服务也可能是外部供应商提供的服务
调用其他服务给软件测试带来了困难，因为这些服务显然不是随时都能调用的， 可能是因为测试环境与生产环境处于不同网络环境下也可能是因为调用相应的api会导致业务状态的变化
此时一个可行的方法就是在测试环境模拟这些被调用的 api，即 mock，
wiremock 就是一个非常流行非常强大的 api mock工具
2. quickstart
wiremock 支持使用配置来定义需要 mock的api，例如下面的配置就模拟了一个地址为 /api/hello 请求方法为 GET 的接口，
接口响应为 Hello World
{
"request": {
"method": "GET",
"url": "/api/hello"
},
"response": {
"status": 200,
"body": "Hello world"
}
}3. how
wiremock 一般有两种使用方法， unit test 和 standalone
3.1. unit test
public class WiremockSample {
@Test
void test() {
WireMockServer wireMockServer = new WireMockServer();
wireMockServer.start();
wireMockServer.addStubMapping(
stubFor(get("/api/hello").willReturn(ok("Hello World"))));
RestTemplate restTemplate = new RestTemplate();
String response = restTemplate.getForObject(wireMockServer.url("/api/hello"), String.class);
assertEquals("Hello World", response);
wireMockServer.stop();
}
}
3.2. standalone
访问 wiremock 的 官方网站，在 Downloads 部分选择 Standalone 下载jar包并使用 java -jar 启动服务
wiremock 服务启动后jar包同级目录会创建 mappings 和 __files 两个文件夹，
上文定义的json文件放在 mappings 目录中重启服务访问 http://localhost:8080/api/hello 就能看到返回了 Hello World
服务启动后还可以访问 /__admin/mappings 查看当前已经加载的mock数据
3.2.1. jsonBody
如果响应是json格式则可以使用 jsonBody 声明响应内容避免json字符串转义，此时一般还需要使用 headers 配置响应头
{
"request": {
"method": "GET",
"url": "/api/hello"
},
"response": {
"status": 200,
"jsonBody": {
"Hello": "World"
},
"headers": {
"Content-Type": "application/json"
}
}
}3.2.2. bodyFile
如果响应内容比较多还可以使用 bodyFileName 声明响应内容的文件，文件在 __files 文件夹中
{
"request": {
"method": "GET",
"url": "/body-file"
},
"response": {
"status": 200,
"bodyFileName": "response.json",
"headers": {
"Content-Type": "application/json"
}
}
}3.2.3. request mapping
wiremock 的工作原理和 spring mvc 相似，是用请求信息和定义的mock配置进行匹配，如果匹配成功就返回mock配置中的响应，否则返回404
上文的几个示例使用了请求方法和url匹配 mappings 文件夹中的mock配置，实际上 wiremock 还支持很多更复杂的匹配方式
{
"request": {
"urlPattern": "/your/([a-z]*)\\?and=query",
...
},
...
}{
"request": {
"urlPath": "/your/url",
...
},
...
}{
"request" : {
"urlPathTemplate" : "/v1/contacts/{contactId}/addresses/{addressId}",
"method" : "GET",
"pathParameters" : {
"contactId" : {
"equalTo" : "12345"
},
"addressId" : {
"equalTo" : "99876"
}
}
},
"response" : {
"status" : 200
}
}更多复杂匹配方式参考 官方文档
3.2.4. response template
上文示例的响应都是静态内容不会随着请求变化，而 response template 则能赋予响应一定的动态能力
{
"request": {
"urlPathPattern": "/static/.*",
"method": "GET"
},
"response": {
"status": 200,
"jsonBody": {
"file": "{{request.pathSegments.[1]}}",
"time": "{{now}}"
},
"transformers": ["response-template"]
}
}{{request.pathSegments.[1]}} 和 {{now}} 都是 wiremock 支持的特殊语法分别表示url第二段和当前时间，
更多语法细节参考 官方文档
3.2.5. single file multiple mappings
mappings 文件夹中一个文件可以声明多个mock的api
{
"mappings": [
{
"request": {
"method": "GET",
"url": "/one"
},
"response": {
"status": 200
}
},
{
"id": "8c5db8b0-2db4-4ad7-a99f-38c9b00da3f7",
"request": {
"url": "/two"
},
"response": {
"body": "Updated"
}
}
]
}3.2.6. simulating faults
wiremock 还支持模拟api请求时的故障场景，例如响应太慢
{
"request": {
"method": "GET",
"url": "/delayed"
},
"response": {
"status": 200,
"fixedDelayMilliseconds": 2000
}
}更多故障场景参考 官方文档
3.2.7. recorder
wiremock 中还有一个强大的工具 recorder ，使用它可以免去手动编写mock文件的过程，可以在服务启动后访问 /__admin/recorder 使用
recoder 的核心是一个代理，它在目标服务返回响应后先在 mappings 文件夹中保存一份再返回给client，
今后client再发送同样的请求就可以直接使用已经保存的内容来响应
3.2.8. command line options
使用 java -jar 启动 wiremock 服务时支持很多命令行参数，此次列举常用的几个，
完整参数列表参考 官方文档
- --port
-
服务端口号，例如
--port 9999 - --root-dir
-
__files和mappings目录所属的根目录
3.3. api template library
从上面对 wiremock 的介绍可以看出最重要的就是编写mock配置文件，
如果多个客户端服务请求的是同一个目标服务那就可以相同的mock配置文件，
因此 wiremock 为很多大型的服务供应商都已经提供了现成的mock配置文件，
例如 GitHub、Twitter、Amazon Cloud 等，
如果使用了这些供应商的api就可以直接在 api template library 上下载想应的mock配置文件
3.4. extensibility
wiremock 支持使用 Extension api 实现更复杂的功能，详情参考 官方文档
