Skip to content

27. Toepassingsopgave: versie 9

We keren terug naar versie 7 van de toepassingsopgave en in plaats van dat de client en de webserver jSON-strings uitwisselen, wisselen ze hier XML uit.

De architectuur blijft hetzelfde:

Image

27.1. De webserver

Image

De map [http-servers/04] wordt verkregen door de map [http-servers/02] te kopiëren, met uitzondering van de submap [utilities]. Vervolgens worden de volgende elementen gewijzigd:

Image

Het bestand [config] wordt als volgt gewijzigd:


    # absolute afhankelijkheden
    absolute_dependencies = [
        # projectmappen
        # 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",
        # Constanten, segmenten
        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",
    ]
  • regel 21: de map met hulpprogramma’s die in [http-servers/02] zijn achtergebleven, wordt opgegeven;

Het hoofdscript [main] wordt als volgt aangepast:


# Home URL
@app.route('/', methods=['GET'])
@auth.login_required
def index():
    logger = None
    try:
        # logger
        logger = Logger(config["logsFilename"])
        # wordt opgeslagen in een configuratie die aan de thread is gekoppeld
        thread_config = {"logger": logger}
        thread_name = threading.current_thread().name
        config[thread_name] = {"config": thread_config}
        # het verzoek wordt gelogd
        logger.write(f"[index] requête : {request}\n")
        …
        # de aanvraag wordt door een controller uitgevoerd
        résultat, status_code = index_controller.execute(request, config)
        # is er een fatale fout opgetreden?
        …
        # het antwoord wordt gelogd
        logger.write(f"[index] {résultat}\n")
        # het antwoord wordt verzonden
        return xml_response(résultat, status_code)
    except BaseException as erreur:
        # de fout wordt gelogd indien mogelijk
        if logger:
            logger.write(f"[index] {erreur}")
        # het antwoord aan de klant wordt voorbereid
        résultat = {"réponse": {"erreurs": [f"{erreur}"]}}
        # het antwoord wordt verzonden
        return xml_response(résultat, status.HTTP_500_INTERNAL_SERVER_ERROR)
    finally:
        # het logbestand wordt gesloten als het geopend was
        if logger:
            logger.close()
  • de enige wijziging is op regel 23: er wordt nu een antwoord XML verzonden;

De functie [xml_response] wordt gedefinieerd in de module [myutils]:


import xmltodict
…
def xml_response(résultat: dict, status_code: int) -> tuple:
    # resultaat: het woordenboek dat moet worden omgezet in een tekenreeks XML
    xmlString = xmltodict.unparse(résultat)
    # het antwoord wordt teruggestuurd HTTP
    response = make_response(xmlString)
    response.headers['Content-Type'] = 'application/xml; charset=utf-8'
    return response, status_code
  • regel 3: de functie [xml_response] ontvangt als parameters:
    • het woordenboek [résultat] dat moet worden omgezet naar XML;
    • de statuscode [status_code] die naar de webclient moet worden teruggestuurd;
  • regel 5: de bibliotheek [xmltodict] wordt gebruikt om de tekenreeks XML te genereren;
  • regel 8: we gebruiken de header [Content-Type] om de client te laten weten dat we XML naar hem sturen;

De functie [xml_response] moet worden geïmporteerd in het script [__init__.py]:


from .myutils import set_syspath, json_response, decode_flask_session, xml_response

Vervolgens moet de module [myutils] worden opgenomen in de modules op machine-niveau. Dit gebeurt in een terminal PyCharm met het commando [pip install .] (in de map packages).

27.2. De webclient

27.2.1. De code

Image

Het dossier [http-clients/04] is gekopieerd van de klant [http-clients/02]. Vervolgens passen we de klasse [ImpôtsDaoWithHttpClient] als volgt aan:


# imports

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):

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

    # ongebruikte methode
    def get_admindata(self) -> AdminData:
        pass

    # belastingberekening
    def calculate_tax(self, taxpayer: TaxPayer, admindata: AdminData = None):
        ….
        # statuscode van het antwoord HTTP
        status_code = response.status_code
        # het antwoord XML wordt in een woordenboek opgeslagen
        résultat = xmltodict.parse(response.text[39:])
        # fout als statuscode afwijkt van 200 OK
        ….
  • regel 30: het antwoord HTTP [response] van de webserver is nu een tekenreeks XML. De logbestanden tonen de aard ervan: 

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>

De tekenreeks [<?xml version="1.0" encoding="utf-8"?>] bestaat uit 38 tekens. Als we het logbestand bovendien met een hexadecimale editor bekijken, zien we dat er achter deze tekenreeks een regeleinde-teken \n staat. Daarna volgt het antwoord <antwoord>…</antwoord>. De tekenreeks XML die we moeten converteren, begint dus na de eerste 39 tekens van de tekenreeks XML. Deze begint bij teken nr. 39, waarbij het eerste teken nummer 0 heeft. Deze tekenreeks wordt verkregen door de uitdrukking [response.text[39:]].

Als we de client uitvoeren (volg de procedure uit de voorgaande voorbeelden), krijgen we in het bestand [résultats.json] dezelfde resultaten als in de vorige versies. De logbestanden zien er als volgt uit:


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]

Aan de serverzijde zijn de logbestanden als volgt:


2020-07-27 16:32:04.983020, Thread-46 : [index] requête : <Request 'http://127.0.0.1:5000/?getrouwd=ja&kinderen=2&salaris=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/?getrouwd=ja&kinderen=2&salaris=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}}}
  • de logger blijft het woordenboek van het antwoord schrijven en niet de tekenreeks XML die naar de client wordt verzonden. Dit is geen fout en is zo bedoeld;

27.2.2. Test van de [dao]-laag van de client

Image

De testklasse [TestHttpClientDao] is dezelfde als in |versie 7| en levert dezelfde resultaten op.

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 – Gelijk delen 3.0 ongewijzigd.