Skip to content

22. Toepassingsopgave – versie 11

Het komt nog steeds vaak voor dat webservices hun antwoord versturen in de vorm van een stream XML in plaats van een stream jSON:

  • de stream jSON is compacter, maar je hebt een handleiding nodig om hem te begrijpen;
  • de stream XML is uitgebreider, maar is zelfdocumenterend. Deze is direct te begrijpen;

We passen de client/server-versie 11 aan, zodat de server voortaan een stream XML als antwoord naar zijn clients stuurt:

Image

22.1. De server

Image

Deze architectuur wordt geïmplementeerd door de volgende scripts:

Image

22.1.1. De klasse [Utilitaires]

We gebruiken de klasse [Utilitaires] die al vanaf versie 03 wordt gebruikt (zie paragraaf 'link'):


<?php

// naamruimte
namespace Application;

// een klasse met hulpprogramma's
abstract class Utilitaires {

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


  // van https://stackoverflow.com/questions/1397036/how-to-convert-array-to-simplexml
  public static function getXmlForArrayOfAttributes(array $arrayOfAttributes,
    \SimpleXmlElement &$node): void {
    // de attributen van de array worden gescand
    foreach ($arrayOfAttributes as $attribute => $value) {
      // is het attribuut numeriek?
      if (is_numeric($attribute)) {
        // het geval van de array-index (maar ook andere gevallen)
        $attribute = 'i' . $attribute;
      }
      // Is $value een array?
      if (is_array($value)) {
        // we gaan nu de array [$value] onderzoeken
        // we voegen een knooppunt toe aan de grafiek XML
        $subnode = $node->addChild($attribute);
        // recursieve aanroep om de array [$value] te verkennen
        Utilitaires::getXmlForArrayOfAttributes($value, $subnode);
      } else {
        // het knooppunt wordt toegevoegd aan de grafiek XML
        $node->addChild("$attribute", htmlspecialchars("$value"));
      }
    }
  }
}

Opmerkingen

  • regels 14-36: we introduceren de statische methode [getXmlForArrayOfAttributes] die de tekenreeks XML van een als parameter doorgegeven array [arrayOfAttributes] retourneert. De tweede parameter is de referentie van een knooppunt van een grafiek XML, van het type [SimpleXmlElement]. Na uitvoering bevat dit knooppunt de grafiek XML uit de tabel [arrayOfAttributes];

We schrijven de volgende test [testXml.php]:

Image


<?php

// afhankelijkheid
require __DIR__ . "/Utilitaires.php";
// associatieve array
$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();

Wanneer we dit script [2] uitvoeren, krijgen we het volgende te zien in een Chrome-browser:

Image

22.1.2. Het serverscript

Het serverscript [impots-server.php] moet worden aangepast, evenals het bijbehorende configuratiebestand [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"
}

Opmerkingen

  • de hoofdmap van het project is nu de map van versie 11;
  • regel 16: de nieuwe klasse [Utilitaires] wordt opgenomen;

De wijzigingen in het serverscript zijn als volgt:


<?php

// strikte naleving van de gedeclareerde typen van functieparameters
declare (strict_types=1);

// naamruimte
namespace Application;

…
// voorbereiding van het antwoord JSON van de server
$response = new Response();
$response->headers->set("content-type", "application/xml");
$response->setCharset("utf-8");
…
// aanmaken van de laag [métier]
$métier = new ServerMetier($dao);
// berekening van de belasting
$result = $métier->calculerImpot($marié, (int) $enfants, (int) $salaire);
// het antwoord wordt teruggestuurd
sendResponse($response, $result, Response::HTTP_OK, [], $logger, $redis);
// einde
exit;

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

// functie voor het verzenden van het antwoord HTTP naar de klant
function sendResponse(Response $response, array $result, int $statusCode,
  array $headers, Logger $logger = NULL, \Predis\Client $predisClient = NULL) {
  // $response: antwoord HTTP
  // $result: resultatenoverzicht
  // $statusCode: status HTTP van het antwoord
  // $headers: HTTP-headers die in het antwoord moeten worden opgenomen
  // $logger: de logger van de applicatie
  // $predisClient: een client [predis]
  //
  // status HTTTP
  $response->setStatusCode($statusCode);
  // hoofdtekst XML
  $node = new \SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><réponse></réponse>");
  Utilitaires::getXmlForArrayOfAttributes($result, $node);
  $response->setContent($node->asXML());
  // headers
  $response->headers->add($headers);
  // verzending
  $response->send();
  // log
  if ($logger != NULL) {
    // log in jSON
    $log = \json_encode(["réponse" => $result], JSON_UNESCAPED_UNICODE);
    $logger->write("$log\n");
    $logger->close();
  }
  // verbinding verbreken [redis]
  if ($predisClient != NULL) {
    $predisClient->disconnect();
  }
}

