RESTful веб-приложения с Джерси и Spring

Пару месяцев назад нам было поручено создать API для предоставления некоторых функций в нашей системе сторонним разработчикам. Мы решили представить эти функции в виде серии веб-сервисов REST. Я начал играть с Джерси , эталонной реализацией JSR 311 (Java API для Restful Services) это оказалось приятным сюрпризом, поскольку оказалось очень мощным и элегантным. В этом посте мы создадим очень простой веб-сервис REST с использованием Jersey.

Пример кода, используемый в этом посте, можно найти здесь .

Отдых вкратце

REST (Передача состояния представления) не нова — она ​​была впервые предложена в 2000 году (Fielding, Architectural Styles и Design of Network-Software Architectures ) — но сегодня она все еще недостаточно используется, поскольку в последние пару лет она действительно вошла в моду. , Он используется для описания ресурсов через URL и позволяет манипулировать такими ресурсами. Идея состоит в том, чтобы использовать HTTP-протокол для создания независимого от платформы, не сохраняющего состояния, кеш-интерфейса между клиентом и сервером. Хотя REST можно применять к другим протоколам, в настоящее время мы занимаемся только HTTP.

Проще говоря, URL-адрес типа «http://www.myserver.com/files/text.txt» описывает ресурс, который представляет собой файл с именем text.txt и находится в домене myserver.com. Ничего особенного там нет; вы можете указать браузеру этот файл, и ваш браузер отправит GET-запрос на сервер для его получения. Вам даже не нужно писать какое-либо приложение для этого; любой клиент и сервер будут общаться таким образом.

Это становится более интересным с другими методами запроса; все, кто читает это, должны быть знакомы с методом POST (обычно используется для форм). В приложении REST размещение сообщения по URL-адресу означает, что вы хотите изменить ресурс по этому URL-адресу. Менее распространенные методы PUT и DELETE используются для создания и удаления ресурсов соответственно; например, PUT http://www.myserver.com/files/text.txt должен создать текстовый файл, обычно с содержимым тела запроса. Стоит отметить, что в некоторых системах, особенно в тех, которые предназначены для непосредственного взаимодействия с браузером, метод POST иногда используется для этих целей, поскольку некоторые браузеры не очень хорошо справляются с этими двумя.

REST также использует заголовки для управления кэшированием или для определения типов контента или языков, которые ожидает клиент; В конце концов, запрос — это обычный старый HTTP-запрос. Это хорошо, это чисто, это гибко, и это не будет зависеть от того, сколько сантехники вам потребуется для обеспечения той же функциональности, скажем, с SOAP. Причина, по которой мы пошли с этим, должна быть достаточно ясной на данный момент.

Анатомия класса ресурсов REST

Несмотря на то, что за кулисами происходит много всего, Джерси отлично скрывает всю сложность своих хороших чистых аннотаций. Учтите следующее:

   1: @Path("/people/{code}")

   2:publicclass Individual {

   3:

   4:

     @GET

   5:     @Produces({"application/json", "application/xml"})

   6:public Object find(@PathParam("code") String code) { ... }

   7:

   8:

     @DELETE   9:public void remove(@PathParam("code") String code) { ... }

  10: }

Это простой класс, который может искать или удалять запись для человека на основе уникального кода. В первой аннотации Path указывается, к какому URL относится данный класс (или метод — вы можете переопределить путь на уровне метода, если хотите). В этом случае мы говорим, что хотим, чтобы этот класс обрабатывал запросы, сделанные «[независимо от домена] / people»; мы также будем ожидать значения после «людей», которое мы будем считать уникальным кодом для человека, которого мы хотим — это значение в скобках.

Мы можем использовать несколько переменных в пути; мы могли бы, например, сказать «/ team / {team_id} / {position}» или даже «/ team / {team_id} / staff / {position}», чтобы получить подробную информацию о лицах, занимающих данную должность в команде, в зависимости от того, насколько многословным мы хотим быть. Мы также можем создать ограничения для параметров; например, если мы хотим, чтобы код представлял собой числовое значение, мы можем определить его как «{code: [0-9] *}»; определение принимает шаблоны регулярных выражений.

GET и УДАЛЕНИЕ аннотации указать , какой метод Java должен обрабатывать HTTP , какой метод. Для этих методов также есть аннотации POST и PUT.

   1: @Component

   2: @Scope("request")

   3: @Path("/people/{code}")

   4:publicclass Individual {

   5:     ...

   6: }

   1:<?xmlversion="1.0"encoding="UTF-8"?>

   2:<beansxmlns="http://www.springframework.org/schema/beans"

   3:xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

   4:xmlns:context="http://www.springframework.org/schema/context"

   5:xsi:schemaLocation="

   6:            http://www.springframework.org/schema/beans

   7:            http://www.springframework.org/schema/beans/spring-beans.xsd

   8:            http://www.springframework.org/schema/context

   9:            http://www.springframework.org/schema/context/spring-context.xsd">

  10:

  11:

<context:component-scanbase-package="your.namespace.here"/>

  12:</beans>