Skip to content

22. Esercizio pratico – versione 11

È ancora frequente che i servizi web inviino la loro risposta sotto forma di un flusso XML anziché di un flusso jSON:

  • il flusso jSON è più snello, ma per comprenderlo occorre una guida all’uso;
  • il flusso XML è più dettagliato ma è autodocumentato. La sua comprensione è immediata;

Modifichiamo la versione 11 client/server in modo che il server invii d'ora in poi un flusso XML come risposta ai propri client:

Image

22.1. Il server

Image

Questa architettura sarà implementata dai seguenti script:

Image

22.1.1. La classe [Utilitaires]

Riprendiamo la classe [Utilitaires] utilizzata a partire dalla versione 03 (cfr. paragrafo "link"):


<?php

// spazio dei nomi
namespace Application;

// una classe di funzioni di utilità
abstract class Utilitaires {

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


  // da https://stackoverflow.com/questions/1397036/how-to-convert-array-to-simplexml
  public static function getXmlForArrayOfAttributes(array $arrayOfAttributes,
    \SimpleXmlElement &$node): void {
    // si analizzano gli attributi dell'array
    foreach ($arrayOfAttributes as $attribute => $value) {
      // L'attributo è numerico?
      if (is_numeric($attribute)) {
        // caso dell'indice dell'array (ma anche altri casi)
        $attribute = 'i' . $attribute;
      }
      // $value è un array?
      if (is_array($value)) {
        // Esploreremo a nostra volta l'array [$value]
        // si aggiunge un nodo al grafo XML
        $subnode = $node->addChild($attribute);
        // chiamata ricorsiva per esplorare l'array [$value]
        Utilitaires::getXmlForArrayOfAttributes($value, $subnode);
      } else {
        // si aggiunge il nodo al grafo XML
        $node->addChild("$attribute", htmlspecialchars("$value"));
      }
    }
  }
}

Commenti

  • righe 14-36: introduciamo il metodo statico [getXmlForArrayOfAttributes] che restituisce la stringa XML di un array [arrayOfAttributes] passato come parametro. Il secondo parametro è il riferimento a un nodo di un grafo XML, di tipo [SimpleXmlElement]. Dopo l'esecuzione, questo nodo contiene il grafo XML dell'array [arrayOfAttributes];

Scriviamo il test [testXml.php] seguente:

Image


<?php

// dipendenza
require __DIR__ . "/Utilitaires.php";
// tabella associativa
$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();

Quando si esegue questo script [2], si ottiene il seguente risultato in un browser Chrome:

Image

22.1.2. Lo script del server

Lo script del server [impots-server.php] deve essere modificato, così come il relativo file di configurazione [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"
}

Note

  • la radice del progetto è ora la cartella della versione 11;
  • riga 16: si include la nuova classe [Utilitaires];

Le modifiche allo script del server sono le seguenti:


<?php

// rigoroso rispetto dei tipi dichiarati dei parametri delle funzioni
declare (strict_types=1);

// spazio dei nomi
namespace Application;

…
// preparazione della risposta JSON del server
$response = new Response();
$response->headers->set("content-type", "application/xml");
$response->setCharset("utf-8");
…
// creazione del livello [métier]
$métier = new ServerMetier($dao);
// calcolo dell'imposta
$result = $métier->calculerImpot($marié, (int) $enfants, (int) $salaire);
// invio della risposta
sendResponse($response, $result, Response::HTTP_OK, [], $logger, $redis);
// fine
exit;

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

// funzione di invio della risposta HTTP al cliente
function sendResponse(Response $response, array $result, int $statusCode,
  array $headers, Logger $logger = NULL, \Predis\Client $predisClient = NULL) {
  // $response: risposta HTTP
  // $result: tabella dei risultati
  // $statusCode: stato HTTP della risposta
  // $headers: intestazioni HTTP da inserire nella risposta
  // $logger: il logger dell'applicazione
  // $predisClient: un client [predis]
  //
  // stato HTTTP
  $response->setStatusCode($statusCode);
  // corpo XML
  $node = new \SimpleXMLElement("<?xml version='1.0' encoding='UTF-8'?><réponse></réponse>");
  Utilitaires::getXmlForArrayOfAttributes($result, $node);
  $response->setContent($node->asXML());
  // intestazioni
  $response->headers->add($headers);
  // invio
  $response->send();
  // registro
  if ($logger != NULL) {
    // log in jSON
    $log = \json_encode(["réponse" => $result], JSON_UNESCAPED_UNICODE);
    $logger->write("$log\n");
    $logger->close();
  }
  // chiusura della connessione [redis]
  if ($predisClient != NULL) {
    $predisClient->disconnect();
  }
}