Opmerkingen

  • regel 12: er wordt aangegeven dat het antwoord van het type [application/xml] is;
  • regels 29-59: het antwoord van de server is nu van het type XML;
  • regel 41: aanmaak van het hoofdknooppunt [<réponse></réponse>] van de grafiek XML;
  • regel 42: deze grafiek wordt aangevuld met de grafiek XML uit de tabel [$result] met de resultaten die naar de klant moeten worden verzonden;
  • regel 43: de grafiek XML wordt omgezet in de reeks XML voor verzending naar de klant;

Test

Rechtstreeks in een Chrome-browser typen we URL [http://localhost/php7/scripts-web/impots/version-11/impots-server.php?mari%C3%A9=oui&enfants=2&salaire=60000] in. We krijgen het volgende resultaat [1] in een Chrome-browser:

Image

22.2. De klant

We richten ons nu op het clientgedeelte van de applicatie.

Image

Deze architectuur wordt geïmplementeerd door de volgende scripts:

Image

In de nieuwe versie veranderen alleen:

  • het configuratiebestand [config-client.json];
  • de [dao]-laag van de client;

Het configuratiebestand [config-client.json] ziet er nu als volgt uit:


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

De client [ClientDao.php] (regel 13 hierboven) wordt aangepast om rekening te houden met het nieuwe antwoordformaat. [simpleXML] wordt gebruikt om dit te verwerken:


<?php

namespace Application;

// afhankelijkheden
use \Symfony\Component\HttpClient\HttpClient;

class ClientDao implements InterfaceClientDao {
  // gebruik van een Trait
  use TraitDao;
  // attributen
  private $urlServer;
  private $user;
  private $sessionCookie;

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

  // belastingberekening
  public function calculerImpot(string $marié, int $enfants, int $salaire): array {
    …
    // het antwoord wordt opgehaald XML
    $réponse = $response->getContent(false);
    $xml = new \SimpleXMLElement($réponse);
    // logbestanden
    // print "$réponse\n";
    // we halen de status van het antwoord op
    $statusCode = $response->getStatusCode();
    // fout?
    if ($statusCode !== 200) {
      // er is een fout opgetreden – er wordt een uitzondering gegenereerd
      $message = \json_encode(["statut HTTP" => $statusCode, "réponse" => $xml], JSON_UNESCAPED_UNICODE);
      throw new ExceptionImpots($message);
    }
    if (!$this->sessionCookie) {
      // we halen de sessiecookie op
      $headers = $response->getHeaders();
      if (isset($headers["set-cookie"])) {
        // sessiecookie?
        foreach ($headers["set-cookie"] as $cookie) {
          $match = [];
          $match = preg_match("/^PHPSESSID=(.+?);/", $cookie, $champs);
          if ($match) {
            $this->sessionCookie = "PHPSESSID=" . $champs[1];
          }
        }
      }
    }
    // we geven het antwoord weer in de vorm van een array
    return \json_decode(\json_encode($xml, JSON_UNESCAPED_UNICODE), true);
  }

}

Opmerkingen

  • regels 26-27: het antwoord van de server wordt ingelezen. Het is een document XML [<réponse>…</réponse>]. Er wordt een object [SimpleXMLElement] geconstrueerd op basis van het ontvangen document XML;
  • regels 33-37: in geval van een fout zal het uitzonderingsbericht de tekenreeks jSON uit het antwoord van de server zijn in plaats van de verzamelde tekenreeks XML. De tekenreeks jSON is namelijk beknopter;
  • regel 53: de resultatenlijst wordt in twee stappen weergegeven:
    • het object [$xml] van het type [\SimpleXMLElement] wordt omgezet in jSON;
    • de verkregen tekenreeks jSON wordt omgezet in een associatieve tabel. Dit is het resultaat dat moet worden weergegeven;

Test

Als de client wordt gestart met de juiste omgeving (database, authenticatie, logbestanden), worden de gebruikelijke resultaten verkregen (controleer de bestanden [taxpayersdata.json, results.txt, errors.json]). Aan de serverzijde zijn de logbestanden als volgt:


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

Image

De test [ClientMetierTest] ziet er als volgt uit:


<?php

// strikte naleving van de gedeclareerde typen van de functieparameters
declare (strict_types=1);

// naamruimte
namespace Application;

// definitie van constanten
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-11");

// pad naar het configuratiebestand
define("CONFIG_FILENAME", ROOT . "/Data/config-client.json");

// de configuratie wordt opgehaald
$config = \json_decode(file_get_contents(CONFIG_FILENAME), true);

…
// testklasse
class ClientMetierTest extends Unit {
  // bedrijfslaag
  private $métier;

  public function __construct() {
    parent::__construct();
    // de configuratie ophalen
    $config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
    // aanmaken van de laag [dao]
    $clientDao = new ClientDao($config["urlServer"], $config["user"]);
    // aanmaken van de laag [métier]
    $this->métier = new ClientMetier($clientDao);
  }

  // tests
  …
}

De testresultaten zijn als volgt:

Image

https://stahe.github.io
Deze cursus-tutorial, geschreven door Serge Tahé, wordt aan het publiek ter beschikking gesteld volgens de voorwaarden van de Creative Commons Naamsvermelding – Geen commercieel gebruik – Delen onder dezelfde voorwaarden 3.0 ongewijzigd.