测试客户端应用程序

您可以使用客户端测试来测试内部使用 RestTemplate 的代码。核心思想是声明预期的请求并提供“存根”响应，这样您就可以专注于独立测试代码（即无需运行服务器）。以下示例展示了如何实现：

  • Java

  • Kotlin

RestTemplate restTemplate = new RestTemplate();

MockRestServiceServer mockServer = MockRestServiceServer.bindTo(restTemplate).build();
mockServer.expect(requestTo("/greeting")).andRespond(withSuccess());

// Test code that uses the above RestTemplate ...

mockServer.verify();
val restTemplate = RestTemplate()

val mockServer = MockRestServiceServer.bindTo(restTemplate).build()
mockServer.expect(requestTo("/greeting")).andRespond(withSuccess())

// Test code that uses the above RestTemplate ...

mockServer.verify()

在前面的示例中，MockRestServiceServer（客户端 REST 测试的核心类）使用自定义的 ClientHttpRequestFactory 配置 RestTemplate，该工厂会针对期望断言实际请求并返回“存根”响应。在本例中，我们期望一个对 /greeting 的请求，并希望返回一个带有 text/plain 内容的 200 响应。我们可以根据需要定义额外的预期请求和存根响应。当我们定义了预期请求和存根响应后，RestTemplate 可以在客户端代码中照常使用。测试结束时，可以使用 mockServer.verify() 来验证所有期望是否都已满足。

默认情况下，请求的顺序与期望声明的顺序一致。您可以在构建服务器时设置 ignoreExpectOrder 选项，在这种情况下，所有期望都会被检查（按顺序）以找到与给定请求匹配的那个。这意味着请求可以按任意顺序到达。以下示例使用了 ignoreExpectOrder：

  • Java

  • Kotlin

server = MockRestServiceServer.bindTo(restTemplate).ignoreExpectOrder(true).build();
server = MockRestServiceServer.bindTo(restTemplate).ignoreExpectOrder(true).build()

即使默认情况下请求是无序的，每个请求也只能运行一次。expect 方法提供了一个重载变体，它接受一个 ExpectedCount 参数，用于指定计数范围（例如，once、manyTimes、max、min、between 等）。以下示例使用了 times：

  • Java

  • Kotlin

RestTemplate restTemplate = new RestTemplate();

MockRestServiceServer mockServer = MockRestServiceServer.bindTo(restTemplate).build();
mockServer.expect(times(2), requestTo("/something")).andRespond(withSuccess());
mockServer.expect(times(3), requestTo("/somewhere")).andRespond(withSuccess());

// ...

mockServer.verify();
val restTemplate = RestTemplate()

val mockServer = MockRestServiceServer.bindTo(restTemplate).build()
mockServer.expect(times(2), requestTo("/something")).andRespond(withSuccess())
mockServer.expect(times(3), requestTo("/somewhere")).andRespond(withSuccess())

// ...

mockServer.verify()

请注意，当 ignoreExpectOrder 未设置（默认值），并且请求期望按声明顺序进行时，该顺序仅适用于任何预期请求的第一次出现。例如，如果期望 "/something" 出现两次，然后期望 "/somewhere" 出现三次，那么在 "/somewhere" 的请求出现之前，应该有一个对 "/something" 的请求，但除此之外，后续的 "/something" 和 "/somewhere" 请求可以在任何时候出现。

作为上述方法的替代方案，客户端测试支持还提供了一个 ClientHttpRequestFactory 实现，您可以将其配置到 RestTemplate 中，以将其绑定到 MockMvc 实例。这允许使用实际的服务器端逻辑处理请求，但无需运行服务器。以下示例展示了如何实现：

  • Java

  • Kotlin

MockMvc mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build();
this.restTemplate = new RestTemplate(new MockMvcClientHttpRequestFactory(mockMvc));

// Test code that uses the above RestTemplate ...
val mockMvc = MockMvcBuilders.webAppContextSetup(this.wac).build()
restTemplate = RestTemplate(MockMvcClientHttpRequestFactory(mockMvc))

// Test code that uses the above RestTemplate ...

在某些情况下，可能需要实际调用远程服务而不是模拟响应。以下示例展示了如何通过 ExecutingResponseCreator 来实现：

  • Java

  • Kotlin

RestTemplate restTemplate = new RestTemplate();

// Create ExecutingResponseCreator with the original request factory
ExecutingResponseCreator withActualResponse = new ExecutingResponseCreator(restTemplate.getRequestFactory());

MockRestServiceServer mockServer = MockRestServiceServer.bindTo(restTemplate).build();
mockServer.expect(requestTo("/profile")).andRespond(withSuccess());
mockServer.expect(requestTo("/quoteOfTheDay")).andRespond(withActualResponse);

// Test code that uses the above RestTemplate ...

mockServer.verify();
val restTemplate = RestTemplate()

// Create ExecutingResponseCreator with the original request factory
val withActualResponse = new ExecutingResponseCreator(restTemplate.getRequestFactory())

val mockServer = MockRestServiceServer.bindTo(restTemplate).build()
mockServer.expect(requestTo("/profile")).andRespond(withSuccess())
mockServer.expect(requestTo("/quoteOfTheDay")).andRespond(withActualResponse)

// Test code that uses the above RestTemplate ...

mockServer.verify()

在前面的示例中，我们在 MockRestServiceServer 用不同的工厂替换 RestTemplate 的 ClientHttpRequestFactory 之前，使用 RestTemplate 的工厂创建了 ExecutingResponseCreator。然后，我们定义了两种响应类型的期望：

  • 对于 /profile 端点，返回一个存根 200 响应（不会执行实际请求）

  • 通过调用 /quoteOfTheDay 端点获得的响应

在第二种情况下，请求通过先前捕获的 ClientHttpRequestFactory 执行。根据 RestTemplate 最初的配置方式，这会生成一个响应，该响应可能来自实际的远程服务器。

静态导入

与服务器端测试一样，客户端测试的流畅 API 需要一些静态导入。通过搜索 MockRest* 很容易找到它们。Eclipse 用户应将 MockRestRequestMatchers.* 和 MockRestResponseCreators.* 添加到 Eclipse 偏好设置中 Java → Editor → Content Assist → Favorites 下的“favorite static members”（收藏夹静态成员）。这允许在输入静态方法名称的第一个字符后使用内容辅助。其他 IDE（如 IntelliJ）可能不需要任何额外的配置。请检查对静态成员代码补全的支持。

客户端 REST 测试的更多示例

Spring MVC Test 自己的测试包含客户端 REST 测试的示例。