Skip to content

20. Exercício da Aplicação – Versão 10

A versão anterior mostrou que os dados fiscais, partilhados por todos os utilizadores da aplicação, devem ser armazenados num cache de âmbito [Application]. Iremos utilizar um servidor Redis [https://redis.io] para implementar isto.

20.1. Redis

A memória de âmbito [Application] será implementada por um servidor Redis. Os scripts PHP que necessitam desta memória da aplicação serão clientes deste servidor:

Image

20.2. Instalação do Redis

O Laragon vem com um servidor Redis que não está ativado por predefinição. Por isso, deve começar por ativá-lo:

Image

  • Em [3], ative o servidor [Redis];
  • Em [4], deixe a porta [6379] como a predefinição utilizada pelos clientes Redis;

Os serviços do Laragon são reiniciados automaticamente após o Redis ser ativado:

Image

20.3. O cliente Redis no modo de comando

O servidor Redis pode ser consultado no modo de comando. Abra um terminal Laragon (consulte a secção de links):

Image

  • Em [1], o comando [redis-cli] inicia o cliente no modo de comando para o servidor Redis;

Em julho de 2019, o cliente Redis suportava 172 comandos para interagir com o servidor [https://redis.io/commands#list]. Um deles [contagem de comandos] [2] exibe este número [3].

Abordaremos apenas os que precisamos para a nossa aplicação PHP. Utilizaremos o Redis com um único objetivo: armazenar um array [‘atributo’=>’valor’] na memória do Redis. Isto é feito com o comando Redis [set atributo valor] [4]. O valor pode então ser recuperado utilizando o comando [get atributo] [5]. É tudo o que precisamos.

Pode ser necessário limpar a memória do Redis. Isto é feito com o comando [flushdb] [6]. Depois, se consultarmos o valor do atributo [title] [7], obtemos uma referência [nil] [8] indicando que o atributo não foi encontrado. Também podemos usar o comando [exists] [9-10] para verificar se um atributo existe.

Para sair do cliente Redis, digite o comando [quit] [11].

20.4. Instalar um cliente Redis para PHP

Agora precisamos de instalar um cliente Redis para PHP:

Image

Existem várias bibliotecas que implementam um cliente Redis. Iremos utilizar a biblioteca [Predis] [https://github.com/nrk/predis] (julho de 2019). Tal como as anteriores, esta é instalada com o [composer] num terminal Laragon:

Image

20.5. Código do servidor

Image

O ficheiro de configuração [config-server.json] é alterado da seguinte forma:


{
    "rootDirectory": "C:/myprograms/laragon-lite/www/php7/scripts-web/impots/version-10",
    "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"
    ],
    "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"
}

Comentários

  • linhas 5–15: A versão 10 não introduz nada de novo, além do script [impots-server.php]. Ela utiliza elementos das versões 08 e 09;
  • linha 19: uma dependência necessária para a biblioteca [predis] que acabámos de instalar;

O código do servidor [impots-server.php] sofre as seguintes alterações:


<?php
 
// strict adherence to declared types of function parameters
declare (strict_types=1);
 
// namespace
namespace Application;
 
// error handling by PHP
ini_set("display_errors", "0");
//
// configuration file path
define("CONFIG_FILENAME", "Data/config-server.json");
// class alias
use \Application\ServerDaoWithSession as ServerDaoWithRedis;
 
// session
$session = new Session();
$session->start();
…
…
// 1st log
$logger->write("\n---nouvelle requête\n");
 
// retrieve the current query
$request = Request::createFromGlobals();
// authentication only the 1st time
if (!$session->has("user")) {
  …
} else {
  // log
  $logger->write("Authentification prise en session…\n");
}
 
// we have a valid user - we check the parameters received
$erreurs = [];
// you need three parameters GET
$method = strtolower($request->getMethod());
…
 
// mistakes?
if ($erreurs) {
// an error code 400 HTTP_BAD_REQUEST is sent to the customer
  sendResponse($response, ["erreurs" => $erreurs], Response::HTTP_BAD_REQUEST, [], $logger);
  // completed
  exit;
} else {
  // logs
  $logger->write("paramètres ['marié'=>$marié, 'enfants'=>$enfants, 'salaire'=>$salaire] valides\n");
}
 
// we've got everything you need to work
// Redis
\Predis\Autoloader::register();
try {
  // customer [predis]
  $redis = new \Predis\Client();
  // connect to the server to see if it's there
  $redis->connect();
} catch (\Predis\Connection\ConnectionException $ex) {
  // internal server error
  doInternalServerError("[redis], " . utf8_encode($ex->getMessage()), $response, $config['adminMail'], $logger);
  // completed
  exit;
}
 
// creation of the [dao] layer
if (!$redis->get("taxAdminData")) {
  // tax data is taken from the database
  $logger->write("données fiscales prises en base de données\n");
  try {
    // construction of the [dao] layer
    $dao = new ServerDaoWithRedis($config["databaseFilename"], NULL);
    // put tax data in scope memory [application]
    // method [TaxAdminData]->__toString will be called implicitly
    $redis->set("taxAdminData", $dao->getTaxAdminData());
  } catch (\RuntimeException $ex) {
    // we note the error
    doInternalServerError("[dao], " . utf8_encode($ex->getMessage()), $response, $config['adminMail'], $logger, $redis);
    // completed
    exit;
  }
} else {
  // tax data are taken from the [application] scope memory
  $arrayOfAttributes = \json_decode($redis->get("taxAdminData"), true);
  $taxAdminData = (new TaxAdminData())->setFromArrayOfAttributes($arrayOfAttributes);
  // istanciation of the [dao] layer
  $dao = new ServerDaoWithRedis(NULL, $taxAdminData);
  // logs
  $logger->write("données fiscales prises dans redis\n");
}
// creation of the [business] layer
$métier = new ServerMetier($dao);
// tAX CALCULATION
$result = $métier->calculerImpot($marié, (int) $enfants, (int) $salaire);
// we return the answer
sendResponse($response, $result, Response::HTTP_OK, [], $logger, $redis);
// end
exit;
 
function doInternalServerError(string $message, Response $response, array $infos,
  Logger $logger = NULL, \Predis\Client $predisClient = NULL) {
  // $message: error message
  // $response : answer HTTP
  // $infos: information table for sending mail
  // $result: results table
  // $logger: application logger
  // $predisClient: a customer [predis]
  //
  // send an e-mail to the administrator
  // SendAdminMail intercepts all exceptions and logs them itself
  $infos['message'] = $message;
  $sendAdminMail = new SendAdminMail($infos, $logger);
  $sendAdminMail->send();
  // an error code 500 is sent to the customer
  sendResponse($response, ["erreur" => $message], Response::HTTP_INTERNAL_SERVER_ERROR, [], $logger, $predisClient);
}

// function to send HTTP response to client
function sendResponse(Response $response, array $result, int $statusCode,
  array $headers, Logger $logger = NULL, \Predis\Client $predisClient = NULL) {
  // $response : answer HTTP
  // $result: results table
  // $statusCode: HTTP response status
  // $headers: HTTP headers to be included in the response
  // $logger: application logger
  // $predisClient: a customer [predis]
  //
  // status HTTTP
  $response->setStatusCode($statusCode);
  // body
  $body = \json_encode(["réponse" => $result], JSON_UNESCAPED_UNICODE);
  $response->setContent($body);
  // headers
  $response->headers->add($headers);
  // shipping
  $response->send();
  // log
  if ($logger != NULL) {
    $logger->write("$body\n");
    $logger->close();
  }
  // close connection [redis]
  if ($predisClient != NULL) {
    $predisClient->disconnect();
  }
}

Comentários

  • linha 15: atribuímos o alias [ServerDaoWithRedis] à classe [\Application\ServerDaoWithSession] para refletir a alteração na implementação do script do servidor;
  • linhas 18–19: a sessão é mantida. Aqui, precisamos de ter em conta duas informações:
    • o facto de o utilizador ter sido autenticado com sucesso. Esta informação tem âmbito [sessão]: está ligada a um utilizador específico e não é válida para outros utilizadores;
    • os dados da administração fiscal. Esta informação tem âmbito [application]: não está ligada a um utilizador específico, mas aplica-se a todos os utilizadores;
  • linhas 54–64: criação do cliente [redis] que irá comunicar com o servidor [redis]. Este cliente irá comunicar com a porta predefinida do servidor. Se o servidor não estivesse a comunicar na sua porta predefinida ou se não estivesse na máquina [localhost], esta informação teria de ser passada ao construtor da classe [\Predis\Client];
  • linha 59: o cliente é imediatamente ligado ao servidor para verificar se este responde;
  • linhas 60–65: se a ligação ao servidor Redis falhar, é enviada uma resposta de erro ao cliente e um e-mail é enviado ao administrador da aplicação;
  • linha 67: consultamos o servidor [redis] pela chave [taxAdminData]. Se não for encontrada, os dados fiscais são recuperados da base de dados (linha 72);
  • linha 75: a chave [taxAdminData] é armazenada na memória [redis] juntamente com a cadeia JSON da variável [$taxAdminData], que é um objeto do tipo [TaxAdminData]. O método [$redis→set] espera uma string como valor da chave. Por isso, tentará converter o objeto [TaxAdminData] para o tipo [string]. Isto chama implicitamente o método [TaxAdminData->__toString], que produz a string JSON do objeto [TaxAdminData];
  • linha 84: a chave [taxAdminData] está na memória [redis], pelo que recuperamos o seu valor. Sabemos que se trata da cadeia JSON de um objeto [TaxAdminData]. Em seguida, analisamos esta cadeia para obter uma matriz de atributos;
  • linha 85: a partir desta matriz, é instanciado um novo objeto [TaxAdminData];
  • linha 87: a camada [dao] é instanciada;

20.6. Código do cliente

Image

A versão 10 do cliente é idêntica à versão 9. A única alteração é no ficheiro de configuração [config-client.json]:


{
    "rootDirectory": "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-10",
    "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",
        "/../version-09/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-10/impots-server.php"
}

A única alteração é o URL do servidor na linha 24.

Os resultados são os mesmos da versão 09. Vamos apenas testar um novo caso de erro:

Image

O resultado na consola é o seguinte:


L'erreur suivante s'est produite : {"statut HTTP":500,"erreur":"[redis], Aucune connexion n’a pu être établie car l’ordinateur cible l’a expressément refusée. [tcp:\/\/127.0.0.1:6379]"}
Terminé

20.7. [Codeception] testes de cliente

Image

A classe de teste [ClientMetierTest] na versão 10 é idêntica à da versão 09, com uma exceção:


<?php
 
// strict adherence to declared types of function parameters
declare (strict_types=1);
 
// namespace
namespace Application;
 
// definition of constants
define("ROOT", "C:/Data/st-2019/dev/php7/poly/scripts-console/impots/version-10");

…
 
}
  • linha 10: o ambiente de teste é o do cliente da versão 10;

Antes de iniciar os testes, vamos usar o cliente [redis-cli] para eliminar a chave [taxAdminData] da memória do servidor [redis]:

Image

Agora, vamos executar o teste:

Image

Agora vamos examinar os registos do servidor [logs.txt]:


05/07/19 08:52:16:396 :
---nouvelle requête
05/07/19 08:52:16:403 : Autentification en cours…
05/07/19 08:52:16:403 : Authentification réussie [admin, admin]
05/07/19 08:52:16:403 : paramètres ['marié'=>oui, 'enfants'=>2, 'salaire'=>55555] valides
05/07/19 08:52:16:407 : données fiscales prises en base de données
05/07/19 08:52:16:420 : {"réponse":{"impôt":2814,"surcôte":0,"décôte":0,"réduction":0,"taux":0.14}}
05/07/19 08:52:16:546 :
---nouvelle requête
05/07/19 08:52:16:555 : Autentification en cours…
05/07/19 08:52:16:555 : Authentification réussie [admin, admin]
05/07/19 08:52:16:556 : paramètres ['marié'=>oui, 'enfants'=>2, 'salaire'=>50000] valides
05/07/19 08:52:16:559 : données fiscales prises dans redis
05/07/19 08:52:16:559 : {"réponse":{"impôt":1384,"surcôte":0,"décôte":384,"réduction":347,"taux":0.14}}
05/07/19 08:52:16:668 :
---nouvelle requête
05/07/19 08:52:16:675 : Autentification en cours…
05/07/19 08:52:16:675 : Authentification réussie [admin, admin]
05/07/19 08:52:16:675 : paramètres ['marié'=>oui, 'enfants'=>3, 'salaire'=>50000] valides
05/07/19 08:52:16:678 : données fiscales prises dans redis
05/07/19 08:52:16:678 : {"réponse":{"impôt":0,"surcôte":0,"décôte":720,"réduction":0,"taux":0.14}}
05/07/19 08:52:16:776 :
---nouvelle requête
…

Já mencionámos que, para cada teste, o construtor da classe de teste é reexecutado, o que significa que a classe [ClientDao] que está a ser testada é instanciada com um cookie de sessão inexistente para cada teste. Tudo decorre, portanto, como se os 11 testes representassem 11 utilizadores diferentes, com 11 sessões diferentes.

  • linha 6: os dados fiscais são recuperados da base de dados;
  • linhas 13, 20: os dados fiscais são recuperados da memória [Redis]. Temos, portanto, uma memória de âmbito [aplicação] partilhada por todos os utilizadores da aplicação;

20.8. Interface Web do Servidor [Redis]

Vimos que o servidor [Redis] pode ser gerido no modo de comando. Também pode ser gerido através de uma interface web:

Image

  • em [4], o URL de administração;
  • em [5], as chaves armazenadas pelo servidor;
  • em [6], o estado atual do servidor;

Ao clicar em [5], pode visualizar informações sobre a chave [taxAdminData]:

Image

  • em [7], o URL que dá acesso às informações da chave [taxAdminData] [8];
  • em [9], o estado da chave;
  • em [10], o seu valor: é possível reconhecer a cadeia JSON de um objeto [TaxAdminData];
  • Em [11], pode eliminar a chave;
  • em [12], pode adicionar outra;
https://stahe.github.io
Este curso-tutorial escrito por Serge Tahé é disponibilizado ao público de acordo com os termos da Licença Creative Commons Atribuição – Sem uso comercial – Partilha nas mesmas condições 3.0 não adaptada.