PHP 2016. Уровень 3.4: PHP + XML Web servises

01

XML Web Services. Обзор технологии

XML Web services - программы, доступ к которым осуществляется по протоколу HTTP, а обмен данными происходит в формате XML.

По мере развития информационных технологий возникали разные подходы к написанию программ: модульное программирование, событийно-ориентированное программирование, компонентно-ориентированное программирование и проектирование. Логическим продолжением этих подходов стала сервисно-ориентированная разработка программного обеспечения.

Применение сервисно-ориентированных подходов позволяет говорить о повторном использовании (reuse) на макро-уровне (уровне сервисов), в отличие от микро-уровня (уровня объектов). Сервисно-ориентированный подход предполагает использование простых и общепринятых стандартов, что позволяет самым разным приложениям использовать функциональность друг друга. Сервисы могут быть написаны с использованием самых разных языков программирования, на различных платформах. Кроме того, сервисы могут быть развернуты отдельно или в рамках программного комплекса в любой точке земного шара и будут таким образом предоставлять доступ к своей функциональности по сети.

В отличие от традиционного web-приложения, у web-сервиса нет пользовательского интерфейса. Вместо этого у него есть программный интерфейс, то есть web-сервис предоставляет функции (web-методы), которые могут быть вызваны удаленно (например, по сети Internet). Web-сервис не предназначен для обслуживания конечных пользователей. Его задача - предоставление услуг другим приложениям, будь то web-приложения, приложения с графическим пользовательским интерфейсом или консольные приложения.

Remote Procedure Call- подход, позволяющий программе вызывать процедуры из другого адресного пространства.

Реализации RPC:

• XML-RPC - текстовый протокол на базе HTTP (RFC-3529);
• SOAP - текстовый протокол на базе HTTP (RFC-4227);
• JSON-RPC - текстовый протокол на базе HTTP (RFC-4627);
• .NET Remoting - бинарный протокол на базе TCP, UDP, HTTP
• DCOM - MSRPC Microsoft Remote Procedure Call;
• Java RMI.
к оглавлению

02

SOAP

SOAP (от англ. Simple Object Access Protocol — простой протокол доступа к объектам) — протокол обмена структурированными сообщениями в распределённой вычислительной среде. Первоначально SOAP предназначался в основном для реализации удалённого вызова процедур (RPC). Сейчас протокол используется для обмена произвольными сообщениями в формате XML, а не только для вызова процедур. Официальная спецификация последней версии 1.2 протокола никак не расшифровывает название SOAP. SOAP является расширением протокола XML-RPC.

SOAP может использоваться с любым протоколом прикладного уровня: SMTP, FTP, HTTP, HTTPS и др. Однако его взаимодействие с каждым из этих протоколов имеет свои особенности, которые должны быть определены отдельно. Чаще всего SOAP используется поверх HTTP.

SOAP является одним из стандартов, на которых базируются технологии веб-служб.

Использование SOAP для передачи сообщений увеличивает их объём и снижает скорость обработки. В системах, где скорость важна, чаще используется пересылка XML-документов через HTTP напрямую, где параметры запроса передаются как обычные HTTP-параметры.

Для работы необходим подключенный модуль php_soap.dll. Основные SOAP классы: SoapServer, SoapClient.

https://proselyte.net/tutorials/soap-tutorial/element-fault/.

03

Пример использования SOAP. процедурный стиль

Напишем небольшой пример создания SOAP-службы, используя процедурный стиль.

Создание SOAP-сервера.

Создание файла stock.wsdl. Передираю весь код не особо заморачиваясь.

Создание SOAP-клиента.

Проверка работы php-класса SoapFault.

04

Пример использования SOAP. объектный стиль

Напишем небольшой пример создания SOAP-службы, используя объектный стиль. На сервере изменяется только одна строка: '$server->addFunction("getStock");' заменяется на '$server->setClass("StockService");'.

Создание SOAP-сервера.

Создание файла stock_o.wsdl. Меняем ссылку на SOAP-сервер.

Создание SOAP-клиента.

Получение информации о методах сервера и проверка работы php-класса SoapFault.

Array
(
    [0] => integer getStock(string $id)
)

05

Лабораторная работа №3.4.1 Использование SOAP веб-службы

