Skip to content

27. Exercício prático: versão 9

Voltamos à versão 7 do exercício prático e, em vez de o cliente e o servidor web trocarem cadeias jSON, irão agora trocar cadeias XML.

A arquitetura mantém-se a mesma:

Image

27.1. O servidor web

Image

A pasta [http-servers/04] é obtida através da cópia da pasta [http-servers/02], com exceção da subpasta [utilities]. Em seguida, alteram-se os seguintes elementos:

Image

O ficheiro [config] é alterado da seguinte forma:


    # dependências absolutas
    absolute_dependencies = [
        # pastas do projeto
        # BaseEntity, MyException
        f"{root_dir}/classes/02/entities",
        # InterfaceImpôtsDao, InterfaceImpôtsMétier, InterfaceImpôtsUi
        f"{root_dir}/impots/v04/interfaces",
        # AbstractImpôtsdao, ImpôtsConsole, ImpôtsMétier
        f"{root_dir}/impots/v04/services",
        # ImpotsDaoWithAdminDataInDatabase
        f"{root_dir}/impots/v05/services",
        # AdminData, ImpôtsError, TaxPayer
        f"{root_dir}/impots/v04/entities",
        # Constantes, intervalos
        f"{root_dir}/impots/v05/entities",
        # index_controller
        f"{root_dir}/impots/http-servers/01/controllers",
        # scripts [config_database, config_layers]
        script_dir,
        # Logger, SendAdminMail
        f"{root_dir}/impots/http-servers/02/utilities",
    ]
  • linha 21: indica-se a pasta dos utilitários que permaneceram em [http-servers/02];

O script principal [main] é alterado da seguinte forma:


# Página inicial URL
@app.route('/', methods=['GET'])
@auth.login_required
def index():
    logger = None
    try:
        # logger
        logger = Logger(config["logsFilename"])
        # é guardado numa configuração associada ao thread
        thread_config = {"logger": logger}
        thread_name = threading.current_thread().name
        config[thread_name] = {"config": thread_config}
        # regista-se a solicitação
        logger.write(f"[index] requête : {request}\n")
        …
        # a solicitação é executada por um controlador
        résultat, status_code = index_controller.execute(request, config)
        # ocorreu algum erro fatal?
        …
        # regista-se a resposta
        logger.write(f"[index] {résultat}\n")
        # envia-se a resposta
        return xml_response(résultat, status_code)
    except BaseException as erreur:
        # regista-se o erro, se possível
        if logger:
            logger.write(f"[index] {erreur}")
        # prepara-se a resposta para o cliente
        résultat = {"réponse": {"erreurs": [f"{erreur}"]}}
        # envia-se a resposta
        return xml_response(résultat, status.HTTP_500_INTERNAL_SERVER_ERROR)
    finally:
        # fecha-se o ficheiro de registos, caso tenha sido aberto
        if logger:
            logger.close()
  • a única alteração ocorre na linha 23: passa-se agora a enviar uma resposta XML;

A função [xml_response] está definida no módulo [myutils]:


import xmltodict
…
def xml_response(résultat: dict, status_code: int) -> tuple:
    # resultado: o dicionário a converter em cadeia XML
    xmlString = xmltodict.unparse(résultat)
    # envia-se a resposta HTTP
    response = make_response(xmlString)
    response.headers['Content-Type'] = 'application/xml; charset=utf-8'
    return response, status_code
  • linha 3: a função [xml_response] recebe como parâmetros:
    • o dicionário [résultat] a ser transformado em XML;
    • o código de estado [status_code] a ser devolvido ao cliente web;
  • linha 5: utiliza-se a biblioteca [xmltodict] para gerar a cadeia XML;
  • linha 8: utiliza-se o cabeçalho [Content-Type] para informar ao cliente que lhe está a ser enviado XML;

A função [xml_response] deve ser importada para o script [__init__.py]:


