Les Web-Services

Outils

Easyphp ou Apache seul.

Ce TP a été créé avec WinDev 9, l'adaptation une autre version est mineure, c'est plus souvent un problème de localisation des menus.e.

Le but de cet exercice est de vous faire pénétrer dans le monde merveilleux et surtout à la mode des Web-Services. En effet l'heure actuelle est à répartition des charges et des serveurs, c'est dans ce contexte qu'interviennent les Web-Services. Mais d'abord quelques définitions.

Dans ce chapitre, nous allons vous présenter les WebServices : c'est-à-dire pourquoi les WebServices ont été créés et à quelle demande répond cette nouvelle technologie.

Nous verrons ensuite le fonctionnement d'un WebService.

II-A. Présentation▲

II-B. Fonctionnement des WebServices▲

II-C. Pourquoi les WebServices ?▲

Comment faire communiquer des programmes tournant sur des machines distantes, des OS différents, développés par des compagnies différentes ? Comment dans ce cas de figure faire du remoting ? À moins d'utiliser des nombreux ponts qui existent, c'est quasi impossible. Bien évidemment, des ébauches de solutions ont été apportées et ont fait leur preuve (CORBA, COM, DCOM…)

Les WebServices sont eux universels et de plus le HTTP passe sans peine par un firewall…

L'utilisation d'un WebService peut se diviser en différentes étapes :

• on demande au WebService son contrat WSDL (Web Service Description Language) : c'est un document formalisé (XML, W3C) qui spécifie quelles sont les méthodes pouvant être appelées sur ce WebService ;
• il le retourne, et on mémorise comment il marche (méthodes, format des appels, paramètres, valeurs retournées, etc.). Pour cela, on crée ce que l'on appelle en Java un classe stubs (souche). En C# et sous .NET, le terme consacré est classe proxy : généré par l'outil wsdl.exe, c'est une classe qui présente les mêmes méthodes que le WebService, et qui permet de les appeler de manière synchrone ou asynchrone ;
• à l'utilisation : on appelle la méthode (SOAP+XML) désirée conformément au format précédemment acquis. Et ceci, tout simplement en instanciant et en utilisant ses méthodes. C'est transparent ;
• on récupère le résultat de la méthode, ou une erreur. Je vous souhaite le résultat, mais une erreur sera levée si le schéma WSDL du WebService a changé !

Les étapes de l'utilisation d'un WebService

Les WebServices passant (sauf si vous en décidez autrement) par HTTP peuvent utiliser d'autres protocoles que SOAP pour transporter des données. Mais ceci implique des restrictions, énoncées ci-dessous :

Quoi	POST	GET	SOAP
Transporter des types primitifs (Integer, Long, String…)
Transporter des énumérations
Transporter des tableaux
Objets
Structures
DataSets, fichiers XML, tableau de n'importe quoi
Passage par référence

N.B. GET et POST sont les méthodes de passage de valeurs propres à HTTP.

III-A. Présentation▲

III-B. Les autres protocoles…▲

III-C. CORBA ▲

III-D. RMI▲

La présentation étant faite passons à l'action !

