Skip to content

22. Ćwiczenie praktyczne – wersja 11

Nadal często zdarza się, że serwisy internetowe wysyłają swoją odpowiedź w postaci strumienia XML zamiast strumienia jSON:

  • strumień jSON jest lżejszy, ale do jego zrozumienia potrzebna jest instrukcja obsługi;
  • strumień XML jest bardziej rozbudowany, ale zawiera wbudowaną dokumentację. Jego zrozumienie jest natychmiastowe;

Modyfikujemy wersję 11 klienta/serwera tak, aby serwer wysyłał teraz strumień XML jako odpowiedź dla swoich klientów:

Image

22.1. Serwer

Image

Architektura ta zostanie zaimplementowana za pomocą następujących skryptów:

Image

22.1.1. Klasa [Utilitaires]

Wykorzystujemy klasę [Utilitaires] stosowaną od wersji 03 (patrz akapit „link”):


<?php

// przestrzeń nazw
namespace Application;

// klasa funkcji pomocniczych
abstract class Utilitaires {

  public static function cutNewLinechar(string $ligne): string {
    …
  }


  // źródło: https://stackoverflow.com/questions/1397036/how-to-convert-array-to-simplexml
  public static function getXmlForArrayOfAttributes(array $arrayOfAttributes,
    \SimpleXmlElement &$node): void {
    // przeskanowujemy atrybuty tablicy
    foreach ($arrayOfAttributes as $attribute => $value) {
      // czy atrybut jest liczbowy?
      if (is_numeric($attribute)) {
        // przypadek indeksu tablicy (ale także inne przypadki)
        $attribute = 'i' . $attribute;
      }
      // Czy $value jest tablicą?
      if (is_array($value)) {
        // teraz przeanalizujemy kolejno tablicę [$value]
        // dodajemy węzeł do grafu XML
        $subnode = $node->addChild($attribute);
        // wywołanie rekurencyjne w celu zbadania tablicy [$value]
        Utilitaires::getXmlForArrayOfAttributes($value, $subnode);
      } else {
        // dodajemy węzeł do grafu XML
        $node->addChild("$attribute", htmlspecialchars("$value"));
      }
    }
  }
}

Komentarze

  • wiersze 14–36: wprowadzamy metodę statyczną [getXmlForArrayOfAttributes], która zwraca ciąg znaków XML z tablicy [arrayOfAttributes] przekazanej jako parametr. Drugim parametrem jest odwołanie do węzła grafu XML, typu [SimpleXmlElement]. Po wykonaniu ten węzeł zawiera graf XML z tablicy [arrayOfAttributes];

Piszemy następujący test [testXml.php]:

Image


<?php

// zależność
require __DIR__ . "/Utilitaires.php";
// tablica asocjacyjna
$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();

Po uruchomieniu tego skryptu [2] w przeglądarce Chrome otrzymujemy następujący wynik:

Image

22.1.2. Skrypt serwerowy

Skrypt serwerowy [impots-server.php] należy zmodyfikować, podobnie jak jego plik konfiguracyjny [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"
}

Uwagi

  • katalogiem głównym projektu jest teraz folder wersji 11;
  • wiersz 16: dodano nową klasę [Utilitaires];

Zmiany w skrypcie serwera są następujące:


<?php

// ścisłe przestrzeganie zadeklarowanych typów parametrów funkcji
declare (strict_types=1);

// przestrzeń nazw
namespace Application;

…
// przygotowanie odpowiedzi serwera JSON
$response = new Response();
$response->headers->set("content-type", "application/xml");
$response->setCharset("utf-8");
…
// tworzenie warstwy [métier]
$métier = new ServerMetier($dao);
// obliczenie podatku
$result = $métier->calculerImpot($marié, (int) $enfants, (int) $salaire);
// przesyłanie odpowiedzi
sendResponse($response, $result, Response::HTTP_OK, [], $logger, $redis);
// koniec
exit;

function doInternalServerError(string $message, Response $response, array $infos,
  …
}

// funkcja wysyłania odpowiedzi HTTP do klienta
function sendResponse(Response $response, array $result, int $statusCode,
  array $headers, Logger $logger = NULL, \Predis\Client $predisClient = NULL) {
  // $response: odpowiedź HTTP
  // $result: tabela wyników
  // $statusCode: status odpowiedzi HTTP
  // $headers: nagłówki HTTP do umieszczenia w odpowiedzi
  // $logger: moduł rejestrujący aplikacji
  // $predisClient: klient [predis]
  //
  // status HTTTP
  $response->setStatusCode($statusCode);
  // treść XML
  $node = new \SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><réponse></réponse>");
  Utilitaires::getXmlForArrayOfAttributes($result, $node);
  $response->setContent($node->asXML());
  // nagłówki
  $response->headers->add($headers);
  // wysyłka
  $response->send();
  // log
  if ($logger != NULL) {
    // log w jSON
    $log = \json_encode(["réponse" => $result], JSON_UNESCAPED_UNICODE);
    $logger->write("$log\n");
    $logger->close();
  }
  // zamknięcie połączenia [redis]
  if ($predisClient != NULL) {
    $predisClient->disconnect();
  }
}