• В текстовом редакторе откройте файл soap\soap-server.php
• Ознакомьтесь с содержимым службы NewsService
• В нижней части файла после описания класса введите следующий текст:

    // Отключение кеширования wsdl-документа
    ini_set("soap.wsdl_cache_enabled", "0");
    // Создание SOAP-сервера
    $server = new SoapServer("http://mysite.local/soap/news.wsdl");
    // Регистрация класса
    $server->setClass("NewsService");
    // Запуск сервера
    $server->handle();
  		

• Сохраните файл soap\soap-server.php

• В текстовом редакторе откройте файл soap\soap-client.php
• Пересохраните этот файл как C:\Users\Public\OpenServer\domains\localhost\soap-client.php
• В файле введите следующий текст:

    $client = new SoapClient("http://mysite.local/soap/news.wsdl");
    try{
      // Сколько новостей в категории Политика?
      $result = $client->getNewsCountByCat(1);
      echo "<p>Всего новостей в категории Политика:
      // Сколько новостей всего?<br>
      $result = $client->getNewsCount();
      echo "<p>Всего новостей: $result</p>";
      $result</p>";
      // Покажем конкретную новость
      $result = $client->getNewsById(1);
      $news = unserialize(base64_decode($result));
      var_dump($news);
    }catch(SoapFault $e){
      echo 'Операция '.$e->faultcode.' вернула ошибку: '.$e->getMessage();
    }
  		

• Сохраните файл soap-client.php

Подготовительные операции: копирование файлов новостной ленты, не требующих изменения и бездумное копирование news.wsdl - заменяем лишь адрес сервера.

Создание SOAP-сервера: файл soap-server.php.

Создание SOAP-клиента: файл laboratory_3.4.1.php.

laboratory_3.4.1.php.

06

Использование XML-RPC

07

Контекст потока

Контекст - это набор параметров и зависящих от контекста опций, который изменяет или расширяет поведение потока. Контексты создаются при помощи функции stream_context_create() и могут быть переданы большинству функций файловой системы, связанных с созданием потоков (например, fopen(), file(), file_get_contents(), и т. д...).

08

Лабораторная работа №3.4.2 Использование XML-RPC службы

• В текстовом редакторе откройте файл xml-rpc\xml-rpc-server.php
• Ознакомьтесь с содержимым службы NewsService
• В нижней части файла после описания класса введите следующий текст:

    /* Читаем запрос */
    $request = file_get_contents("php://input");
    /* Создаем XML-RPC сервер */
    $server = xmlrpc_server_create();
    /* Регистрируем метод класса */
    xmlrpc_server_register_method($server, "getNewsById", [new
    NewsService, "xmlRpcGetNewsById"]);
    /*Отдаем правильный заголовок*/
    header('Content-Type: text/xml;charset=utf-8');
    /* Отдаем результат */
    print xmlrpc_server_call_method($server, $request, null);
  		

• Сохраните файл xml-rpc\xml-rpc-server.php

• В текстовом редакторе откройте файл xml-rpc\xml-rpc-client.php
• Пересохраните этот файл как C:\Users\Public\OpenServer\domains\localhost\xml-rpc-client.php
• В файле введите следующий текст:

    header('Content-Type: text/html;charset=utf-8');
    /* Сюда приходят данные с сервера */
    $output = [];
    /* Основная функция */
    function make_request($xml, &$output){
      /* НАЧАЛО ЗАПРОСА */
      $options = [
        'http'=>[
          'method' => "POST",
          'header' => "User-Agent: PHPRPC/1.0\r\n" .
          "Content-Type: text/xml\r\n" .
          "Content-length: " . strlen($xml) . "\r\n",
          'content' => "$xml"
        ]
      ];
      $context = stream_context_create($options);
      $retval = file_get_contents('http://mysite.local/xml-rpc/xml-rpc-server.php', false, $context);
      /* КОНЕЦ ЗАПРОСА */
  
      $data = xmlrpc_decode($retval);
      if (is_array($data) && xmlrpc_is_fault($data)){
      $output = $data;
      }else{
      $output = unserialize(base64_decode($data));
      }
    }
  
    /* Идентификатор статьи */
    $id = 1;
    $request_xml = xmlrpc_encode_request('getNewsById',array($id));make_request($request_xml, $output);
  
    /* Вывод результата */
    var_dump($output);
  		

• Сохраните файл xml-rpc-client.php

Создание XML-RPC-клиента: файл laboratory_3.4.2.php.

laboratory_3.4.2.php.