Commenti

  • riga 12: si specifica che la risposta è di tipo [application/xml];
  • righe 29-59: la risposta del server è ora di tipo XML;
  • riga 41: creazione del nodo radice [<réponse></réponse>] del grafo XML;
  • riga 42: questo grafo viene integrato con il grafo XML della tabella [$result] dei risultati da inviare al cliente;
  • riga 43: il grafico XML viene convertito nella stringa XML per l’invio al cliente;

Test

Direttamente in un browser Chrome, si digita URL [http://localhost/php7/scripts-web/impots/version-11/impots-server.php?mari%C3%A9=oui&enfants=2&salaire=60000]. Si ottiene il seguente risultato [1] in un browser Chrome:

Image

22.2. Il cliente

Passiamo ora alla parte client dell’applicazione.

Image

Questa architettura sarà implementata dai seguenti script:

Image

Nella nuova versione cambiano solo:

  • il file di configurazione [config-client.json];
  • il livello [dao] del cliente;

Il file di configurazione [config-client.json] diventa il seguente:


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

Il client [ClientDao.php] (riga 13 sopra) viene modificato per tenere conto del nuovo formato della risposta. Per elaborarla si utilizza [simpleXML]:


<?php

namespace Application;

// dipendenze
use \Symfony\Component\HttpClient\HttpClient;

class ClientDao implements InterfaceClientDao {
  // utilizzo di un Trait
  use TraitDao;
  // attributi
  private $urlServer;
  private $user;
  private $sessionCookie;

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

  // calcolo dell'imposta
  public function calculerImpot(string $marié, int $enfants, int $salaire): array {
    …
    // si recupera la risposta XML
    $réponse = $response->getContent(false);
    $xml = new \SimpleXMLElement($réponse);
    // log
    // stampa "$réponse\n";
    // si recupera lo stato della risposta
    $statusCode = $response->getStatusCode();
    // errore?
    if ($statusCode !== 200) {
      // si verifica un errore - si genera un'eccezione
      $message = \json_encode(["statut HTTP" => $statusCode, "réponse" => $xml], JSON_UNESCAPED_UNICODE);
      throw new ExceptionImpots($message);
    }
    if (!$this->sessionCookie) {
      // si recupera il cookie di sessione
      $headers = $response->getHeaders();
      if (isset($headers["set-cookie"])) {
        // cookie di sessione?
        foreach ($headers["set-cookie"] as $cookie) {
          $match = [];
          $match = preg_match("/^PHPSESSID=(.+?);/", $cookie, $champs);
          if ($match) {
            $this->sessionCookie = "PHPSESSID=" . $champs[1];
          }
        }
      }
    }
    // si restituisce la risposta sotto forma di array
    return \json_decode(\json_encode($xml, JSON_UNESCAPED_UNICODE), true);
  }

}

Commenti

  • righe 26-27: viene letta la risposta del server. Si tratta di un documento XML [<réponse>…</réponse>]. Viene creato un oggetto [SimpleXMLElement] a partire dal documento XML ricevuto;
  • righe 33-37: in caso di errore, il messaggio dell’eccezione sarà la stringa jSON della risposta del server anziché la stringa XML raccolta. Infatti, la stringa jSON è più concisa;
  • riga 53: si restituisce la tabella dei risultati in due fasi:
    • l’oggetto [$xml] di tipo [\SimpleXMLElement] viene convertito in jSON;
    • la stringa jSON ottenuta viene trasformata in un array associativo. Questo è il risultato da restituire;

Test

Se si avvia il client con un ambiente corretto (database, autenticazione, log), si ottengono i risultati consueti (verificare i file [taxpayersdata.json, results.txt, errors.json]). Sul lato server, i log sono i seguenti:


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

Image

Il test [ClientMetierTest] è il seguente:


<?php

// rigoroso rispetto dei tipi dichiarati dei parametri delle funzioni
declare (strict_types=1);

// spazio dei nomi
namespace Application;

// definizione delle costanti
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-11");

// percorso del file di configurazione
define("CONFIG_FILENAME", ROOT . "/Data/config-client.json");

// si recupera la configurazione
$config = \json_decode(file_get_contents(CONFIG_FILENAME), true);

…
// classe di test
class ClientMetierTest extends Unit {
  // livello business
  private $métier;

  public function __construct() {
    parent::__construct();
    // recupera la configurazione
    $config = \json_decode(\file_get_contents(CONFIG_FILENAME), true);
    // creazione del livello [dao]
    $clientDao = new ClientDao($config["urlServer"], $config["user"]);
    // creazione del livello [métier]
    $this->métier = new ClientMetier($clientDao);
  }

  // test
  …
}

I risultati del test sono i seguenti:

Image

https://stahe.github.io
Questo tutorial scritto da Serge Tahé è reso disponibile al pubblico secondo i termini della Creative Commons Attribuzione – Non commerciale – ShareAlike 3.0 Unported.