测试 JAX-RS Web 服务？

Question

我目前正在寻找为 JAX-RS （用于 RESTful Web 的 Java API服务）基于网络服务。

我基本上需要一种方法来向其发送某些输入并验证我是否得到了预期的响应。 我更愿意通过 JUnit 来完成此操作，但我不确定如何实现。

您使用什么方法来测试您的网络服务？

更新： 正如 entzik 指出的，将 Web 服务与业务逻辑解耦使我能够对业务逻辑进行单元测试。 但是，我还想测试正确的 HTTP 状态代码等。

Answer 1

您可以尝试REST Assured，这会让事情变得非常简单测试 REST 服务并验证 Java 中的响应（使用 JUnit 或 TestNG）。

Answer 2

正如詹姆斯所说； Jersey 有内置的 测试框架。 一个简单的 hello world 示例可以是这样的：

用于 maven 集成的 pom.xml。 当您运行mvn test时。 框架启动一个 grizzly 容器。 您可以通过更改依赖项来使用 jetty 或 tomcat。

...
<dependencies>
  <dependency>
    <groupId>org.glassfish.jersey.containers</groupId>
    <artifactId>jersey-container-servlet</artifactId>
    <version>2.16</version>
  </dependency>

  <dependency>
    <groupId>org.glassfish.jersey.test-framework</groupId>
    <artifactId>jersey-test-framework-core</artifactId>
    <version>2.16</version>
    <scope>test</scope>
  </dependency>

  <dependency>
    <groupId>org.glassfish.jersey.test-framework.providers</groupId>
    <artifactId>jersey-test-framework-provider-grizzly2</artifactId>
    <version>2.16</version>
    <scope>test</scope>
  </dependency>
</dependencies>
...

ExampleApp.java

import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

@ApplicationPath("/")
public class ExampleApp extends Application {

}

HelloWorld.java

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

@Path("/")
public final class HelloWorld {

    @GET
    @Path("/hello")
    @Produces(MediaType.TEXT_PLAIN)
    public String sayHelloWorld() {

        return "Hello World!";
    }
}

HelloWorldTest.java

import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;
import javax.ws.rs.core.Application;
import static org.junit.Assert.assertEquals;

public class HelloWorldTest extends JerseyTest {

    @Test
    public void testSayHello() {

        final String hello = target("hello").request().get(String.class);

        assertEquals("Hello World!", hello);
    }

    @Override
    protected Application configure() {

        return new ResourceConfig(HelloWorld.class);
    }
}

您可以查看此示例应用程序。

Answer 3

您可能编写了一些实现业务逻辑的 Java 代码，然后为其生成了 Web 服务端点。

要做的一件重要的事情是独立测试您的业务逻辑。 由于它是纯 java 代码，因此您可以通过常规 J​​Unit 测试来做到这一点。

现在，由于 Web 服务部分只是一个端点，因此您需要确保生成的管道（存根等）与您的 java 代码同步。 您可以通过编写调用生成的 Web 服务 Java 客户端的 JUnit 测试来实现这一点。 当您更改 Java 签名而不更新 Web 服务内容时，这会让您知道。

如果您的 Web 服务管道是由您的构建系统在每次构建时自动生成的，那么可能不需要测试端点（假设它全部正确生成）。 取决于你的偏执程度。

Answer 4

虽然从发布问题之日起为时已晚，但我认为这对于有类似问题的其他人可能有用。
Jersey 附带了一个名为 Jersey 测试框架 的测试框架，它允许您测试 RESTful Web 服务，包括响应状态代码。 您可以使用它在 Grizzly、HTTPServer 和/或 EmbeddedGlassFish 等轻量级容器上运行测试。 此外，该框架还可用于在常规 Web 容器（如 GlassFish 或 Tomcat）上运行测试。

Answer 5

查看 Alchemy Rest 客户端生成器。 这可以在后台使用 jersey 客户端为您的 JAX-RS Web 服务类生成代理实现。 实际上，您将在单元测试中将 Web 服务方法称为简单的 Java 方法。 还处理 http 身份验证。

如果您只需要运行测试，则不涉及代码生成，因此很方便。

免责声明：我是这个库的作者。

Answer 6

