SOAP API
В уроке ранее вы познакомились с тем, какие стили взаимодействия бывают. В этом уроке вы познакомились с фундаментальным фреймворком для обмена сообщениями веб-сервисов SOAP.
SOAP — это фундаментальный фреймворк для обмена сообщениями веб-сервисов. SOAP обеспечивает значительную отказоустойчивость, масштабируемость и гибкость при развертывании взаимодействия с использованием различных технологий.
Существует три основных особенности SOAP:
- Формат обмена данными SOAP всегда использует XML для запросов и ответов;
- Модель обработки данных SOAP описывает, как именно сервис должен обработать сообщения;
- Возможность использовать разные сетевые протоколы Существует механизм, позволяющий привязать SOAP сообщения к различным сетевым протоколам;
Стиль SOAP API
Изначально SOAP был разработан как простой протокол доступа к объектам (от англ. Simple Object Access Protocol) для корпорации Microsoft.
Авторы представили спецификацию SOAP 1.1 в Консорциум World Wide Web (W3C) в мае 2000 года, но эта версия не стала стандартом взаимодействия для сети Интернет. Поэтому спецификацию передали для стандартизации специальной рабочей группе.
В июне 2003 года рабочая группа представила версию 1.2 спецификации SOAP, которая в итоге была признана веб-стандартом и рекомендована к применению Консорциумом W3C.
В версии 1.2 спецификации SOAP расшифровку «простой протокол доступа к объектам» решили убрать. SOAP перестали как-либо расшифровывать и стали называть просто SOAP. Дело в том, что SOAP никогда не был протоколом доступа к объектам, таким как, например, протокол межобъектного взаимодействия (Inter-Object Request Protocol — IIOP). SOAP всегда был моделью обмена сообщениями.
Кроме того, некоторые представители IT-индустрии считали, что SOAP, несмотря на название, вряд ли можно считать простым. Например, в книге «Шаблоны интеграции корпоративных приложений» (Enterprise Integration Pattern) Грегор Хоп (Gregor Hohpe) и Бобби Вульф (Bobby Wolf) писали:
Мы часто шутим, что SOAP следовало бы переименовать в сложный протокол удалённого доступа (Complex Remote Access Protocol — CRAP).
Но не стоит называть SOAP протоколом. Это частая ошибка, которую допускают на собеседованиях кандидаты на вакансию. SOAP — это фреймворк, он предоставляет набор готовых инструментов, которые упрощают разработку.
API, реализованный с использованием спецификации SOAP, называют SOAP API. Сейчас SOAP API уступает по популярности стилю REST API. Но есть приложения, которые по-прежнему используют SOAP. Они особенно распространены в банковской и телекоммуникационной индустриях, потому что стиль SOAP API обеспечивает значительную отказоустойчивость, масштабируемость и гибкость при развёртывании взаимодействия с использованием различных технологий.
Составляющие стандарта SOAP
SOAP определяется набором соглашений, определяющих формат сообщения и набор правил, задающих то, как сообщение будет обрабатываться системой. То есть правила передачи информации в SOAP строго стандартизированы, есть спецификация, которую необходимо выполнять.
SOAP может использоваться с любым протоколом прикладного уровня, например, SMTP, FTP или протокол IBM WebSphereMQ, но чаще всего SOAP использует HTTP-протокол.
Основными составляющими стиля SOAP являются:
- Сообщение
Сообщение SOAP — это основная единица связи между узлами SOAP.
- Узел
Узел SOAP — это программная реализация правил обработки SOAP-сообщения, то есть того, как сообщения будут приниматься и обрабатываться.
Сообщения SOAP
Сообщение состоит из следующих элементов.
- Конверт SOAP (SOAP Envelope,
soap:Envelope) Это корневой элемент, который определяет сообщение и пространство имён. Пространство имён — это некоторое множество, под которым понимается абстрактное хранилище, созданное для логической группировки имён.
Предположим, что сервис обеспечивает работу с таблицами. Можно «добавить» таблицу, строку, столбец. Чтобы не расширять количество уникальных имён, можно придумать три пространства имён: таблица (
t), строка (r) и столбец (c). Тогда для добавления новой строки, например, можно будет указать r:add.Конверт SOAP содержит ноль или более заголовков SOAP. Наличие заголовков зависит от конкретной реализации стиля в конкретном сервисе. Так как, по сути, сообщение SOAP — это XML-документ, конверт SOAP является элементом верхнего уровня документа XML (
soap:Envelope).XML
- Заголовок SOAP (SOAP Header,
soap:Header) Содержит атрибуты сообщения, например, цифровую подпись в случае защищённого соединения. Заголовок предназначен для любого получателя (узла) SOAP, который может находиться на пути сообщения SOAP. - Тело SOAP (SOAP Body,
soap:Body) Содержит непосредственно сообщение, которым обмениваются приложения. Тело SOAP может содержать, например, запрос сервиса и входные данные для него. - При обработке сообщения получатель SOAP может сгенерировать состояние ошибки. В этом случае узел SOAP возвратит сообщение SOAP с ошибкой в необязательном элементе (
soap:Fault).
Схематично SOAP-сообщение с его вложенными элементами можно представить так:
Ниже приведён пример сообщения SOAP:
- Вначале указана декларация
<?xml version="1.0"?>. - Далее указан конверт SOAP, который содержит информацию о пространстве имён
xmlns:soap="http://www.w3.org/2003/05/soap-envelope/"и определение типов данныхsoap:encodingStyle="http://www.w3.org/2003/05/soap-encoding". - Далее в теле письма прописан запрос стоимости товара (
<m:GetPrice>) с идентификатором 16396745 (<m:Item>16396745</m:Item>). Префиксmозначает, что эти теги определены в пространстве имён m.
XML
Ответ на такое сообщение может выглядеть так:
XML
Из него можно понять, что на запрос стоимости товара был сформирован ответ (
<m:GetPriceResponse>) и товар стоит 1.90 (<m:Price>1.90</m:Price>).Перед вами SOAP-сообщение, сопоставьте его части с названием соответствующих элементов:
XML
<SOAP-ENV:Body xmlns:m = "http://www.xyz.org/quotations">Тело
Обратите внимание на имя тега: SOAP-ENV:Body. Это тело SOAP-сообщения, содержащее непосредственно сообщение.
<SOAP-ENV:Envelope
xmlns:SOAP-ENV = "http://www.w3.org/2001/12/soap-envelope"
SOAP-ENV:encodingStyle = "http://www.w3.org/2001/12/soap-encoding">Конверт
Обратите внимание на имя тега: SOAP-ENV:Envelope. Это корневой элемент SOAP-сообщения, то есть конверт.
Узел SOAP
Узлы SOAP могут отправлять и получать сообщения SOAP.
- Если узел SOAP передаёт сообщение, он называется отправителем SOAP.
- Если узел получает сообщение, он называется получателем SOAP.
- Некоторые узлы SOAP могут как получать, так и передавать сообщения. В этом случае их называют посредниками SOAP.
- Отправитель SOAP, который первым формирует сообщение SOAP, называется исходным отправителем SOAP.
- Конечный пункт назначения сообщения называется конечным получателем SOAP. Именно этот узел SOAP отвечает за обработку сообщения, содержащегося в теле SOAP.
Обычно сообщение SOAP проходит через несколько узлов SOAP:
- Первоначальный отправитель SOAP создаёт сообщение.
- Сообщение проходит через различных посредников SOAP прежде, чем попасть к конечному получателю SOAP.
Этот набор узлов SOAP называется путём сообщения SOAP. В некоторых случаях сообщение SOAP может не достичь предполагаемого конечного получателя SOAP из-за ошибки посредника SOAP при обработке сообщения.
Рассмотрим путь сообщения и узлы на простом примере. В крупной компании есть внутренний корпоративный сервис по бронированию билетов в командировки.
- Чтобы забронировать билет, сотрудник (отправитель) формирует документ со всеми необходимыми данными для оформления билетов и отправляет его посреднику.
- Посредник в зависимости от департамента сотрудника, срочности оформления командировки и страны назначения добавит ответственного за оформление командировки и передаст обновлённый документ получателю.
- Получатель, в свою очередь, сформирует задание конкретному человеку, ответственному за оформление командировки и покупку билетов.
Соотнесите типы SOAP-узлов из списка ниже с их определениями.
Узел SOAP, который может как получать, так и передавать сообщения
Посредник SOAP
Если узел SOAP как получает, так и передаёт, он называется посредник SOAP.
Узел SOAP, принимающий сообщение
Получатель SOAP
Если узел получает сообщение, он называется получателем SOAP.
Узел SOAP, передающий сообщение
Отправитель SOAP
Если узел SOAP передаёт сообщение, он называется отправителем SOAP.
Связи
Спецификация SOAP определяет структуру сообщений SOAP, но не способ обмена ими. Отсутствие структурированного способа обмена заполняется тем, что называется «связями». Связи — это механизмы, позволяющие эффективно обмениваться сообщениями SOAP с использованием транспортного протокола.
Связь описывает способ прямого и обратного преобразования между входящим элементом XML и конкретным сервисом (вплоть до имени и класса, например, для Java).
Большинство реализаций SOAP предоставляют связи для общих транспортных протоколов, таких как: HTTP или SMTP.
Стили взаимодействия
SOAP поддерживает два стиля взаимодействия: RPC (вызов удалённых процедур) и обмен сообщениями.
Для стиля обмена сообщениями тело SOAP содержит бизнес-документ, например, заказ на покупку или бронирование авиабилетов, который передаётся на обработку запрашиваемому сервису. После обработки документа сервис возвращает другой документ, который может содержать, например, информацию о подтверждении того, что заказ или бронирование выполнено.
Для RPC тело SOAP содержит имя вызываемой процедуры вместе с входными данными. После вызова процедуры возвращается результат и набор выходных данных.
Подведём итоги
SOAP — это набор соглашений, определяющих формат сообщения вместе с набором правил, задающих то, как сообщение будет обрабатываться.
- SOAP всегда использует XML для запросов и ответов.
- SOAP может использоваться с любым протоколом прикладного уровня, но чаще всего SOAP используется с HTTP-протоколом.
Основные составляющие стиля SOAP:
- Сообщение.
- Узел.
Сообщение SOAP — это основная единица связи между узлами SOAP, по сути, XML-документ, который состоит из:
- конверта (Envelope,
soap:Envelope), - заголовка (Header,
soap:Header), - тела (Body,
soap:Body).
Узел SOAP — это программная реализация правил обработки SOAP-сообщения, то есть того, как сообщения будут приниматься и обрабатываться.
- Если узел SOAP передаёт сообщение, он называется отправителем SOAP.
- Если узел получает сообщение, он называется получателем SOAP.
- Некоторые узлы SOAP могут как получать, так и передавать сообщения. В этом случае их называют посредниками SOAP.
SOAP поддерживает два стиля взаимодействия: RPC (вызов удалённых процедур) и обмен сообщениями.