Pour pouvoir tester le WebService sur votre machine de développement, il va vous falloir un serveur Web en fonctionnement. Je vous propose de travailler avec Apache. Le plus simple est d'installer Easyphp. Une fois celui-ci installé sur votre poste vous devrez le configurer pour qu'il reconnaisse les Webservices WinDev. Suivez les étapes suivantes (tirées de l'aide en ligne de WinDev rubrique SOAP).

1. Ouvrez le fichier « httpd.conf » dans le bloc-notes Windows. Ce fichier est présent dans le sous-répertoire conf de votre installation Apache.

2. Recherchez la section concernant le support des objets partagés. Pour cela, recherchez :

• soit la ligne suivante : « # Dynamic Shared Object (DSO) Support » ;
• soit le mot clé « LoadModule ».

3. Ajoutez la ligne :

LoadModule windev_module <Répertoire d'installation de WinDev 9>\Donnees\WD90sapa.dll

(N.B. Les utilisateurs de Windev8/7 modifieront en conséquence.)

4. Recherchez la section concernant les « handlers » de requêtes. Pour cela, recherchez :

• soit la ligne « # AddHandler allows you to map certain file extensions to »handlers" ;
• soit le mot clé « AddHandler ».

Ajoutez la ligne suivante :

AddHandler windev-module .soap

5. Recherchez la ligne

« WHENEVER YOU CHANGE THE LOADMODULE SECTION ABOVE, UPDATE THIS TOO! »

et saisissez le caractère # devant le mot ClearModuleList.

Ces deux dernières opérations ne pourront ce faire qu'à la fin de l'exercice. Pensez-y avant de crier que le webservice ne fonctionne pas !

6. Recherchez dans le fichier « httpd.conf » la section concernant le répertoire par défaut des fichiers. Pour cela, recherchez le mot clé « documentroot ».

Copiez dans le répertoire indiqué après le mot clé « documentroot » les fichiers suivants :

• le fichier XML contenant la description du service Web XML ;
• de votre application serveur ou du service WEB XML (fichier *.WDL) ;
• l'application WDSOAPConfig.EXE présente dans le répertoire « Données » du répertoire d'installation de WinDev 9 ;
• les DLL WinDev nécessaires à l'exécution de votre application. Vérifiez que les DLL suivantes sont sélectionnées : WD90IMG.DLL, WD90OBJ.DLL, WD90STD.DLL, et WD90VM.DLL ;
• les DLL WinDev spécifiques au serveur HTTP utilisé : WD90SAPA.DLL pour Apache.

N. B. Pour WinDev 8, recherchez les fichiers WD80IMG.DLL, WD80OBJ.DLL…

7. Lancez l'administrateur SOAP (application WDSOAPConfig.EXE). Cet administrateur est présent dans le répertoire d'installation de votre application (ou dans un répertoire spécifique s'il est déjà installé).

Paramétrez les différents éléments

Temps avant de décharger une WDL inutilisée

Si plusieurs bibliothèques (fichier WDL) correspondant à des applications SOAP serveur (ou à des services Web XML) sont présentes sur le poste, cette option permet de configurer le temps maximal d'attente avant de supprimer de la mémoire une bibliothèque inutilisée. Lors de cette suppression, le code de fin de projet sera exécuté.

Nombre maximum de WDL en mémoire

Si plusieurs bibliothèques (fichier WDL) correspondant à des applications SOAP serveur (ou à des services Web XML) sont présentes sur le poste, cette option permet de configurer le nombre de WDL chargées simultanément en mémoire. Lorsque ce nombre est atteint, la bibliothèque la plus ancienne est automatiquement fermée. Lors de cette fermeture, le code de fin de projet sera exécuté.

Enregistrer un journal (.LOG)

Cette option permet d'enregistrer dans un fichier texte toutes les opérations réalisées sur le serveur SOAP. Pour chaque opération, la date et l'heure sont indiquées. Ce fichier peut par exemple contenir les messages suivants :

Chargement de a

Réception d'une requête : appel de a

L'appel à a échoué

L'appel à a réussi

On atteint la limite de WDL en mémoire

Déchargement de

Fichier journal

Répertoire du serveur dans lequel le fichier journal doit être créé.

Localisation des WDL

Répertoire du serveur où sont présentes les bibliothèques des applications Serveur SOAP. Remarque : si le répertoire n'existe pas, les WDL seront recherchées dans le répertoire C:\modulessoap.

Localisation des DLL WinDev

Répertoire du serveur où sont présentes les DLL WinDev utilisées par les applications Serveur SOAP. Remarque : si le répertoire n'existe pas, les DLL seront recherchées dans le répertoire C:\modulessoap.

Localisation des fichiers en exécution

Répertoire des fichiers Hyper File. Lors du chargement de la bibliothèque du serveur SOAP :

- l'analyse associée au serveur SOAP sera automatiquement chargée ;

- le répertoire des données spécifié dans l'analyse correspondra automatiquement à ce répertoire.

De l'action

Bon, on y va ?

OK, c'est parti !

Créez un nouveau projet : TpWebService. Ce projet ne contiendra aucune analyse ni aucune fenêtre. Un Webservice étant comparable à une collection de procédures les fenêtres ne sont d'aucune utilité.

Comme je viens de vous le dire, un WebService est un ensemble de procédures ou de classes. Dans cet exercice nous allons utiliser les procédures globales. Créez-en une nommée « Répondre »

Le code est le suivant :

RENVOYER "coucou"

Comme vous le voyez : on se fatigue ! En fait pour ce premier exercice on se contente d'illustrer les principes donc je vous prie de m'excuser pour la faiblesse de l'illustration !!! Vous ferez mieux plus tard ;-)))

Vous venez de le comprendre que lorsqu'un client consommateur appellera la méthode « Répondre » du WebService il aura une chaîne de caractère « Coucou » comme réponse. C'est puissant, non ?!!!

Bon, si je vous disais que le WebService est fini, vous le croiriez ? Et pourtant c'est vrai !. Ah non, il reste à le déployer, on va le faire tout de suite.

Pour Windev 9

Allez dans le menu Atelier puis Service Web XML ( SOAP, .net, J2EE) puis Générer un service Web à partir de ce projet.

L'écran suivant lance l'assistant :

Remplissez les deux champs et cliquez sur suivant :

Cliquez sur suivant.

Ça deviendrait presque lassant ! Cliquez encore sur suivant.

Et voilà ! C'est fini. Le webservice est terminé. Mais pas son installation finale. Revenez aux points 6 et 7 Page 4.

Une fois les fichiers copiés dans le bon dossier apache, vous devriez obtenir ceci :

Lors de votre configuration dans le fichier «Httpd.Conf » apache, vous avez indiqué à Apache comment se comporter pour exécuter un WebService SOAP Windev (cf. : loadmodule).

Nous retrouvons donc les librairies (.dll ) spécifiques WinDev pour exécuter dans un contexte client/serveur les méthodes contenues dans tpwebservice.wdl.

Le fichier tpwebservice.xml est un fichier structuré contenant la description du WebService. Éditez-le avec un éditeur de texte et vous allez en comprendre le but.

Fermez le projet du WebService.

Maintenant, le morceau de bravoure : le client ou consommateur du WebService.

Nous allons créer le client.

Fichier ->Nouveau ->Projet.

Vous nommerez ce projet TpclientSoap. Il n'utilisera pas d'analyse.

Nous allons maintenant intégrer la définition du service Web à l'intérieur de ce projet, pour cela :

L'assistant d'importation se lance par la fenêtre suivante :

Imaginiez que le service Web est sur un serveur localisé sur Internet ? Et bien c'est ici que vous localiseriez sa description. Nous allons indiquer ici le lieu où est stocké notre service.

Les renseignements donnés, on clique sur suivant

Ce n’est pas qu'on ne sache pas, mais en fait c'est du SOAP générique que l'on a fait donc.

Aller, hop, un petit coup sur suivant ! C'est lassant je vous dis !

Vous avez le choix, soit vous vous la pétez à être moderne et vous choisissez la classe, soit vous êtes plutôt rétro et vous prenez les procédures. Perso, vu mon grand âge c'est procédures, un potage et au lit !

Vous avez deviné ? un ch'ti suivant !

Logiquement vous n'avez qu'à valider en cliquant sur terminer. C'est super les assistants, seulement gardez à l'esprit ce qu'ils viennent de nous faire réaliser et vous vous rendrez compte d'un sacré coup de main.

Un petit coup d'œil en bas de l'éditeur vous permettra de découvrir l'intégration de la méthode ( dans le cas où vous avez choisi d'intégrer le WebService en tant que collection de procédures, sinon cherchez dans les classes)

Maintenant nous allons donner vie à tout ça. Pour commencer, créez une nouvelle fenêtre nommée départ qui sera la première fenêtre du projet. Elle va ressembler à ceci :

Ben, oui c'est tout !

Voici le code du bouton :

Info(repondre)

Explications : vous vous rappelez que la procédure « repondre » du WebService n'effectue qu'un renvoi d'une chaîne texte contenant « coucou ». Donc logiquement en cliquant sur le bouton de la fenêtre nous devrions avoir une fenêtre d'information contenant la chaîne « coucou ».

Il n'y a qu'à essayer.

Lancez l'exécution du projet ou de la fenêtre, cliquez sur « Bouton » et si « coucou » apparaît vous pouvez prendre une pause, sinon.refaites l'exercice.

Maintenant allons visiter la plomberie, ouvrez le code de la procédure repondre, vous devez avoir ceci

PROCEDURE repondre()
bRes est un booléen

bRes=SOAPExécute("http://localhost/service.soap", "repondre", "tpwebservice", "tpwebservice/repondre")

SI PAS bRes ALORS
    SI SOAPErreur(SOAPErrMessage)~="" ALORS
        Erreur(ErreurInfo())
    SINON
        Erreur(SOAPErreur(SOAPErrMessage))
    FIN
FIN

RENVOYER SOAPDonneRésultat(SOAPRésultat)

bRes=SOAPExécute("http://localhost/service.soap", "repondre", "tpwebservice", "tpwebservice/repondre")

Cette ligne se charge de faire exécuter la procédure sur le serveur SOAP et renvoie le résultat dans une variable booléenne (Vrai si la communication avec le serveur SOAP a été établie, Faux dans le cas contraire).

SI PAS bRes ALORS

Tournure élégante pour dire si ce n’est pas vrai alors traitement de l'erreur.

RENVOYER SOAPDonneRésultat(SOAPRésultat)

La procédure a fonctionné, on retourne le résultat.