我使用 Apache 的 HTTPClient (http://hc.apache.org/) 来调用 Restful 服务。 HTTP 客户端库允许您轻松执行获取、发布或您需要的任何其他操作。 如果您的服务使用 JAXB 进行 xml 绑定，您可以创建 JAXBContext 来序列化和反序列化 HTTP 请求的输入和输出。

Answer 7

把事情简单化。 查看可以导入的 https://github.com/valid4j/http-matchers来自 Maven 中心。

    <dependency>
        <groupId>org.valid4j</groupId>
        <artifactId>http-matchers</artifactId>
        <version>1.0</version>
    </dependency>

使用示例：

// Statically import the library entry point:
import static org.valid4j.matchers.http.HttpResponseMatchers.*;

// Invoke your web service using plain JAX-RS. E.g:
Client client = ClientBuilder.newClient();
Response response = client.target("http://example.org/hello").request("text/plain").get();

// Verify the response
assertThat(response, hasStatus(Status.OK));
assertThat(response, hasHeader("Content-Encoding", equalTo("gzip")));
assertThat(response, hasEntity(equalTo("content")));
// etc...

Answer 8

<块引用>

要做的重要事情是独立测试您的业务逻辑

我当然不会认为编写 JAX-RS 代码并希望对接口进行单元测试的人不知何故，出于某种奇怪的、无法解释的原因，忽视了这样的概念：他或她可以对程序的其他部分进行单元测试，包括业务逻辑类。 陈述显而易见的事实几乎没有帮助，而且人们反复强调，响应也需要进行测试。

Jersey 和 RESTEasy 都有客户端应用程序，对于 RESTEasy，您可以使用相同的注释（甚至可以提取注释接口并在测试的客户端和服务器端使用）。

REST 不是该服务能为您做什么； 休息你可以为此服务做的事情。

Answer 9

据我了解，此问题作者的主要目的是将 JAX RS 层与业务层解耦。 并且仅对第一个进行单元测试。 这里我们必须解决两个基本问题：

1. 运行测试一些 Web/应用程序服务器，将 JAX RS 组件放入
   它。 并且只有他们。
2. JAX RS 中的模拟业务服务
   组件/REST 层。

第一个问题是用 Arquillian 解决的。
第二个在arquillian和mock中有完美的描述，

这里是代码示例，如果您使用其他应用程序服务器，它可能会有所不同，但我希望您能够了解基本概念和优点。

import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;

import com.brandmaker.skinning.service.SomeBean;

/**
* Created by alexandr on 31.07.15.
*/
@Path("/entities")
public class RestBean
{
   @Inject
   SomeBean bean;

   @GET
   public String getEntiry()
   {
       return bean.methodToBeMoked();
   }
}

import java.util.Set;

import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;

import com.google.common.collect.Sets;

/**
*/
@ApplicationPath("res")
public class JAXRSConfiguration extends Application
{
   @Override
   public Set<Class<?>> getClasses()
   {
       return Sets.newHashSet(RestBean.class);
   }
}


public class SomeBean
{
   public String methodToBeMoked()
   {
       return "Original";
   }
}

import javax.enterprise.inject.Specializes;

import com.brandmaker.skinning.service.SomeBean;

/**
*/
@Specializes
public class SomeBeanMock extends SomeBean
{
   @Override
   public String methodToBeMoked()
   {
       return "Mocked";
   }
}

@RunWith(Arquillian.class)
public class RestBeanTest
{
   @Deployment
   public static WebArchive createDeployment() {
       WebArchive war = ShrinkWrap.create(WebArchive.class, "test.war")
               .addClasses(JAXRSConfiguration.class, RestBean.class, SomeBean.class, SomeBeanMock.class)
               .addAsWebInfResource(EmptyAsset.INSTANCE, "beans.xml");
       System.out.println(war.toString(true));
       return war;
   }

   @Test
   public void should_create_greeting() {
       Client client = ClientBuilder.newClient();
       WebTarget target = client.target("http://127.0.0.1:8181/test/res/entities");
       //Building the request i.e a GET request to the RESTful Webservice defined
       //by the URI in the WebTarget instance.
       Invocation invocation = target.request().buildGet();
       //Invoking the request to the RESTful API and capturing the Response.
       Response response = invocation.invoke();
       //As we know that this RESTful Webserivce returns the XML data which can be unmarshalled
       //into the instance of Books by using JAXB.
       Assert.assertEquals("Mocked", response.readEntity(String.class));
   }
}

一些注意事项：

1. 此处使用不带 web.xml 的 JAX RS 配置。
2. 这里使用 JAX RS 客户端（没有 RESTEasy/Jersey，它们公开了更方便的 API）
3. 当测试开始时，Arquillian 的运行器开始工作。 在这里您可以找到如何使用所需的应用程序服务器为 Arquillian 配置测试。
4. 根据所选的应用程序服务器，
   测试会略有不同。 可以使用另一个端口。 8181 是
   在我的示例中由 Glassfish Embedded 使用。

希望，它会有所帮助。

Answer 10

Jersey 附带了一个很棒的 RESTful 客户端 API，使编写单元测试变得非常容易。 请参阅 Jersey 附带的示例中的单元测试。 我们使用这种方法来测试 Apache Camel 中的 REST 支持，如果您对测试用例在这里