22. Практичне завдання – версія 11
Досі часто трапляється, що веб-сервіси надсилають відповідь у вигляді потоку XML, а не jSON:
- потік jSON є компактнішим, але для його розуміння потрібна інструкція;
- потік XML є більш розлогим, але він самодокументований. Його можна зрозуміти одразу;
Ми модифікуємо версію 11 «клієнт/сервер» так, щоб сервер відтепер надсилав потік XML у відповідь своїм клієнтам:
22.1. Сервер
Ця архітектура буде реалізована за допомогою таких скриптів:
22.1.1. Клас [Utilitaires]
Ми використовуємо клас [Utilitaires], який застосовується починаючи з версії 03 (див. параграф «посилання»):
<?php
// простір імен
namespace Application;
// клас допоміжних функцій
abstract class Utilitaires {
public static function cutNewLinechar(string $ligne): string {
…
}
// з https://stackoverflow.com/questions/1397036/how-to-convert-array-to-simplexml
public static function getXmlForArrayOfAttributes(array $arrayOfAttributes,
\SimpleXmlElement &$node): void {
// сканування атрибутів масиву
foreach ($arrayOfAttributes as $attribute => $value) {
// чи є атрибут числовим?
if (is_numeric($attribute)) {
// випадок індексу масиву (а також інші випадки)
$attribute = 'i' . $attribute;
}
// Чи є $value масивом?
if (is_array($value)) {
// тепер розглянемо масив [$value]
// додаємо вузол до графа XML
$subnode = $node->addChild($attribute);
// рекурсивний виклик для обходу масиву [$value]
Utilitaires::getXmlForArrayOfAttributes($value, $subnode);
} else {
// додаємо вузол до графа XML
$node->addChild("$attribute", htmlspecialchars("$value"));
}
}
}
}
Коментарі
- рядки 14–36: ми вводимо статичний метод [getXmlForArrayOfAttributes], який повертає рядок XML з масиву [arrayOfAttributes], переданого як параметр. Другим параметром є посилання на вузол графа XML типу [SimpleXmlElement]. Після виконання цей вузол містить граф XML з масиву [arrayOfAttributes];
Ми пишемо такий тест [testXml.php]:
<?php
// залежність
require __DIR__ . "/Utilitaires.php";
// асоціативний масив
$array = ["nom" => "amédée", "prénom" => "sylvain", "âge" => 40,
"enfants" => [["nom" => "amédée", "prénom" => "béatrice", "âge" => 6],
["nom" => "amédée", "prénom" => "bertrand", "âge" => 4]]];
// xml
header("Content-Type: application/xml");
$node = new \SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><root></root>");
\Application\Utilitaires::getXmlForArrayOfAttributes($array, $node);
print $node->asXML();
При виконанні цього скрипта [2] у браузері Chrome ми отримуємо таке:
22.1.2. Серверний скрипт
Серверний скрипт [impots-server.php] та його файл конфігурації [config-server.json] потрібно змінити таким чином:
{
"rootDirectory": "C:/myprograms/laragon-lite/www/php7/scripts-web/impots/version-11",
"databaseFilename": "Data/database.json",
"relativeDependencies": [
"/../version-08/Entities/BaseEntity.php",
"/../version-08/Entities/ExceptionImpots.php",
"/../version-08/Entities/TaxAdminData.php",
"/../version-08/Entities/Database.php",
"/../version-08/Dao/InterfaceServerDao.php",
"/../version-08/Dao/ServerDao.php",
"/../version-09/Dao/ServerDaoWithSession.php",
"/../version-08/Métier/InterfaceServerMetier.php",
"/../version-08/Métier/ServerMetier.php",
"/../version-09/Utilities/Logger.php",
"/../version-09/Utilities/SendAdminMail.php",
"/Utilities/Utilitaires.php"
],
"absoluteDependencies": [
"C:/myprograms/laragon-lite/www/vendor/autoload.php",
"C:/myprograms/laragon-lite/www/vendor/predis/predis/autoload.php"
],
"users": [
{
"login": "admin",
"passwd": "admin"
}
],
"adminMail": {
"smtp-server": "localhost",
"smtp-port": "25",
"from": "guest@localhost",
"to": "guest@localhost",
"subject": "plantage du serveur de calcul d'impôts",
"tls": "FALSE",
"attachments": []
},
"logsFilename": "Data/logs.txt"
}
Коментарі
- кореневою папкою проекту тепер є папка версії 11;
- рядок 16: додано новий клас [Utilitaires];
Зміни у скрипті сервера такі:
<?php
// суворе дотримання оголошених типів параметрів функцій
declare (strict_types=1);
// простір імен
namespace Application;
…
// підготовка відповіді JSON від сервера
$response = new Response();
$response->headers->set("content-type", "application/xml");
$response->setCharset("utf-8");
…
// створення шару [métier]
$métier = new ServerMetier($dao);
// розрахунок податку
$result = $métier->calculerImpot($marié, (int) $enfants, (int) $salaire);
// відправляється відповідь
sendResponse($response, $result, Response::HTTP_OK, [], $logger, $redis);
// кінець
exit;
function doInternalServerError(string $message, Response $response, array $infos,
…
}
// функція відправлення відповіді HTTP клієнту
function sendResponse(Response $response, array $result, int $statusCode,
array $headers, Logger $logger = NULL, \Predis\Client $predisClient = NULL) {
// $response: відповідь HTTP
// $result: таблиця результатів
// $statusCode: статус HTTP відповіді
// $headers: заголовки HTTP, які слід включити у відповідь
// $logger: модуль реєстрації додатка
// $predisClient: клієнт [predis]
//
// статус HTTTP
$response->setStatusCode($statusCode);
// тіло XML
$node = new \SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><réponse></réponse>");
Utilitaires::getXmlForArrayOfAttributes($result, $node);
$response->setContent($node->asXML());
// заголовки
$response->headers->add($headers);
// відправлення
$response->send();
// журнал
if ($logger != NULL) {
// журнал у jSON
$log = \json_encode(["réponse" => $result], JSON_UNESCAPED_UNICODE);
$logger->write("$log\n");
$logger->close();
}
// закриття з'єднання [redis]
if ($predisClient != NULL) {
$predisClient->disconnect();
}
}
Коментарі
- рядок 12: вказується, що відповідь має тип [application/xml];
- рядки 29–59: відповідь сервера тепер має тип XML;
- рядок 41: створено кореневий вузол [<réponse></réponse>] графа XML;
- рядок 42: цей граф доповнюється графом XML з масиву [$result] результатів, що мають бути надіслані клієнту;
- рядок 43: граф XML перетворюється на ланцюжок XML для надсилання клієнту;
Тест
Безпосередньо в браузері Chrome вводимо URL [http://localhost/php7/scripts-web/impots/version-11/impots-server.php?mari%C3%A9=oui&enfants=2&salaire=60000]. У браузері Chrome отримуємо такий результат: [1]:
22.2. Клієнт
Тепер розглянемо клієнтську частину додатка.
Ця архітектура буде реалізована за допомогою таких скриптів:
У новій версії змінюються лише:
- конфігураційний файл [config-client.json];
- шар [dao] клієнта;
Файл конфігурації [config-client.json] набуває такого вигляду:
{
"rootDirectory": "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-11",
"taxPayersDataFileName": "Data/taxpayersdata.json",
"resultsFileName": "Data/results.json",
"errorsFileName": "Data/errors.json",
"dependencies": [
"/../version-08/Entities/BaseEntity.php",
"/../version-08/Entities/TaxPayerData.php",
"/../version-08/Entities/ExceptionImpots.php",
"/../version-08/Utilities/Utilitaires.php",
"/../version-08/Dao/InterfaceClientDao.php",
"/../version-08/Dao/TraitDao.php",
"/Dao/ClientDao.php",
"/../version-08/Métier/InterfaceClientMetier.php",
"/../version-08/Métier/ClientMetier.php"
],
"absoluteDependencies": [
"C:/myprograms/laragon-lite/www/vendor/autoload.php"
],
"user": {
"login": "admin",
"passwd": "admin"
},
"urlServer": "https://localhost:443/php7/scripts-web/impots/version-11/impots-server.php"
}
22.2.1. Рівень [dao]
Клієнт [ClientDao.php] (рядок 13 вище) змінюється з урахуванням нового формату відповіді. Для її обробки використовується [simpleXML]:
<?php
namespace Application;
// залежності
use \Symfony\Component\HttpClient\HttpClient;
class ClientDao implements InterfaceClientDao {
// використання Trait
use TraitDao;
// атрибути
private $urlServer;
private $user;
private $sessionCookie;
// конструктор
public function __construct(string $urlServer, array $user) {
$this->urlServer = $urlServer;
$this->user = $user;
}
// розрахунок податку
public function calculerImpot(string $marié, int $enfants, int $salaire): array {
…
// отримання відповіді XML
$réponse = $response->getContent(false);
$xml = new \SimpleXMLElement($réponse);
// журнали
// print "$réponse\n";
// отримуємо статус відповіді
$statusCode = $response->getStatusCode();
// помилка?
if ($statusCode !== 200) {
// виникла помилка — генерується виняток
$message = \json_encode(["statut HTTP" => $statusCode, "réponse" => $xml], JSON_UNESCAPED_UNICODE);
throw new ExceptionImpots($message);
}
if (!$this->sessionCookie) {
// отримуємо сесійний файл cookie
$headers = $response->getHeaders();
if (isset($headers["set-cookie"])) {
// файл cookie сеансу?
foreach ($headers["set-cookie"] as $cookie) {
$match = [];
$match = preg_match("/^PHPSESSID=(.+?);/", $cookie, $champs);
if ($match) {
$this->sessionCookie = "PHPSESSID=" . $champs[1];
}
}
}
}
// повертаємо відповідь у вигляді масиву
return \json_decode(\json_encode($xml, JSON_UNESCAPED_UNICODE), true);
}
}
Коментарі
- рядки 26–27: зчитується відповідь сервера. Це документ XML [<réponse>…</réponse>]. На основі отриманого документа XML створюється об’єкт [SimpleXMLElement];
- рядки 33–37: у разі помилки повідомленням про виняток буде рядок jSON із відповіді сервера, а не зібраний рядок XML. Адже рядок jSON є більш лаконічним;
- рядок 53: масив результатів повертається у два етапи:
- об’єкт [$xml] типу [\SimpleXMLElement] перетворюється на jSON;
- отриманий рядок jSON перетворюється на асоціативний масив. Це і є результат, який потрібно повернути;
Тест
Якщо запустити клієнт у правильному середовищі (база даних, автентифікація, журнали), отримаємо звичні результати (перевірте файли [taxpayersdata.json, results.txt, errors.json]). Щодо сервера, то журнали мають такий вигляд:
06/07/19 07:41:32:877 :
---nouvelle requête
06/07/19 07:41:32:882 : Autentification en cours…
06/07/19 07:41:32:883 : Authentification réussie [admin, admin]
06/07/19 07:41:32:883 : paramètres ['marié'=>oui, 'enfants'=>2, 'salaire'=>55555] valides
06/07/19 07:41:32:908 : données fiscales prises en base de données
06/07/19 07:41:32:959 : {"réponse":{"impôt":2814,"surcôte":0,"décôte":0,"réduction":0,"taux":0.14}}
06/07/19 07:41:33:070 :
---nouvelle requête
06/07/19 07:41:33:077 : Authentification prise en session…
06/07/19 07:41:33:077 : paramètres ['marié'=>oui, 'enfants'=>2, 'salaire'=>50000] valides
06/07/19 07:41:33:099 : données fiscales prises dans redis
06/07/19 07:41:33:100 : {"réponse":{"impôt":1384,"surcôte":0,"décôte":384,"réduction":347,"taux":0.14}}
06/07/19 07:41:33:189 :
---nouvelle requête
06/07/19 07:41:33:202 : Authentification prise en session…
06/07/19 07:41:33:202 : paramètres ['marié'=>oui, 'enfants'=>3, 'salaire'=>50000] valides
06/07/19 07:41:33:233 : données fiscales prises dans redis
06/07/19 07:41:33:233 : {"réponse":{"impôt":0,"surcôte":0,"décôte":720,"réduction":0,"taux":0.14}}
06/07/19 07:41:33:318 :
…
22.2.2. Тести [Codeception]
Тест [ClientMetierTest] виглядає так:
<?php
// суворе дотримання оголошених типів параметрів функцій
declare (strict_types=1);
// простір імен
namespace Application;
// визначення констант
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-11");
// шлях до файлу конфігурації
define("CONFIG_FILENAME", ROOT . "/Data/config-client.json");
// отримання конфігурації
$config = \json_decode(file_get_contents(CONFIG_FILENAME), true);
…
// клас тестування
class ClientMetierTest extends Unit {
// бізнес-шар
private $métier;
public function __construct() {
parent::__construct();
// завантаження конфігурації
$config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
// створення шару [dao]
$clientDao = new ClientDao($config["urlServer"], $config["user"]);
// створення шару [métier]
$this->métier = new ClientMetier($clientDao);
}
// тестування
…
}
Результати тесту такі:
