將 WireMock 與 Spring Boot 集成
1. 簡介
在開發 Web 應用程式時，測試 REST API 等外部相依性可能具有挑戰性。進行網路呼叫很慢且不可靠，因為第三方服務可能無法使用或傳回意外資料。我們必須找到一種模擬外部服務的強大方法來保證一致且可靠的應用程式測試。這就是WireMock 的用武之地。
WireMock 是一個強大的 HTTP 模擬伺服器，允許我們存根和驗證 HTTP 請求。它提供了一個受控的測試環境，確保我們的整合測試快速、可重複且獨立於外部系統。
在本教程中，我們將探討如何將 WireMock 整合到 Spring Boot 專案中並使用它來編寫全面的測試。
2. Maven 依賴
要將 WireMock 與 Spring Boot 一起使用，我們需要在pom.xml中包含[wiremock-spring-boot](https://mvnrepository.com/artifact/org.wiremock.integrations/wiremock-spring-boot)依賴項：
<dependency>
<groupId>org.wiremock.integrations</groupId>
<artifactId>wiremock-spring-boot</artifactId>
<version>3.9.0</version>
<scope>test</scope>
</dependency>這種依賴關係提供了 WireMock 和 Spring Boot 測試框架之間的無縫整合。
3. 編寫基本的 WireMock 測試
在處理更複雜的場景之前，我們先寫一個簡單的 WireMock 測試。我們必須保證我們的 Spring Boot 應用程式能夠與外部 API 正確互動。透過使用@SpringBootTest和@EnableWireMock註釋，WireMock 在我們的測試環境中啟用。然後，我們可以定義一個簡單的測試案例來驗證 API 行為：
@SpringBootTest(classes = SimpleWiremockTest.AppConfiguration.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@EnableWireMock
class SimpleWiremockTest {
@Value("${wiremock.server.baseUrl}")
private String wireMockUrl;
@Autowired
private TestRestTemplate restTemplate;
@Test
void givenWireMockStub_whenGetPing_thenReturnsPong() {
stubFor(get("/ping").willReturn(ok("pong")));
ResponseEntity<String> response = restTemplate.getForEntity(wireMockUrl + "/ping", String.class);
Assertions.assertEquals("pong", response.getBody());
}
@SpringBootApplication
static class AppConfiguration {}
}
在這個測試中，我們使用@EnableWireMock註解為測試環境啟動一個嵌入式WireMock伺服器。 @Value(“${wiremock.server.baseUrl}”)註解從屬性檔案中檢索 WireMock 的基本 URL。測試方法存根端點/ping以傳回帶有 HTTP 200 狀態碼的「pong」。然後，我們使用TestRestTemplate發出實際的 HTTP 請求並驗證回應主體是否與預期值相符。這確保我們的應用程式正確地與模擬的外部服務通訊。
4. 讓測試更加複雜
現在我們有了一個基本的測試，讓我們擴展我們的範例來模擬傳回 JSON 回應並處理各種狀態碼的 REST API。這將幫助我們驗證我們的應用程式如何處理不同的 API 行為。
**4.1.**對 JSON 回應進行存根
REST API 中的一個常見場景是傳回結構化的 JSON 回應。我們也可以使用 Wiremock 存根來模擬這種情況：
@Test
void givenWireMockStub_whenGetGreeting_thenReturnsMockedJsonResponse() {
String mockResponse = "{\"message\": \"Hello, Baeldung!\"}";
stubFor(get("/api/greeting")
.willReturn(okJson(mockResponse)));
ResponseEntity<String> response = restTemplate.getForEntity(wireMockUrl + "/api/greeting", String.class);
Assertions.assertEquals(HttpStatus.OK, response.getStatusCode());
Assertions.assertEquals(mockResponse, response.getBody());
}在這個測試中，我們對/api/greeting發送一個 GET 請求，該請求傳回一個包含問候訊息的 JSON 回應。然後，我們請求 WireMock 伺服器驗證回應狀態碼是否為 200 OK，以及正文是否與預期的 JSON 結構相符。
4.2.模擬錯誤響應
我們都知道事情並不總是按照預期進行，特別是在 Web 開發中，一些外部呼叫可能會傳回錯誤。為了做好準備，我們還可以模擬錯誤訊息，以便我們的應用程式可以對此做出適當的回應：
@Test
void givenWireMockStub_whenGetUnknownResource_thenReturnsNotFound() {
stubFor(get("/api/unknown").willReturn(aResponse().withStatus(404)));
ResponseEntity<String> response = restTemplate.getForEntity(wireMockUrl + "/api/unknown", String.class);
Assertions.assertEquals(HttpStatus.NOT_FOUND, response.getStatusCode());
}5. 注入WireMock伺服器
在更複雜的場景中，我們可能需要管理多個 WireMock 實例或使用特定的設定來配置它們。 WireMock 讓我們可以使用@InjectWireMock註解注入和配置多個 WireMock 伺服器。當我們的應用程式與眾多外部服務交互，並且我們想要獨立模擬每個服務時，這特別有用。
5.1.注入單一 WireMock 伺服器
讓我們先將單一 WireMock 伺服器注入到我們的測試類別中。模擬單一外部服務時，此方法很有用：
@SpringBootTest(classes = SimpleWiremockTest.AppConfiguration.class,
webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@EnableWireMock({
@ConfigureWireMock(name = "user-service", port = 8081),
})
public class InjectedWiremockTest {
@InjectWireMock("user-service")
WireMockServer mockUserService;
@Autowired
private TestRestTemplate restTemplate;
@Test
void givenEmptyUserList_whenFetchingUsers_thenReturnsEmptyList() {
mockUserService.stubFor(get("/users").willReturn(okJson("[]")));
ResponseEntity<String> response = restTemplate.getForEntity(
"http://localhost:8081/users",
String.class);
Assertions.assertEquals(HttpStatus.OK, response.getStatusCode());
Assertions.assertEquals("[]", response.getBody());
}
}與先前的方法不同，先前使用@EnableWireMock在測試類別層級啟用 WireMock 而無需明確注入，而此方法透過注入命名的 WireMock 伺服器實例來實現更精細的控制。 @ConfigureWireMock註解明確定義了 WireMock 實例的名稱和端口，方便管理不同測試案例中的多個外部服務。
@InjectWireMock(“user-service”)允許我們直接存取 WireMockServer 實例，以便在我們的測試方法中動態配置和管理其行為。
5.2.注入多個 WireMock 伺服器
如果我們的應用程式與多個外部服務交互，我們可能需要使用單獨的 WireMock 實例來模擬多個 API。 WireMock 允許我們為每個執行個體配置和指定不同的名稱和連接埠：
@SpringBootTest(classes = SimpleWiremockTest.AppConfiguration.class,
webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@EnableWireMock({
@ConfigureWireMock(name = "user-service", port = 8081),
@ConfigureWireMock(name = "product-service", port = 8082)
})
public class InjectedWiremockTest {
@InjectWireMock("user-service")
WireMockServer mockUserService;
@InjectWireMock("product-service")
WireMockServer mockProductService;
@Autowired
private TestRestTemplate restTemplate;
@Test
void givenUserAndProductLists_whenFetchingUsersAndProducts_thenReturnsMockedData() {
mockUserService.stubFor(get("/users")
.willReturn(okJson("[{\"id\": 1, \"name\": \"John\"}]")));
mockProductService.stubFor(get("/products")
.willReturn(okJson("[{\"id\": 101, \"name\": \"Laptop\"}]")));
ResponseEntity<String> userResponse = restTemplate
.getForEntity("http://localhost:8081/users", String.class);
ResponseEntity<String> productResponse = restTemplate
.getForEntity("http://localhost:8082/products", String.class);
Assertions.assertEquals(HttpStatus.OK, userResponse.getStatusCode());
Assertions.assertEquals("[{\"id\": 1, \"name\": \"John\"}]", userResponse.getBody());
Assertions.assertEquals(HttpStatus.OK, productResponse.getStatusCode());
Assertions.assertEquals("[{\"id\": 101, \"name\": \"Laptop\"}]", productResponse.getBody());
}
}我們隔離了服務，確保對一個模擬伺服器的變更不會幹擾其他伺服器。透過注入多個WireMock實例，我們可以充分模擬複雜的服務交互，使我們的測試更加準確和可靠。這種方法在微服務架構中特別有益，因為其中不同的元件與各種外部服務進行通訊。
6. 結論
WireMock 是一個用於測試 Spring Boot 應用程式中的外部相依性的強大工具。在本文中，我們創建了可靠、可重複且獨立的測試，而無需依賴實際的第三方服務。我們從一個簡單的測試開始，然後將其發展為更高級的場景，包括注入多個 WireMock 伺服器。
透過這些技術，我們可以確保我們的應用程式正確處理外部 API 回應，無論它們會傳回預期資料還是錯誤。所有範例和程式碼片段的實作都可以在 GitHub 上找到。