from .myutils import set_syspath, json_response, decode_flask_session, xml_response

Em seguida, o módulo [myutils] deve ser incorporado nos módulos de âmbito da máquina. Isto é feito num terminal PyCharm com o comando [pip install .] (na pasta «packages»).

27.2. O cliente web

27.2.1. O código

Image

O ficheiro [http-clients/04] é obtido por cópia do cliente [http-clients/02]. Em seguida, alteramos a classe [ImpôtsDaoWithHttpClient] da seguinte forma:


# importações

import requests
import xmltodict
from flask_api import status

from AbstractImpôtsDao import AbstractImpôtsDao
from AdminData import AdminData
from ImpôtsError import ImpôtsError
from InterfaceImpôtsMétier import InterfaceImpôtsMétier
from TaxPayer import TaxPayer


class ImpôtsDaoWithHttpClient(AbstractImpôtsDao, InterfaceImpôtsMétier):

    # construtor
    def __init__(self, config: dict):
        …

    # método não utilizado
    def get_admindata(self) -> AdminData:
        pass

    # cálculo do imposto
    def calculate_tax(self, taxpayer: TaxPayer, admindata: AdminData = None):
        ….
        # código de estado da resposta HTTP
        status_code = response.status_code
        # a resposta XML é inserida num dicionário
        résultat = xmltodict.parse(response.text[39:])
        # erro se o código de estado for diferente de 200 OK
        ….
  • linha 30: a resposta HTTP [response] do servidor web é agora uma cadeia XML. Os registos mostram a natureza desta: 

2020-07-27 15:53:47.886283, Thread-2 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>non</marié><enfants>2</enfants><salaire>100000</salaire><impôt>19884</impôt><surcôte>4480</surcôte><taux>0.41</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>

A cadeia [<?xml version="1.0" encoding="utf-8"?>] tem 38 caracteres. Além disso, se analisarmos o ficheiro de registos com um editor hexadecimal, verificamos que, a seguir a esta cadeia, existe um caractere de salto de linha \n. Segue-se então a resposta <resposta>…</resposta>. A cadeia XML que temos de converter começa, portanto, após os primeiros 39 caracteres da cadeia XML. Começa a partir do caractere n.º 39, sendo o primeiro caractere numerado como 0. Esta cadeia é obtida através da expressão [résultat["réponse"]].

Se executarmos o cliente (siga o procedimento dos exemplos anteriores), obtemos os mesmos resultados no ficheiro [résultats.json] que nas versões anteriores. Os registos são os seguintes:


2020-07-27 16:21:14.015941, Thread-1 : début du thread [Thread-1] avec 2 contribuable(s)
2020-07-27 16:21:14.016940, Thread-1 : début du calcul de l'impôt de {"id": 1, "marié": "oui", "enfants": 2, "salaire": 55555}
2020-07-27 16:21:14.016940, Thread-2 : début du thread [Thread-2] avec 3 contribuable(s)
2020-07-27 16:21:14.018939, Thread-2 : début du calcul de l'impôt de {"id": 3, "marié": "oui", "enfants": 3, "salaire": 50000}
2020-07-27 16:21:14.019979, Thread-3 : début du thread [Thread-3] avec 3 contribuable(s)
2020-07-27 16:21:14.019979, Thread-3 : début du calcul de l'impôt de {"id": 6, "marié": "oui", "enfants": 3, "salaire": 100000}
2020-07-27 16:21:14.021938, Thread-4 : début du thread [Thread-4] avec 2 contribuable(s)
2020-07-27 16:21:14.021938, Thread-4 : début du calcul de l'impôt de {"id": 9, "marié": "oui", "enfants": 2, "salaire": 30000}
2020-07-27 16:21:14.021938, Thread-5 : début du thread [Thread-5] avec 1 contribuable(s)
2020-07-27 16:21:14.022939, Thread-5 : début du calcul de l'impôt de {"id": 11, "marié": "oui", "enfants": 3, "salaire": 200000}
2020-07-27 16:21:14.031942, Thread-1 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>oui</marié><enfants>2</enfants><salaire>55555</salaire><impôt>2814</impôt><surcôte>0</surcôte><taux>0.14</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>
2020-07-27 16:21:14.031942, Thread-1 : fin du calcul de l'impôt de {"id": 1, "marié": "oui", "enfants": 2, "salaire": 55555, "impôt": 2814, "surcôte": 0, "taux": 0.14, "décôte": 0, "réduction": 0}
2020-07-27 16:21:14.031942, Thread-1 : début du calcul de l'impôt de {"id": 2, "marié": "oui", "enfants": 2, "salaire": 50000}
2020-07-27 16:21:14.034941, Thread-4 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>oui</marié><enfants>2</enfants><salaire>30000</salaire><impôt>0</impôt><surcôte>0</surcôte><taux>0.0</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>
…
2020-07-27 16:21:17.055931, Thread-3 : fin du thread [Thread-3]
2020-07-27 16:21:17.059930, Thread-2 : <?xml version="1.0" encoding="utf-8"?>
<réponse><result><marié>non</marié><enfants>3</enfants><salaire>100000</salaire><impôt>16782</impôt><surcôte>7176</surcôte><taux>0.41</taux><décôte>0</décôte><réduction>0</réduction></result></réponse>
2020-07-27 16:21:17.060971, Thread-2 : fin du calcul de l'impôt de {"id": 5, "marié": "non", "enfants": 3, "salaire": 100000, "impôt": 16782, "surcôte": 7176, "taux": 0.41, "décôte": 0, "réduction": 0}
2020-07-27 16:21:17.060971, Thread-2 : fin du thread [Thread-2]

Do lado do servidor, os registos são os seguintes:


2020-07-27 16:32:04.983020, Thread-46 : [index] requête : <Request 'http://127.0.0.1:5000/?casado=sim&filhos=2&salário=50000' [GET]>
2020-07-27 16:32:04.983020, Thread-46 : [index] mis en pause du thread pendant 1 seconde(s)
2020-07-27 16:32:04.984021, Thread-47 : [index] requête : <Request 'http://127.0.0.1:5000/?casado=sim&filhos=2&salário=55555' [GET]>
2020-07-27 16:32:04.984021, Thread-47 : [index] mis en pause du thread pendant 1 seconde(s)
…
2020-07-27 16:32:07.001271, Thread-56 : [index] mis en pause du thread pendant 1 seconde(s)
2020-07-27 16:32:07.003078, Thread-54 : [index] {'réponse': {'result': {'marié': 'oui', 'enfants': 5, 'salaire': 100000, 'impôt': 4230, 'surcôte': 0, 'taux': 0.14, 'décôte': 0, 'réduction': 0}}}
2020-07-27 16:32:07.006078, Thread-55 : [index] {'réponse': {'result': {'marié': 'oui', 'enfants': 3, 'salaire': 200000, 'impôt': 42842, 'surcôte': 17283, 'taux': 0.41, 'décôte': 0, 'réduction': 0}}}
2020-07-27 16:32:08.002824, Thread-56 : [index] {'réponse': {'result': {'marié': 'non', 'enfants': 2, 'salaire': 100000, 'impôt': 19884, 'surcôte': 4480, 'taux': 0.41, 'décôte': 0, 'réduction': 0}}}
  • o registador continua a gravar o dicionário da resposta e não a cadeia XML que é enviada ao cliente. Não se trata de um erro e é intencional;

27.2.2. Teste da camada [dao] do cliente

Image

A classe de teste [TestHttpClientDao] é a mesma que na |versão 7| e apresenta os mesmos resultados.

https://stahe.github.io
Este tutorial, escrito por Serge Tahé, é disponibilizado ao público sob os termos da Creative Commons Atribuição – Não comercial – Partilha igual 3.0 Unported.