WireMock詳解

一、WireMock官網

WireMock是一個用於模擬HTTP服務的工具，可以用來測試以及模擬外部依賴的API。它可以完全替代對外部服務的依賴，同時也可以提供錯誤的響應，以便更好地測試客戶端代碼的魯棒性。

WireMock的官網提供了非常詳細的文檔，包括使用指南，快速開始，常見問題解答以及代碼示例等。

<dependency>
    <groupId>com.github.tomakehurst</groupId>
    <artifactId>wiremock-standalone</artifactId>
    <version>2.27.2</version>
    <scope>test</scope>
</dependency>

二、WireMock JSON

WireMock大部分實現都是通過JSON實現的，它使用JSON描述來定義HTTP請求和響應。下面是一個簡單的JSON文件示例：

{
  "request": {
    "method": "GET",
    "url": "/foo"
  },
  "response": {
    "status": 200,
    "body": "Hello world!"
  }
}

上面的JSON文件描述了對`/foo`路徑的GET請求將收到一個200響應和`Hello world!`作為響應主體。

三、WireMock教程

WireMock的教程提供了非常詳細的介紹和使用指南，包括如何啟動WireMock，如何使用WireMock API編寫測試等。教程還提供了一些示例，這些示例可以為您提供一個很好的起點。

public class WireMockTest {

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(8089);

    @Test
    public void exampleTest() {
        stubFor(get(urlEqualTo("/my/resource"))
            .withHeader("Accept", equalTo("text/xml"))
            .willReturn(aResponse()
                .withStatus(200)
                .withHeader("Content-Type", "text/xml")
                .withBody("Some content")));

        MyClient client = new MyClient();
        String result = client.get("http://localhost:8089/my/resource");

        assertEquals(result, "Some content");
    }

}

上面的示例展示了如何使用WireMock來模擬對`/my/resource`路徑的HTTP GET請求，並驗證客戶端代碼是否會正確地響應。它還演示了如何與WireMock集成，使用WireMock API進行配置和編寫測試。

四、WireMock高級用法

WireMock提供了許多高級功能，以方便模擬測試環境。例如，您可以使用WireMock延遲響應時間，以模擬慢速服務器的響應。您還可以使用WireMock動態創建響應，並使用模板來自動生成響應主體。

public class WireMockAdvancedTest {

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(8089);

    @Test
    public void exampleTest() {
        stubFor(get(urlEqualTo("/users"))
            .willReturn(aResponse()
                .withTransformers("response-template")
                .withTransformerParameter("template", "Hello, {{request.query.fullName}}!")));

        MyClient client = new MyClient();
        String result = client.get("http://localhost:8089/users?fullName=John+Doe");

        assertEquals(result, "Hello, John Doe!");
    }

}

上面的示例演示了如何使用WireMock響應模板來動態創建響應，這裡的響應參數取自請求參數中的`fullName`。

五、WireMock客戶端證書

WireMock還允許您模擬要求客戶端證書的SSL服務，以便進行更全面的測試。它提供了一些方便的方法，用於配置客戶端證書和驗證，以便更好地模擬實際的SSL服務。

public class WireMockSslTest {

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(wireMockConfig()
        .httpsPort(8443)
        .keystorePath("/path/to/keystore")
        .keystorePassword("password"));

    @Test
    public void exampleTest() {
        // Test goes here
    }

}

上面的示例演示了如何使用WireMock配置指定端口和客戶端證書，以方便進行SSL模擬測試。

六、WireMock請求正文匹配

WireMock還支持使用請求正文進行匹配，以更精確地模擬服務。您可以使用正則表達式、JSON Path或XPath等方式對請求正文進行匹配。

public class WireMockRequestBodyTest {

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(8089);

    @Test
    public void exampleTest() {
        stubFor(post(urlEqualTo("/user"))
            .withRequestBody(equalToJson("{\"name\": \"John Doe\"}"))
            .willReturn(aResponse()
                .withStatus(200)));

        MyClient client = new MyClient();
        boolean result = client.post("http://localhost:8089/user", "{\"name\": \"John Doe\"}");

        assertTrue(result);
    }

}

上面的示例演示了如何使用WireMock對請求正文進行匹配，並模擬一個滿足條件的HTTP POST請求。

七、WireMock根據請求參數返回結果

WireMock還支持基於請求參數返回相關結果。您可以使用參數鍵和值，以及正則表達式和匹配器來配置請求參數匹配。

public class WireMockRequestParameterTest {

    @Rule
    public WireMockRule wireMockRule = new WireMockRule(8089);

    @Test
    public void exampleTest() {
        stubFor(get(urlPathEqualTo("/user"))
            .withQueryParam("name", equalTo("John Doe"))
            .willReturn(aResponse()
                .withStatus(200)));

        MyClient client = new MyClient();
        boolean result = client.get("http://localhost:8089/user?name=John+Doe");

        assertTrue(result);
    }

}

上面的示例演示了如何使用WireMock根據請求參數返回相關結果，以驗證客戶端代碼是否正確地處理了這些請求參數。