如何在 Java 中模拟 Web 服务器以进行单元测试？ [关闭]

Question

我想使用模拟 Web 服务器创建单元测试。是否有一个用 Java 编写的 Web 服务器，可以通过 JUnit 测试用例轻松启动和停止？

Answer 1

Wire Mock 似乎提供了一组可靠的存根和模拟来测试外部 Web 服务。

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


@Test
public void exactUrlOnly() {
    stubFor(get(urlEqualTo("/some/thing"))
            .willReturn(aResponse()
                .withHeader("Content-Type", "text/plain")
                .withBody("Hello world!")));

    assertThat(testClient.get("/some/thing").statusCode(), is(200));
    assertThat(testClient.get("/some/thing/else").statusCode(), is(404));
}

它也可以与 spock 集成。发现示例here。

Answer 2

您是否尝试使用mock or an embedded 网络服务器？

对于 mock 网络服务器，尝试使用 Mockito 或类似的东西，然后模拟 HttpServletRequest 和 HttpServletResponse 对象，例如：

MyServlet servlet = new MyServlet();
HttpServletRequest mockRequest = mock(HttpServletRequest.class);
HttpServletResponse mockResponse = mock(HttpServletResponse.class);

StringWriter out = new StringWriter();
PrintWriter printOut = new PrintWriter(out);
when(mockResponse.getWriter()).thenReturn(printOut);

servlet.doGet(mockRequest, mockResponse);

verify(mockResponse).setStatus(200);
assertEquals("my content", out.toString());

对于嵌入式网络服务器，您可以使用Jetty，也可以使用use in tests。

Answer 3

您也可以使用 JDK 的 com.sun.net.httpserver.HttpServer 类编写模拟（不需要外部依赖项）。请参阅this blog post 详细说明。

总结：

HttpServer httpServer = HttpServer.create(new InetSocketAddress(8000), 0); // or use InetSocketAddress(0) for ephemeral port
httpServer.createContext("/api/endpoint", new HttpHandler() {
   public void handle(HttpExchange exchange) throws IOException {
      byte[] response = "{\"success\": true}".getBytes();
      exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, response.length);
      exchange.getResponseBody().write(response);
      exchange.close();
   }
});
httpServer.start();

try {
// Do your work...
} finally {
   httpServer.stop(0); // or put this in an @After method or the like
}

Answer 4

试试Simple(Maven) 它很容易嵌入到单元测试中。以 RoundTripTest 和用 Simple 编写的 PostTest 等示例为例。提供如何将服务器嵌入到您的测试用例中的示例。

此外，Simple 比 Jetty 更轻、更快，并且没有依赖项。因此，您不必在类路径中添加多个 jar 文件。您也不必担心WEB-INF/web.xml 或任何其他工件。

Answer 5

另一个不错的选择是MockServer；它提供了一个流畅的界面，您可以使用该界面定义模拟 Web 服务器的行为。

Answer 6

您可以尝试Jadler，它是一个具有流畅的编程Java API 的库，可以在您的测试中存根和模拟http 资源。示例：

onRequest()
    .havingMethodEqualTo("GET")
    .havingPathEqualTo("/accounts/1")
    .havingBody(isEmptyOrNullString())
    .havingHeaderEqualTo("Accept", "application/json")
.respond()
    .withDelay(2, SECONDS)
    .withStatus(200)
    .withBody("{\\"account\\":{\\"id\\" : 1}}")
    .withEncoding(Charset.forName("UTF-8"))
    .withContentType("application/json; charset=UTF-8");

Answer 7

如果您使用的是 apache HttpClient，这将是一个不错的选择。 HttpClientMock

HttpClientMock httpClientMock = new httpClientMock() 
HttpClientMock("http://example.com:8080"); 
httpClientMock.onGet("/login?user=john").doReturnJSON("{permission:1}");

基本上，您然后对您的模拟对象发出请求，然后可以对其进行一些验证httpClientMock.verify().get("http://localhost/login").withParameter("user","john").called()

Answer 8

尝试使用Jetty web server。

Answer 9

我推荐Javalin。它是模拟真实服务的绝佳工具，因为它允许在测试中进行状态断言（服务器端断言）。

Wiremock 也可以使用。但这会导致难以维护行为测试（验证客户端调用是否符合预期）。

Answer 10

为了完整起见，还使用camel 包裹了码头，使其更加用户友好。

让你的测试类扩展 CamelTestSupport 然后定义一个路由 ex：

  @Override
  protected RouteBuilder createRouteBuilder() {
    return new RouteBuilder() {
      @Override
      public void configure() {
        from("jetty:http://localhost:" + portToUse).process(
                new Processor() {
                  @Override
                  public void process(Exchange exchange) throws Exception {
                    // Get the request information.
                    requestReceivedByServer = (String) exchange.getIn().getHeader(Exchange.HTTP_PATH);

                    // For testing empty response
                    exchange.getOut().setBody("your response");
                    ....

获取它的示例 maven 依赖项：

<dependency> <!-- used at runtime, by camel in the tests -->
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-jetty</artifactId>
  <version>2.12.1</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-core</artifactId>
  <version>2.12.1</version>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-test</artifactId>
  <version>2.12.1</version>
  <scope>test</scope>
</dependency>