SOAPИнтернет объединяет в себе много различных платформ, а информация содержится в разнообразных источниках данных. Концепция веб-сервисов (Web Services) призвана решить эту задачу объединения, интеграции разнородных систем на основе открытых стандартов.
Слайд 2
SOAP Интернет объединяет в себе много различных платформ, а
информация содержится в разнообразных источниках данных. Концепция веб-сервисов (Web
Services) призвана решить эту задачу объединения, интеграции разнородных систем на основе открытых стандартов.
Слайд 3
Основные положения модели веб-сервисов Веб-сервисы являются концепцией создания таких
приложений, функции которых можно использовать при помощи стандартных протоколов
Интернет. Концепция веб-сервисов реализуется при помощи ряда технологий, которые стандартизованы World Wide Web Consortium (W3C). Взаимосвязь этих технологий можно условно представить следующим образом.
Слайд 5
XML является фундаментом для создания большинства технологий, связанных
с веб-сервисами. Для удаленного взаимодействия с веб-сервисами используется Simple Object
Access Protocol (SOAP). SOAP обеспечивает взаимодействие распределенных систем, независимо от объектной модели, операционной системы или языка программирования. Данные передаются в виде особых XML документов особого формата.
Слайд 6
Согласно определению W3C, веб-сервисы это приложения, которые доступны
по протоколам, которые являются стандартными для Интернет. Нет требования, чтобы
веб-сервисы использовали какой-то определенный транспортный протокол. Спецификация SOAP определяет, каким образом связываются сообщения SOAP и транспортный протокол Технология Universal Description, Discovery and Integration (UDDI) предполагает ведения реестра веб-сервисов. Подключившись к этому реестру, потребитель сможет найти веб-сервисы, которые наилучшим образом удовлетворяют его потребностям
Слайд 7
Веб-сервисы позиционируются как программное обеспечение промежуточного слоя. Использовать
веб-сервисы могут как клиентские приложения, непосредственно работающие с пользователем,
так и другие приложения. Веб-сервисы размещаются на серверах приложений. Существует несколько концепций применения Веб-сервисов. Веб-сервисы как реализация логики приложения (бизнес-логики). То есть, создание нового приложения бизнес- логика, которого реализуется в веб-сервисе.
Слайд 9
2. Веб-сервисы как средство интеграции. То
есть, использование веб-сервиса как способа доступа удаленных клиентов к
внутренней ИС компании, или для организации взаимодействия компонента (например, EJB, COM-компонента) с различными удаленными клиентами.
Слайд 10
Рассмотрим пример создания и развертывания Веб –сервиса. Пусть
Веб-сервис возвращает строку клиенту. Тогда класс, реализующий данный Веб-сервис будет
иметь вид (HelloService.java): package samples.mysimple; public class HelloService{ private static int a=25; public HelloService(){ a++; } public String myMethod(String s){ return s+Integer.toString(a); } }
Слайд 11
Таким образом, логика Веб-сервиса заключена в методе myMethod. Клиент,
вызывающий данный Веб-сервис будет иметь следующий вид (Client.java): package samples.mysimple;
//Указываем где находится Веб -Сервис call.setTargetEndpointAddress(new java.net.URL(endpoint));
//Указываем метод, который будем вызывать. call.setOperationName( new QName("http://mysimple.samples", method));
// Определяем тип параметра, передаваемого в метод, в XML формате call.addParameter("op1", org.apache.axis.encoding.XMLType.XSD_STRING, ParameterMode.IN);
Слайд 13
//Определяем тип возвращаемого методом значения,в XML формате
call.setReturnType(org.apache.axis.encoding.
XMLType.XSD_STRING); //Вызываем метод String ret = (String)call.invoke( new Object [] { s1 }); System.out.println("Got result : " + ret); } }
Слайд 14
Рассмотрим процедуру развертывания данного Веб-сервиса. Для использования данного Веб-сервиса
Tomcat уже установлен в директории C:\Tomcat) 1. Разворачиваем пакет axis-bin-1_4.zip в директорию C:\axis
Слайд 15
2. Копируем папку axis из директории c:\axis\webapp в
директорию c:\tomcat\webapp 3. Копируем все jar файлы из директории c:\axis\lib
в директорию c:\tomcat\webapps\axis\WEB-INF\lib\, а также их архивов Xerces-J-bin.2.11.0.zip и xml-security-bin-1_4_4.zip 4. Создаем переменные окружения set AXIS_HOME=/usr/axis
set AXIS_LIB=$AXIS_HOME/lib
set AXISCLASSPATH =$AXIS_LIB/axis.jar:$AXIS_LIB/commons-discovery.jar:
$AXIS_LIB/commons- logging.jar: $AXIS_LIB/jaxrpc.jar:$AXIS_LIB/saaj.jar:
$AXIS_LIB/log4j-1.2.8.jar:$AXIS_LIB/xml-apis.jar: $AXIS_LIB/xercesImpl.jar
export AXIS_HOME; export AXIS_LIB; export AXISCLASSPATH
Слайд 16
5. Создаем папку c:\axis\samples\mysimple\ и копируем туда файлы
Client.java и HelloService.java 6. Копилируем данные файлы >javac –cp “все
необходимые jar файлы из папки c:\tomcat\webapps\axis\WEB-INF\lib\” *.java 7. Создаем дескрипторы развертывания в папке c:\axis\samples\mysimple\ deploy.wsdd undeploy.wsdd
Слайд 23
Конверт (SOAP Envelope) SOAP Envelope является самым «верхним» элементом
SOAP сообщения. Содержит корневой элемент XML-документа. Описывается с помощью
элемента Envelope с обязательным пространством имен http://www.w3.org/2003/05/soap-envelope для версии 1.2 и http://schemas.xmlsoap.org/soap/ для версии 1.1. У элемента Envelope могут быть атрибуты xmlns, определяющие пространства имен, и другие атрибуты, снабженные префиксами.
Слайд 24
Envelope может иметь необязательный дочерний элемент Header c
тем же пространством имен — заголовок. Если этот элемент
присутствует, то он должен быть первым прямым дочерним элементом конверта. Следующий дочерний элемент конверта должен иметь имя Body и то же самое пространство имен - тело. Это обязательный элемент и он должен быть вторым прямым дочерним элементом конверта, если есть заголовок, или первым — если заголовка нет. Элементы Header и Body могут содержать элементы из различных пространств имен
Слайд 25
Заголовок SOAP (SOAP Header) Первый прямой дочерний элемент конверта. Не
обязательный. Заголовок кроме атрибутов xmlns может содержать 0 или
более стандартных атрибутов: • encodingStyle • actor (или role для версии 1.2) • mustUnderstand • relay
Слайд 26
Атрибут encodingStyle В SOAP-сообщениях могут передаваться данные различных типов
(числа, даты, массивы, строки и т.п.). Определение этих типов
данных выполняется в схемах XML (обычно — XSD). Типы, определенные в схеме, заносятся в пространство имен, идентификатор которого служит значением атрибута encodingStyle. Атрибут encodingStyle может появиться в любом элементе SOAP-сообщения, но версия SOAP 1.2 запрещает его появление в корневом элементе Envelope.
Слайд 27
Атрибут actor Тип данных URI. Задает адрес конкретного SOAP-сервера,
которому предназначено сообщение. SOAP-сообщение может пройти через несколько SOAP-серверов
или через несколько приложений на одном сервере. Эти приложения выполняют предварительную обработку блоков заголовка послания и передают его друг другу. Все эти серверы и/или приложения называются SOAP-узлами (SOAP nodes). Спецификация SOAP не определяет правила прохождения послания по цепочке серверов. Для этого разрабатываются другие протоколы, например, Microsoft WS-Routing.
Слайд 28
В версии 1.2 атрибут actor заменен атрибутом role,
потому что в этой версии SOAP каждый узел играет
одну или несколько ролей. Спецификация пока определяет три роли SOAP-узла: Роль http://www.w3.org/2003/05/soap-envelope/role/ultimateReceiver играет конечный, целевой узел, который будет обрабатывать заголовок. Роль http://www.w3.org/2003/05/soap-envelope/role/next играет промежуточный или целевой узел. Такой узел может играть и другие, дополнительные роли.
Слайд 29
Роль http://www.w3.org/2003/05/soap-envelope/role/none не должен играть ни один SOAP-узел. Атрибут
mustUnderstand Тип данных — boolean. По умолчанию 0. Если значение
равно 1, то SOAP-узел при обработке элемента обязательно должен учитывать его синтаксис, определенный в схеме документа, или совсем не обрабатывать сообщение. Это повышает точность обработки сообщения. В версии SOAP 1.2 вместо цифр нужно писать true или false.
Слайд 30
Атрибут relay Тип данных — boolean. Показывает, что заголовочный
блок, адресованный SOAP- посреднику, должен быть передан дальше, если
он не был обработан. Необходимо отметить, что если заголовочный блок обработан, правила обработки SOAP требуют, чтобы он был удален из уходящего сообщения. В блоках заголовка могут быть атрибуты role, actor и mustUnderstand. Действие этих атрибутов относится только к данному блоку.
Слайд 32
SOAP-сообщения с вложениями Существуют ситуации, когда клиент и сервер
должны обмениваться данными в формате, отличном от текстового. С
точки зрения обмена данными все нетекстовые данные рассматриваются как данные в двоичных кодах. Двоичные данные включаются в сообщение в виде «вложения». Структура SOAP-сообщения с вложениями имеет вид:
Слайд 34
Этот протокол определяет пересылку SOAP-сообщения внутри MIME-сообщения, состоящего
из нескольких частей. Первая часть MIME-сообщения- часть SOAP -
содержит XML: конверт SOAP с вложенными в него заголовком и телом сообщения. Остальные части - вложения - содержат данные в любом формате, двоичном или текстовом. Каждая часть предваряется MIME-заголовком, описывающим формат данных части и содержащим идентификатор части
boundary=MIME_boundary; type="application/xop+xml"; start=""; start-info="text/xml" Content-Description: An XML document with binary data in it --MIME_boundary
Слайд 37
--MIME_boundary Content-Type: image/jpg Content-Transfer-Encoding: binary Content-ID: // двоичное представление файла изображения --MIME_boundary--
Слайд 38
Axis2 В основе инфраструктуры Web-сервисов Apache Axis2 лежит новая
модель XML документов AXIOM, обеспечивающая эффективную обработку сообщений SOAP,
в отличии от Axis. AXIOM - одна из основных инноваций в Axis2, и одна из причин того, что Axis2 показывает гораздо лучшие рабочие характеристики, чем оригинальный Axis.
общим свойствам, но имеет собственные характерные черты. Например, методы
доступа построены на основе java.util.Iterator экземпляров класса для доступа к компонентам. Вместо индексации компонентов в списке навигатор использует методы getNextOMSibling() и getPreviousOMSibling() из класса org.apache.axiom.om.OMNode для последовательного продвижения по узлам на уровне дерева документа (сходные с DOM в этом случае).
Слайд 40
Такое структурирование методов доступа и навигации отвечает работе
по построению дерева по требованию, поскольку это значит, что
AXIOM может позволить перейти к первому дочернему элементу стартового элемента без необходимости сперва обработать все родительские элементы для стартового. AXIOM построен на основе интерфейса StAX анализатора. Таким образом, AXIOM использует интерфейсы StAX Reader и Writer для обмена с внешним миром, как показано на схеме:
Слайд 41
Естественно, можно использовать SAX и DOM для взаимодействия
с AXIOM. AXIOM использует “builder”, чтобы построить XML модель в
памяти, но не всю модель, а только часть. Рассмотрим пример использования AXIOM модели. Пусть имеется XML фрагмент:
Слайд 43
Предположим пользователь хочет получить проект первого служащего. Таким образом,
в памяти достаточно построить модель представляющую только первые четыре
строки. Остальные строки остаются нетронутыми в потоке. Тогда, если понадобится проект второго сотрудника builder построит первые 9 строк. Стоит заметит, что AXIOM архитектура не зависит от языка программирования. Код использующий AXIOM будет иметь вид:
Слайд 46
Одним из наиболее интересных свойств AXIOM является его
встроенная поддержка стандартов W3C XOP и MTOM, используемых в
последних версиях приложений SOAP. Эти два стандарта работают вместе: оптимизированная двоичная компоновка XML - XML-binary Optimized Packaging (XOP) обеспечивается логическое включение в XML любых двоичных данных; механизм оптимизации передачи сообщений MTOM (SOAP Message Transmission Optimization Mechanism) применяет технику XOP к сообщениям SOAP. XOP и MTOM являются принципиальными характеристиками нового поколения инфраструктур Web-серверов, поскольку они обеспечивают поддержку интероперабельных приложений (т.е. взаимодействие приложений) и тем самым устраняют текущие проблемы в данной области.
Слайд 47
XOP работает с данными, представленными в системе кодировки
символов с основанием 64. Base64 кодировка преобразует любые значения
данных в ASCII символы, пригодные для печати, используя один символ ASCII для представления каждых 6 битов информации исходных данных. Поскольку двоичные данные не могут быть размещены в XML (XML работает только с символами, а не непосредственно с байтами; даже использование номера кода символа недопустимо в XML), кодировка base64 незаменима для размещения двоичных данных в сообщениях XML.
Слайд 48
Язык WSDL Для описания интерфейса программной компоненты, включая спецификацию
корректных сообщений, был разработан язык WSDL (Web Service Definition
Language). Описание на языке WSDL включает в себя следующие семь составляющих:
Слайд 50
Описание типов передаваемых данных. При использовании
кодирования SOAP Document оно состоит из схемы
XML, определяющей корректные сообщения, получаемые программной компонентой в теле пакета SOAP. Описание входящих и исходящих сообщений, которые связываются с описанными типами данных. Описание операций (сервисов программной компоненты), с каждой из которых связывается входящее и исходящее сообщение.
Слайд 51
Описание типов портов (идентификаторов программных компонент), с каждым
из которых связывается некоторый набор операций. Описание привязок (
binding ), связывающие типы портов и их сообщений с определенным типом кодирования тела пакета, а также с версией протокола SOAP. Описание портов, связывающие типы портов и соответствующие им привязки с конкретными URL. Общее описание службы (интерфейса программной компоненты) как совокупности портов.
Слайд 52
Рассмотрим описание на языке WSDL интерфейса компоненты, которое
содержит два сервиса – сложение двух чисел и сложение
последовательности чисел. В корневом элементе указаны все используемые пространства имен, включая пространство протокола SOAP 1.2 xmlns:tns="http://summa.test/webservices" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/ wsdl/soap12/" targetNamespace="http://summa.test/webservices" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
Слайд 53
В элементе wsdl:types описываются все типы данных. Тип
Add будет связан со входящим сообщением сервиса сложения двух
чисел, а тип AddResponse – с его исходящим сообщением. targetNamespace="http://summa.test/webservices"> name="message" type="tns:AddMessage" />
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"> Операция SumList складывает несколько
чисел
Слайд 60
В элементе wsdl:binding операции связываются с транспортным протоколом
(HTTP), версией протокола SOAP (1.2) и типом кодирования тела
пакета (SOAP-Document). type="tns:MathServiceSoap"> transport="http://schemas.xmlsoap.org/soap/http" /> soapAction="http://summa.test/webservices/Add" style="document" /> Данный тег определяет как части сообщения будут располагаться в теле SOAP body, атрибут use оперделяет как сообщение буде кодироваться. Значение literal означает, что части сообщения определяются схемой типов.
Слайд 62
В элементе wsdl:service интерфейс программной компоненты связывается с
типом порта, с некоторой привязкой, а также с конкретным
URL, используемым в дальнейшем для вызова веб службы. binding="tns:MathServiceSoap12"> location="http://summa.test/webservices/ summa.asmx" />
Слайд 63
Стоит заметить, что в настоящий момент существует два
различных способа представления информации в теле пакета SOAP –
кодирование SOAP RPC (в двух вариантах) и кодирование SOAP Document. Кодирование SOAP RPC предназначено исключительно для передачи параметров удаленного вызова и определяет сообщение как имя метода и список параметров. При использовании кодирования SOAP Document, которое является фактическим стандартом в настоящий момент, сообщение представляет собой XML документ со схемой и пространством имен, заданными в описании сервиса на языке WSDL. Хотя обычно сообщение и состоит из имени метода удаленного объекта и списка его параметров, но сама спецификация кодирования не фиксирует как либо его содержание.
Слайд 64
Получение кода из WSDL В состав Axis2 входит
инструмент WSDL2Java, служащий для формирования кода из описания сервиса
WSDL. Можно использовать этот инструмент напрямую, запуская класс org.apache.axis2.wsdl.WSDL2Java из приложения Java, или посредством задачи Ant, подключаемого модуля Maven или подключаемых модулей Eclipse или IDEA. В инструменте WSDL2Java реализовано множество параметров командной строки, и их число постоянно растет. В документации по Axis2 содержится полный список этих параметров, поэтому здесь мы рассмотрим только наиболее важные из их числа:
Слайд 65
-o path — Определяет директорию, в которой будут
создаваться классы и файлы (по умолчанию используется рабочая директория)
-p package-name — Определяет пакет, в который будут записываться формируемые классы (по умолчанию используется пространство имен WSDL) -d name — Определяет среду связывания данных (adb для ADB, xmlbeans для XMLBeans, none для отключения связывания данных; по умолчанию используется adb) -uw — Распаковывает упакованные документально-литеральные сообщения, только для поддерживаемых сред (на сегодняшний день это ADB) -s — Формирует только синхронный клиентский интерфейс -ss — Формирует серверный код -sd — Формирует файлы для установки на сервере -uri path — Задает путь к WSDL для формируемого сервиса
Слайд 66
Формирование WSDL из кода В состав Axis2 также
входит инструмент Java2WSDL, который вы можете использовать для создания
определения сервиса WSDL на основе существующего кода сервиса. Однако полезность этого инструмента страдает от множества ограничений, в том числе невозможности работы с классами коллекций Java и отсутствия гибкости при структурировании XML, формируемого классами Java.
Слайд 67
В Axis2 (начиная с версии 1.2) реализована полная
поддержка нескольких вариантов связывания и готовится поддержка еще нескольких.
Рассмотрим некоторые из них. Axis2 Data Binding ADB (Связывание данных Axis2) - это расширение Axis2 для связывания данных. В отличие от других сред связывания данных, код ADB можно использовать только вместе с Web-сервисами Axis2. Это обстоятельство значительно ограничивает использование ADB, однако оно также даёт определенные преимущества. Поскольку ADB интегрировано с Axis2, код может быть оптимизирован под требования Axis2
Слайд 68
В WSDL2Java реализована полная поддержка формирования кода ADB,
в том числе формирование классов модели данных, соответствующих компонентам
схемы XML. В базовом варианте формирования кода ADB используется прямая модель, в которой каждому входящему и исходящему сообщению, используемым в каждой операции, назначается отдельный класс. Рассмотрим пример подобного связывания. Пусть необходимо создать Web сервис, который производит сложение двух целых чисел.
Слайд 69
Создадим абстрактный класс, в котором определена операция сложения package
hello; public abstract class Hello{ public abstract Result
add(Input in); } 2. Классы Result и Input имеют вид: package hello; public class Input{ private int a; private int b; public void setA(int a){ this.a=a; } public void setB(int b){ this.b=b; } public int getA(){ return a; } public int getB(){ return b; } }
Слайд 70
package hello; public class Result{ private int res; public
void setRes(int r){ res=r; } public int getRes(){
return res; } } 3. Данные классы Hello.java,Result.java и Input.java необходимо скомпилировать, поместив их в директорию hello javac hello/Hello.java 4. Необходимо сгенерировать описание сервиса WSDL(или написать вручную, тогда пункты 1-3 не нужны) java2wsdl -cn hello.Hello -cp . -sn Hello
Слайд 71
Как результат получим следующий wsdl файл:
Слайд 78
5. Создаем скелет Web сервиса на основе wsdl
файла Hello.wsdl, созданного на предыдущем шаге. wsdl2java -uri
Hello.wsdl -ss -sd 6. Логика Web сервиса должна быть заключена в классе HelloSkeleton.java. Данный класс имеет вид: package hello; public class HelloSkeleton{ public hello.AddResponse add ( hello.Add add ) { //Данный код был добавлен в ручную, это логика Web сервиса hello.AddResponse resp=new hello.AddResponse(); hello.xsd.Input inp=add.getArgs0(); hello.xsd.Result res=new hello.xsd.Result(); res.setRes(inp.getA()+inp.getB()); resp.set_return(res); return resp; } }
Слайд 79
7. Компилируем и создаем пакет Hello.aar, используя ant.
-o client В результате в папке client появятся два файла HelloStub.java HelloCallbackHandler.java 9. Развертываем axis2 под Tomcat. Для этого в каталоге webappsсоздаем поддиректорию axis2 и копируем туда директорию webapps в axis2. А затем копируем lib из axis2 в lib Tomcat 10. Запускаем Tomcat и заходим по ссылке localhost:8086/axis2/axis2-admin/ Вводим login: admin рassword: axis2
Слайд 80
11.Разворачиваем Web сервис, заходя по ссылке http://localhost:8086/axis2/axis2-admin/upload
и выбирая файл Hello.aar. 12. Клиент, обращающийся к Web сервису
будет иметь вид: import hello.*; public class Main { public static void main(String[] args) { try { HelloStub stub = new HelloStub(null, "http://localhost:8080/axis2/services/Hello"); HelloStub.Add add=new HelloStub.Add(); HelloStub.Input inp=new HelloStub.Input(); inp.setA(30); inp.setB(20); add.setArgs0(inp);
} catch (org.apache.axis2.AxisFault e) { e.printStackTrace }catch(java.rmi.RemoteException e){ e.printStackTrace(); } } } После запуска на экране поучим 50.
Слайд 82
XMLBeans XMLBeans - это общая среда обработки XML,
в состав которой входит слой связывания данных. Она создавалась
как проект BEA Systems, а впоследствии была передана организации Apache Foundation. XMLBeans была первой формой связывания данных, поддерживаемой Axis2, и продолжает быть наиболее популярным вариантом работы с Axis2, особенно со сложными определениями схем.
Слайд 83
XMLBeans отличается от ADB тем, что в ней
добавляется класс для документа, который содержит класс ввода или
вывода. Совокупный эффект при использовании XMLBeans по сравнению с ADB состоит в добавлении уровня создания объектов. В Axis2 нет поддержки распаковки XMLBeans, поэтому и нет способа избежать этого дополнительного уровня объектов. В результате классы, сформированные XMLBeans, получаются более сложными для использования, чем их эквиваленты в других средах связывания данных.
Слайд 84
Рассмотрим тот же пример с сложением двух целых
чисел, что и в случае ADB. Шаги 1-4 остаются
теми же самыми, что и в случае ADB. Шаг 5. Создаем скелет Web сервиса на основе wsdl файла Hello.wsdl, созданного на предыдущем шаге. wsdl2java -uri Hello.wsdl -ss -sd -d xmlbeans Шаг 6. Логика Web сервиса должна быть заключена в классе HelloSkeleton.java. Данный класс имеет вид:
Слайд 85
package hello; public class HelloSkeleton{
.getReturn().getRes()); }catch (org.apache.axis2.AxisFault e) { e.printStackTrace(); }catch(java.rmi.RemoteException e){ e.printStackTrace(); } } На экране получим 50. Стоит отметить, что клиент не запустится без папки schemaorg_apache_xmlbeans, находящейся в директории resources(в папке client). Перед запуском клиента необходимо прописать путь к этой папке, либо скопировать ее к другим пакетам клиентского приложения в соответствующей среде разработки.
Слайд 89
Restful services Архитектура REST отличается своей простотой, требуя от
приложений обеспечить только возможность приема сообщений с HTTP-заголовками. Эта
функция легко реализуется простыми Web-контейнерами для Java-приложений. REST-приложения часто создаются на основе сервлетов. Сервлеты не предписывают какие-либо конкретные походы к разработке. Как правило, сервлеты получают на обработку запросы, анализируют их заголовки, в том числе URI, чтобы определить, к какому ресурсу выполняется обращение. Стандарт Rest описан в документе JSR-311. Также спецификация JAX-RS 1.0, описывающая подход к созданию REST-сервисов на основе аннотаций. В отличие от модели на основе сервлетов, аннотации JAX-RS позволяют разработчикам сосредоточиться на прикладных ресурсах и данных, не отвлекаясь на вопросы, связанные с обменом информацией
Слайд 90
JAX-RS задает унифицированный способ описания ресурсов на основе
своей модели программирования. Он включает пять основных компонентов: корневые
ресурсы дочерние ресурсы методы ресурсов методы дочерних ресурсов локаторы дочерних ресурсов
Эта аннотация включает атрибут value, задающий путь к ресурсу.
Его значением могут быть строка символов, переменные, а также переменные в сочетании с регулярным выражением Пример корневого ресурса в JAX-RS import javax.ws.rs.Path; @Path(value="/contacts") public class ContactsResource { ... }
Слайд 92
Дочерние ресурсы Дочерними ресурсами (subresources) являются Java-классы, полученные в
результате вызова локатора. Они аналогичны корневым ресурсам за тем
исключением, что они не помечаются аннотацией @Path, поскольку путь к ним описывается в локаторе. Дочерние ресурсы, как правило, содержат методы с аннотациями, задающими тип обрабатываемых HTTP-запросов. Если они не содержат таких методов, то делегируют обработку запросов подходящему локатору дочерних ресурсов.
Слайд 93
Пример дочернего ресурса в JAX-RS import javax.ws.rs.GET; public class
Department { @GET public String getDepartmentName() {
... } } Методы ресурсов Методами ресурсов называются методы Java-классов, представляющих собой корневые или дочерние ресурсы. Эти методы привязаны к типам HTTP-запросов при помощи аннотаций
Слайд 94
Пример метода ресурса в JAX-RS import java.util.List; import javax.ws.rs.GET;
import javax.ws.rs.Path; @Path(value="/contacts") public class ContactsResource {
@GET public List getContacts() { ... } }
Слайд 95
Методы дочерних ресурсов Методы дочерних ресурсов аналогичны методам ресурсов
за тем исключением, что они дополнительно отмечены аннотацией @Path,
уточняющей, в каких случаях их следует вызывать. Пример метода дочернего ресурса в JAX-RS import java.util.List; import javax.ws.rs.GET; import javax.ws.rs.Path; @Path(value="/contacts") public class ContactsResource { @GET public List getContacts() { ... } //дочерний ресурс @GET @Path(value="/ids") public List getContactIds() { ... } }
Слайд 96
Локаторы дочерних ресурсов Локаторы дочерних ресурсов представляют собой методы,
служащие для уточнения того, какой ресурс должен обрабатывать входящий
запрос. Подобно методам дочерних ресурсов они отмечаются аннотацией @Path, однако в отличие от тех, они не привязаны к типам HTTP-запросов, в частности, у них аннотации @GET.
Слайд 97
Пример локатора дочернего ресурса в JAX-RS @Path(value="/contacts") public class
ContactsResource { @GET public List getContactss() { ... }
@GET @Path(value="/ids") public List getContactIds() { ... } //локатор дочернего ресурса @Path(value="/contact/{contactName}/department") public Department getContactDepartment( @PathParam(value="contactName") String contactName) { ... } } Любой HTTP-запрос, отправленный по адресу /contact/{contactName}/department, будет обработан локатором getContactDepartment. Фрагмент {contactName} относительного пути запроса означает, что вслед за префиксом contact может следовать любая последовательность символов, удовлетворяющая правилам URL.
Слайд 98
Аннотации Рассмотрим основные аннотации и варианты их применения. Аннотация @Path Аннотация
@Path используется для описания пути к корневому ресурсу, дочернему
ресурсу или описания метода дочернего ресурса. Атрибут value может содержать символы, простые переменные, а также переменные, включающие регулярные выражения.
Слайд 99
@Path(value="/contacts") public class ContactsResource { @GET @Path(value="/{emailAddress:.+@.+\\.[a-z]+}")
public ContactInfo getByEmailAddress( @PathParam(value="emailAddress") String
@PUT, @DELETE и @HEAD соответствуют типам HTTP-запросов. Их можно
использовать для привязки методов корневых и дочерних ресурсов к запросам соответствующих типов. Запросы типа GET передаются на обработку методам, аннотированным @GET, запросы типа @POST – методам с аннотацией @POST и т.д. При этом существует возможность определения дополнительных аннотаций для обработки нестандартных HTTP-запросов. Для этого служит аннотация @HttpMethod.
Слайд 101
Объявление новой аннотации, соответствующей HTTP-запросам типа GET import java.lang.annotation.ElementType;
Слайд 104
Методы getByEmailAddress и addContactInfo, могут обрабатывать запросы с
типом содержимого text/xml и application/json. Представление входящего или возвращаемого
ресурса зависит от параметров в заголовке HTTP-запроса, устанавливаемых клиентом. Значение аннотации @Consumes сверяется с параметром Content-Type для того, чтобы определить, способен ли метод обработать содержимое полученного запроса.
Слайд 105
Провайдеры Провайдерами в JAX-RS называются компоненты, определяющие три ключевых
аспекта в поведении приложения: связывание с данными, сопоставление исключений
и разрешение контекста (примером последнего может служить предоставление экземпляров JAXBContext среде выполнения). Каждый провайдер JAX-RS должен быть отмечен аннотацией @Provider. Ниже приведен пример провайдеров MessageBodyWriter и MessageBodyReader, реализующих операции связывания с данными.
Слайд 106
Провайдер MessageBodyWriter Экземпляры этого класса используются средой выполнения JAX-RS
для сериализации представления возвращаемого клиенту ресурса. Реализации сред выполнения,
удовлетворяющие JSR-311, должны самостоятельно поддерживать общеупотребительные типы данных, в том числе java.lang.String, java.io.InputStream, объекты JAXB и т.д., однако пользователь может указать среде, что следует использовать предоставленный ей провайдер (класс-наследник MessageBodyWriter).
Слайд 107
@Provider @Produces("text/xml") public class ContactInfoWriter implements MessageBodyWriter {
Слайд 108
Класс ContactInfoWriter будет вызываться средой JAX-RS перед сериализацией возвращаемых
клиенту ресурсов. Если метод isWriteable провайдера возвращает true, а
значение его аннотации @Produces наиболее точно соответствует значению той же аннотации метода ресурса, то будет вызван метод writeTo. В этом случае класс ContactInfoWriter будет отвечать за сериализацию содержимого экземпляра ContactInfo в нижележащий поток вывода (OutputStream).
Слайд 109
Провайдер MessageBodyReader Провайдеры MessageBodyReaders выполняют функцию, обратную по отношению
к MessageBodyWriter. Реализации JAX-RS самостоятельно поддерживают восстановление из потока
ввода (эта операция называется десериализацией) экземпляров тех же типов, что и для сериализации. При этом пользователи могут предоставлять среде собственные классы-наследники MessageBodyReader. Основная функция такого провайдера заключается в чтении данных из потока ввода (InputStream) и восстановлении содержимого Java-объектов, которые ожидает получить на вход метод ресурса, из неструктурированного набора байтов.
Слайд 110
@Provider @Consumes("text/xml") public class ContactInfoReader implements
Слайд 111
Подобно методу MessageBodyWriter.isWriteable, метод isReadable класса ContactInfoReader будет
вызываться средой JAX-RS чтобы определить, способен ли провайдер десериализовать
поступающие на вход данные. Если этот метод возвращает true, а значение аннотации @Consumes наиболее точно соответствует значению той же аннотации метода ресурса, то провайдер будет выбран для десериализации. Метод readFrom должен возвращать экземпляры класса ContactInfo, содержимое которых было восстановлено из потока ввода (InputStream).
Слайд 112
Классы, описывающие конфигурацию Выше были рассмотрены классы ресурсов JAX-RS,
а также некоторые из классов-провайдеров (MessageBodyReader и MessageBodyWriter). Далее
мы перейдем к вопросам конфигурирования этих классов внутри среды выполнения JAX-RS, которое производится при помощи расширения класса javax.ws.rs.core.Application. Этот класс предоставляет список классов (или объектов-синглетонов), включающих набор всех корневых ресурсов и провайдеров приложения JAX-RS.
Слайд 113
public class ContactInfoApplicaiton extends Application {
public Set>
classes = new HashSetSet>(); classes.add(ContactsResource.class); classes.add(ContactInfoWriter.class); classes.add(ContactInfoReader.class); } public SetSet
Слайд 114
Среда выполнения JAX-RS вызывает метод getClasses для получения
списка классов, предоставляющих все необходимые метаданные. Применение синглетонов для
ресурсов JAX-RS должно тщательно продумываться и в общем случае не рекомендуется.
Слайд 115
Рассмотрим пример простейшего Rest сервиса(используется jersey 2.0) package ua.rest;
jersey.config.server.provider.packages ua.rest // где искать классы с сервисами
1
Rest /api/*
Слайд 117
WebSockets Метод WebSockets, который появился в HTML5. WebSockets создает
двунаправленные, дуплексные каналы связи. Соединение открывается посредством HTTP-запроса со специальными
заголовками, который называется рукопожатием WebSockets. Это соединение сохраняется постоянно, и через него можно записывать и получать данные посредством JavaScript, как при использовании стандартного сокета TCP. URL WebSocket начинается с ws:// или wss:// (по SSL).
Слайд 118
Временная диаграмма на иллюстрирует связь с использованием WebSockets
Слайд 119
JavaScript позволяет использовать WebSockets, если эту возможность поддерживает
браузер. var ws = new WebSocket('ws://127.0.0.1:8080/async'); ws.onopen = function() {
// вызывается при открытии соединения }; ws.onerror = function(e) { // вызывается в случае ошибки, например, при обрыве связи }; ws.onclose = function() { // вызывается при закрытии соединения }; ws.onmessage = function(msg) { // вызывается, когда сервер посылает сообщение клиенту. // сообщение содержится в msg.data. }; ws.send('some data'); ws.close();
Слайд 120
Отправляемые и получаемые данные могут быть любого типа.
WebSockets можно рассматривать как TCP сокеты, так что решение
о том, какой тип данных использовать, остается за клиентом и сервером. При создании объекта JavaScript WebSocket в HTTP-запросах в консоли браузера видны заголовки рукопожатия WebSocket. Request URL:ws://127.0.0.1:8080/async Request Method:GET Status Code:101 WebSocket Protocol Handshake Request Headers Connection:Upgrade Host:127.0.0.1:8080 Origin:http://localhost:8080 Sec-WebSocket-Key1:1 &1~ 33188Yd]r8dp W75q Sec-WebSocket-Key2:1 7; 229 *043M 8 Upgrade:WebSocket (Key3):B4:BB:20:37:45:3F:BC:C7
Response):AC:23:A5:7E:5D:E5:04:6A:B5:F8:CC:E7:AB:6D:1A:39 Все заголовки используются процессом рукопожатия WebSocket
для установки и настройки долгоживущего соединения. Объект WebSocket JavaScript также содержит два полезных свойства: ws.url Возвращает URL сервера WebSocket. ws.readyState Возвращает значение текущего состояния соединения: CONNECTING = 0 OPEN = 1 CLOSED = 2
Слайд 122
На стороне сервера получим(используются WebSockets Tomcat): @ServerEndpoint("/ws") public class
WebSocket { @OnOpen public void onOpen(Session session){
System.out.println(session.getId() + " has opened a connection"); try { session.getBasicRemote().sendText("Connection Established"); } catch (IOException ex) { ex.printStackTrace(); } }
Слайд 123
@OnMessage public void onMessage(String message, Session session,
boolean last){ System.out.println("Message from " +