6.3 Вызов Web-служб в стиле REST

Наиболее мощные средства проекта JAX-RS сосредоточены в клиентской части потребителей сервисов.

В мае 2013 года появилась реализация JAX-RS версии 2.0, соответствующая спецификации JSR 339 и содержащая полноценный API для реализации клиентской части технологии RESTful. С этого момента отпала необходимость программирования запросов методами PUT и DELETE с помощью низкоуровневого API инструментальной платформы Java. Таким образом, были созданы необходимые инструментальные средства для реализации различного рода многозвенных архитектур на программной платформе Java EE, в которых сервера приложений могли эффективно обращаться к другим серверам RESTful-сер- висов, предоставляя конечным клиентским приложениям, таким как браузеры, использовать только методы GET и POST.

Новый клиентский инструментарий проекта JAX-RS сосредоточен в пакете javax.ws.rs.client.

Основные классы и интерфейсы пакета javax.ws.rs.client представлены в таблице 6.6.

Таблица 6.6 - Классы и интерфесы пакета javax.ws.rs.client [17]

Используя объекты указанных в таблице типов, программные агенты клиентов формируют запросы, удовлетворяющие стилю RESTful, а затем проводят анализ полученных ответов.

Учебная цель данного подраздела — завершить демонстрацию инструментальных средств проекта JAX-RS, реализуя сетевое взаимодействие про-

262

граммного обеспечения как поставщиков, так и потребителей сервисов.

Для достижения указанной цели, учебный материал данного подраздела разделен на пять частей:

а) в первой и второй частях — дается описание инструментальных средств потребителей сервисов и приводится полная реализация класса сервлета LetsRestService, ориентированного на взаимодействие с пользовательскими агентами;

б) в третьей части — на основе проекта labs реализуется шаблон пользовательского агента для взаимодействия с сервисом проекта lab9;

в) последние две части — демонстрируют реализацию доступа к сервисам с использованием запросов типа GET, POST, PUT и DELETE.

6.3.1 Инструментальные средства потребителя сервиса

Основой запросов потребителей сервисов являются отдельные объекты типа Client, которые создаются с использованием статических методов фабрики

ClientBuilder, например:

Client client = ClientBuilder.newClient();

Для того, чтобы указать цель запроса, создается целевой объект типа WebTarget, например:

WebTarget target = client.target("http://localhost:8080/lab9/letter");

К объекту типа WebTarget применимы ряд методов, уточняющие адрес запроса или формирующие параметры запроса, например:

target.path("1");

target.queryParam("name", "Содержимое параметра");

Закончив формирование нужной цели, следует создать объект типа Invocation.Builder, причем можно указать и MediaType запроса, например:

Invocation.Builder builder = target.request();

Invocation.Builder builder = target.request(MediaType.TEXT_PLAIN);

Завершается формирование запроса созданием одного из вариантов

263

объекта типа Invocation, в котором должен быть указан один из доступных типов запроса, например:

Invocation invocation = builder.buildGet();

Invocation invocation = builder.buildDelete();

Invocation invocation = builder.buildPost(Entity.entity(new Letter(...)));

Invocation invocation = builder.buildPut(Entity.entity(new Letter(...)));

Обратите внимание, что построение запросов для методов POST и PUT предполагает передачу поставщику сервиса объектов, оформленных как объекты типа Entity.

Окончательно, сам запрос осуществляется методом invoke(), предполагая получение ответа типа Response, например:

Response response = invocation.invoke();

Отправив запрос и получив ответ в виде объекта типа Response, потребитель сервиса может осуществить его предварительный анализ, например:

1)response.getStatusInfo() — получить код завершения запроса;

2)response.getLength() — определить полученную длину ответа;

3)response.getDate() — узнать дату формирования ответа;

4)response.getHeaderString("Content-type") — прочитать различные параметры заголовков ответа.

Главным в объекте типа Response является конечно тело сообщения, которое можно обрабатывать в виде объекта типа String или, если полностью известен тип объекта, то востановить его из текстового сообщения. Для этого используется метод readEntity(...). Например, если мы хотим анализировать строку, то ее можно извлечь следующим образом:

String body = response.readEntity(String.class);

Если нам известно, что полученный объект имеет тип Letter и у нас имеется описание этого класса, то следует записать:

264

Letter body = response.readEntity(Letter.class);

Для примера, рассмотрим программу клиента, которая демонстрирует использование перечисленных выше инструментальных средств.

В качественном виде, такая программа обращается к поставщику сервиса, реализованного в проекте lab9 и запрашивает у него полный список записей объектов типа класса Letter, а затем — распечатывает полученный результат формата XML в виде строки.

Формальная постановка задачи — необходимо:

1)обратиться к поставщику сервиса http://localhost:8080/lab9/letter;

2)получить ответ в виде объекта типа Response;

3)извлечь и распечатать текстовое содержимое ответа.

Реализация поставленной задачи включает:

1)создание нового проекта jaxrs типа Dynamic Web Project;

2)создание нового класса с именем RunGetLetter, содержимое которого показано на листинге 6.10.

Листинг 6.10 — Исходный текст класса RunGetLetter.java проекта jaxrs

package rsos.lab9;

import javax.ws.rs.client.Client; import javax.ws.rs.client.ClientBuilder; import javax.ws.rs.client.Invocation; import javax.ws.rs.client.WebTarget; import javax.ws.rs.core.MediaType; import javax.ws.rs.core.Response;

public class RunGetLetter

{

public static void main(String[] args)

{

//Создание объекта типа Client Client client =

ClientBuilder.newClient();

//Создание цели запроса

WebTarget target = client.target("http://localhost:8080/lab9/letter");

//target.path("1");

//target.queryParam("name", "Содержимое параметра");

// Раздельное создание объектов builder и invocation Invocation.Builder builder =

target.request(MediaType.TEXT_PLAIN_TYPE);

Invocation invocation = builder.buildGet();

// Отправка запроса и получение ответа

265

Response response = invocation.invoke();

//Извлечение ответа в виде объекта строки String body =

response.readEntity(String.class);

//Печать содержимого тела ответа на терминал System.out.println(body);

//Закрытие объемных объектов

response.close(); client.close();

}

}

Результат работы класса RunGetLetter показан на рисунке 6.10. Он конечно не производит впечатления, поскольку список объектов типа Letter представлен в формате XML и выводится в виде строки. Тем не менее, можно сравнить этот вывод с содержимым, например, рисунка 6.4, полученного при работе проекта lab9, и убедиться в правильности полученного результата.

Рисунок 6.10 — Результат работы класса RunGetLetter

В целом, Web-службы в стиле REST не предназначены для прямого вывода информации в приложения типа браузеров.

Подобное утверждение может показаться спорным, но, как видно из описанных инструментальных средств потребителей сервисов, полученные объекты типа Response требуют дополнительной обработки, если на стороне клиента имеется их описание.

Безусловно, в рамках программной платформы Java EE, RESTful-службы должны обеспечивать другие технологии представления информации, такие как JSF (JavaServer Faces). Именно компоненты-подложки технологии JSF должны выступать потребителями сервисов RESTful.

С другой стороны, Web-службы в стиле REST, зародившись как альтернатива классической технологии Web-служб SOAP, считаются более экономными и эффективными в плане взаимодействия между поставщиками и потребителями сервисов. В частности, это связано с сокращенным набором рекомендуемых сервисов, обозначаемых как операции типа CRUD.

266