«Клиент JAX-RS с Джерси» - Spring на русском

«1. Обзор

Jersey — это платформа с открытым исходным кодом для разработки веб-сервисов RESTFul. Он также имеет отличные встроенные клиентские возможности.

В этом кратком руководстве мы рассмотрим создание клиента JAX-RS с использованием Джерси 2.

Обсуждение создания веб-служб RESTful с использованием Джерси см. в этой статье.

2. Зависимости Maven

Давайте начнем с добавления необходимых зависимостей (для клиента Jersey JAX-RS) в pom.xml:

<dependency>
    <groupId>org.glassfish.jersey.core</groupId>
    <artifactId>jersey-client</artifactId>
    <version>2.25.1</version>
</dependency>

Чтобы использовать Jackson 2.x в качестве поставщика JSON:

<dependency>
    <groupId>org.glassfish.jersey.media</groupId>
    <artifactId>jersey-media-json-jackson</artifactId>
    <version>2.25.1</version>
</dependency>

Последнюю версию этих зависимостей можно найти в jersey-client и jersey-media-json-jackson.

3. Клиент RESTFul в Джерси

Мы разработаем клиент JAX-RS для использования JSON и XML REST API, которые мы разработали здесь (нам нужно убедиться, что служба развернута и URL-адрес доступен).

3.1. Класс представления ресурсов

Давайте посмотрим на класс представления ресурсов:

@XmlRootElement
public class Employee {
    private int id;
    private String firstName;

    // standard getters and setters
}

Аннотации JAXB, такие как @XmlRootElement, требуются только в том случае, если требуется поддержка XML.

3.2. Создание экземпляра клиента

Первое, что нам нужно, это экземпляр клиента:

Client client = ClientBuilder.newClient();

3.3. Создание WebTarget

Получив экземпляр Client, мы можем создать WebTarget, используя URI целевого веб-ресурса:

WebTarget webTarget 
  = client.target("http://localhost:8082/spring-jersey");

Используя WebTarget, мы можем определить путь к конкретному ресурсу:

WebTarget employeeWebTarget 
  = webTarget.path("resources/employees");

~ ~~ 3.4. Построение вызова HTTP-запроса

Экземпляр построителя вызова создается одним из методов WebTarget.request():

Invocation.Builder invocationBuilder 
  = employeeWebTarget.request(MediaType.APPLICATION_JSON);

Для формата XML можно использовать MediaType.APPLICATION_XML.

3.5. Вызов HTTP-запросов

Вызов HTTP GET:

Response response 
  = invocationBuilder.get(Employee.class);

Вызов HTTP POST:

Response response 
  = invocationBuilder
  .post(Entity.entity(employee, MediaType.APPLICATION_JSON);

3.6. Пример клиента REST

Давайте начнем писать простой клиент REST. Метод getJsonEmployee() извлекает объект Employee на основе идентификатора сотрудника. JSON, возвращаемый веб-службой REST, перед возвратом десериализуется в объект Employee.

Быстрое использование JAX-RS API для создания веб-цели, построителя вызовов и вызова HTTP-запроса GET:

public class RestClient {
 
    private static final String REST_URI 
      = "http://localhost:8082/spring-jersey/resources/employees";
 
    private Client client = ClientBuilder.newClient();

    public Employee getJsonEmployee(int id) {
        return client
          .target(REST_URI)
          .path(String.valueOf(id))
          .request(MediaType.APPLICATION_JSON)
          .get(Employee.class);
    }
    //...
}

Теперь добавим метод для HTTP-запроса POST. Метод createJsonEmployee() создает сотрудника, вызывая веб-службу REST для создания сотрудника. Клиентский API внутренне сериализует объект Employee в JSON перед вызовом метода HTTP POST:

public Response createJsonEmployee(Employee emp) {
    return client
      .target(REST_URI)
      .request(MediaType.APPLICATION_JSON)
      .post(Entity.entity(emp, MediaType.APPLICATION_JSON));
}

4. Тестирование клиента

Давайте протестируем наш клиент с помощью JUnit:

public class JerseyClientLiveTest {
 
    public static final int HTTP_CREATED = 201;
    private RestClient client = new RestClient();

    @Test
    public void givenCorrectObject_whenCorrectJsonRequest_thenResponseCodeCreated() {
        Employee emp = new Employee(6, "Johny");

        Response response = client.createJsonEmployee(emp);

        assertEquals(response.getStatus(), HTTP_CREATED);
    }
}

5. Заключение

В этой статье мы представили клиент JAX-RS с использованием Jersey 2 и разработали простой клиент RESTFul Java.

Как всегда, полный исходный код доступен в этом проекте Github.

«Клиент JAX-RS с Джерси»