Komentarze

  • wiersz 12: wskazano, że odpowiedź jest typu [application/xml];
  • wiersze 29–59: odpowiedź serwera ma teraz typ XML;
  • wiersz 41: utworzono węzeł główny [<réponse></réponse>] w grafie XML;
  • wiersz 42: ten graf zostaje uzupełniony o graf XML z tabeli [$result] zawierającej wyniki, które mają zostać wysłane do klienta;
  • wiersz 43: graf XML jest konwertowany na ciąg XML w celu wysłania do klienta;

Test

Bezpośrednio w przeglądarce Chrome wpisujemy URL [http://localhost/php7/scripts-web/impots/version-11/impots-server.php?mari%C3%A9=oui&enfants=2&salaire=60000]. W przeglądarce Chrome otrzymujemy następujący wynik: [1]:

Image

22.2. Klient

Teraz zajmiemy się częścią aplikacji przeznaczoną dla klienta.

Image

Architektura ta zostanie zaimplementowana za pomocą następujących skryptów:

Image

W nowej wersji zmieniają się jedynie:

  • plik konfiguracyjny [config-client.json];
  • warstwa klienta o nazwie [dao];

Plik konfiguracyjny [config-client.json] przyjmuje następującą postać:


{
    "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. Warstwa [dao]

Klient [ClientDao.php] (wiersz 13 powyżej) zostaje zmodyfikowany w celu uwzględnienia nowego formatu odpowiedzi. Do jej przetworzenia wykorzystuje się [simpleXML]:


<?php

namespace Application;

// zależności
use \Symfony\Component\HttpClient\HttpClient;

class ClientDao implements InterfaceClientDao {
  // użycie cechy
  use TraitDao;
  // atrybuty
  private $urlServer;
  private $user;
  private $sessionCookie;

  // konstruktor
  public function __construct(string $urlServer, array $user) {
    $this->urlServer = $urlServer;
    $this->user = $user;
  }

  // obliczanie podatku
  public function calculerImpot(string $marié, int $enfants, int $salaire): array {
    …
    // pobieranie odpowiedzi XML
    $réponse = $response->getContent(false);
    $xml = new \SimpleXMLElement($réponse);
    // logi
    // wyświetl „$réponse\n”;
    // pobieramy status odpowiedzi
    $statusCode = $response->getStatusCode();
    // błąd?
    if ($statusCode !== 200) {
      // wystąpił błąd – generujemy wyjątek
      $message = \json_encode(["statut HTTP" => $statusCode, "réponse" => $xml], JSON_UNESCAPED_UNICODE);
      throw new ExceptionImpots($message);
    }
    if (!$this->sessionCookie) {
      // pobieramy plik cookie sesji
      $headers = $response->getHeaders();
      if (isset($headers["set-cookie"])) {
        // plik cookie sesji?
        foreach ($headers["set-cookie"] as $cookie) {
          $match = [];
          $match = preg_match("/^PHPSESSID=(.+?);/", $cookie, $champs);
          if ($match) {
            $this->sessionCookie = "PHPSESSID=" . $champs[1];
          }
        }
      }
    }
    // zwracamy odpowiedź w postaci tablicy
    return \json_decode(\json_encode($xml, JSON_UNESCAPED_UNICODE), true);
  }

}

Komentarze

  • wiersze 26–27: odczytywana jest odpowiedź serwera. Jest to dokument o nazwie XML [<réponse>…</réponse>]. Na podstawie otrzymanego dokumentu XML tworzony jest obiekt [SimpleXMLElement];
  • wiersze 33–37: w przypadku błędu komunikatem o wyjątku będzie ciąg znaków jSON z odpowiedzi serwera, a nie zebrany ciąg znaków XML. Ciąg znaków jSON jest bowiem bardziej zwięzły;
  • wiersz 53: tablica wyników jest zwracana w dwóch etapach:
    • obiekt [$xml] typu [\SimpleXMLElement] jest przekształcany w jSON;
    • uzyskany ciąg znaków jSON przekształca się w tablicę asocjacyjną. Jest to wynik, który należy zwrócić;

Test

Jeśli uruchomimy klienta w prawidłowym środowisku (baza danych, uwierzytelnianie, logi), otrzymamy typowe wyniki (sprawdź pliki [taxpayersdata.json, results.txt, errors.json]). Po stronie serwera logi wyglądają następująco:


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. Testy [Codeception]

Image

Test [ClientMetierTest] wygląda następująco:


<?php

// ścisłe przestrzeganie zadeklarowanych typów parametrów funkcji
declare (strict_types=1);

// przestrzeń nazw
namespace Application;

// definicja stałych
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-11");

// ścieżka do pliku konfiguracyjnego
define("CONFIG_FILENAME", ROOT . "/Data/config-client.json");

// pobieranie konfiguracji
$config = \json_decode(file_get_contents(CONFIG_FILENAME), true);

…
// klasa testowa
class ClientMetierTest extends Unit {
  // warstwa biznesowa
  private $métier;

  public function __construct() {
    parent::__construct();
    // pobieranie konfiguracji
    $config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
    // tworzenie warstwy [dao]
    $clientDao = new ClientDao($config["urlServer"], $config["user"]);
    // tworzenie warstwy [métier]
    $this->métier = new ClientMetier($clientDao);
  }

  // testy
  …
}

Wyniki testu są następujące:

Image

https://stahe.github.io
Ten kurs-samouczek, napisany przez Serge'a Tahé, jest udostępniany publicznie na warunkach licencji Creative Commons Uznanie autorstwa – Zakaz wykorzystania komercyjnego – Udostępnianie na tych samych warunkach 3.0 bez zmian.