此版本仍在开发中,尚未被视为稳定版本。最新的稳定版本请使用 Spring Framework 6.1.13spring-doc.cn

此版本仍在开发中,尚未被视为稳定版本。最新的稳定版本请使用 Spring Framework 6.1.13spring-doc.cn

您可以使用客户端测试来测试内部使用 .这 这个想法是声明预期的请求并提供 “stub” 响应,以便您可以 专注于隔离测试代码 (即,不运行服务器) 。以下内容 示例展示了如何做到这一点:RestTemplatespring-doc.cn

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()

在前面的示例中,(客户端 REST 的中心类 tests) 配置自定义 根据预期断言实际请求并返回 “stub” 响应。在这个 case 中,我们期望请求并希望返回带有 content 的 200 响应。我们可以将其他预期请求和存根响应定义为 需要。当我们定义预期的请求和存根响应时,可以是 像往常一样在客户端代码中使用。在测试结束时,可以 用于验证是否已满足所有期望。MockRestServiceServerRestTemplateClientHttpRequestFactory/greetingtext/plainRestTemplatemockServer.verify()spring-doc.cn

默认情况下,请求应按照声明 expectations 的顺序进行。你 可以在构建服务器时设置选项,在这种情况下,所有 检查 expectations 以查找给定请求的匹配项。这意味着 请求可以按任何顺序出现。以下示例使用 :ignoreExpectOrderignoreExpectOrderspring-doc.cn

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

即使默认情况下使用无序请求,每个请求也只允许运行一次。 该方法提供了一个重载的变体,该变体接受指定计数范围 (的参数,例如 、 、 、 、 等)。以下示例使用 :expectExpectedCountoncemanyTimesmaxminbetweentimesspring-doc.cn

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()

请注意,when 未设置(默认值),因此,请求 应按声明顺序排列,则该顺序仅适用于任何 预期请求。例如,如果 “/something” 需要两次,后跟 “/somewhere”三次,那么在出现之前应该有一个对 “/something” 的请求 对 “/somewhere” 的请求,但是,除了后面的 “/something” 和 “/somewhere” 之外, 请求可能随时出现。ignoreExpectOrderspring-doc.cn

作为上述所有方法的替代方案,客户端测试支持还提供了一个实现,您可以将其配置为 将其绑定到实例。这允许使用实际的服务器端处理请求 logic 的 logic,但没有运行 server。以下示例显示了如何执行此操作:ClientHttpRequestFactoryRestTemplateMockMvcspring-doc.cn

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 ...

在某些情况下,可能需要改为执行对远程服务的实际调用 嘲笑回应。以下示例演示如何通过以下方式执行此操作:ExecutingResponseCreatorspring-doc.cn

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()

在前面的示例中,我们使用 from the before 替换 它与另一个模拟响应的 it 一起使用。 然后,我们用两种响应来定义期望:ExecutingResponseCreatorClientHttpRequestFactoryRestTemplateMockRestServiceServerspring-doc.cn

  • 终端节点的存根响应(不会执行实际请求)200/profilespring-doc.cn

  • 通过调用终端节点获取的响应/quoteOfTheDayspring-doc.cn

在第二种情况下,请求通过 早些时候捕获。这会生成一个响应,例如,该响应可能来自实际的远程服务器 取决于最初的配置方式。ClientHttpRequestFactoryRestTemplatespring-doc.cn

静态导入

与服务器端测试一样,用于客户端测试的 Fluent API 需要一些静态 进口。通过搜索 很容易找到这些 .Eclipse 用户应添加 和 “→→ Content Editor”下的 Eclipse 首选项中的 “favorite static members” 协助 → 收藏夹。这允许在键入 静态方法名称。其他 IDE(如 IntelliJ)可能不需要任何其他 配置。检查静态成员是否支持代码完成。MockRest*MockRestRequestMatchers.*MockRestResponseCreators.*spring-doc.cn

客户端 REST 测试的更多示例

Spring MVC Test 自己的测试包括示例 客户端 REST 测试的测试。spring-doc.cn