Informatique Repartie

Transcription

1 Informatique Repartie Chapitre 4 : Web Services SOAP Cecilia Zanni Merk cecilia.zanni merk@insa rouen.fr Bureau BO B R1 04 Basé sur le cours de M Alexandre Pauchet, INSA Rouen Normandie, 2016

2 Références Le cours de M Pauchet sur Moodle Architectures réparties en Java de Annick Fron ISBN Ed Dunod 2

3 Références et cours sur le Web

4 Motivation Communication entre applications sur Internet Enjeux du «B to B» : effectuer des transactions ou des échanges de données entre entreprises (business to business) Faire communiquer de gros ensembles en couplage lâche, avec le minimum de connaissance sur l interlocuteur et sans pouvoir imposer aucune contrainte de service 4

5 Définition (du W3C) «Un service Web est un composant logiciel identifié par une URI, dont les interfaces publiques sont définies et appelées en XML. Sa définition peut être découverte par d'autres systèmes logiciels. Les services Web peuvent interagir entre eux d'une manière prescrite par leurs définitions, en utilisant des messages XML portés par les protocoles Internet» 5

6 Présentation Les services web sont des applications utilisant Internet pour interagir dynamiquement avec d autres programmes en s appuyant sur des standards issus le plus souvent du W3C XML (Extensible markup Language) pour le formatage des données (syntaxe) HTTP (Hypertext Transfer Protocol) pour le protocole de transport SOAP (Simple Object Access Protocol) pour le protocole de communication 6

7 Présentation Les services web sont des applications utilisant Internet pour interagir dynamiquement avec d autres programmes en s appuyant sur des standards issus le plus souvent du W3C XML (Extensible markup Language) pour le formatage des données (syntaxe) HTTP (Hypertext Transfer Protocol) pour le protocole de transport SOAP (Simple Object Access Protocol) pour le protocole de communication SOAP est un protocole de type RPC qui utilise XML pour sérialiser les méthodes t leurs arguments, ainsi que les valeurs de retour. Avec SOAP, XML transite au dessus de HTTP 6

8 Cours Intro aux Réseaux Olivier Dalle Université de Nice 7

9 Présentation Les interfaces des services web sont décrites en WSDL (Web Services Description language). Cette description est suffisante pour utiliser le service sans connaître son implémentation Le but est de permettre à une application de communiquer sur Internet avec le service dont elle a besoin et d échanger des données avec lui L infrastructure de mise en œuvre est plus lourde que pour RMI (il faut un serveur web); mais incontournable si on souhaite faire transiter des informations à travers un pare feu 8

10 Qualité de service Gestion des aspects non fonctionnels transversaux aux différents systèmes La gestion des transactions La gestion de la sécurité Les annuaires Les spécifications récentes de SOAP permettent une interopérabilité de la qualité de service, en ce qui concerne les transactions et la sécurité : D) 9

11 Standardisation des services Web Plusieurs normes W3C Le consortium OASIS ( open.org) Nombreux acteurs Microsoft.Net Apache : Axis, CXF Sun : JAX WS et Metro JBoss/WildFly Autres implémentations open source Interopérabilité Services des uns utilisables par les autres WS I.org : Web Service Interoperability organization ( i.org) 10

12 Trois composants fondamentaux de SOAP Invocation distante des services web : SOAP Protocole qui se présente comme une enveloppe pouvant être signée et pouvant contenir des données ou des pièces jointes. Permet d'effectuer des appels de méthodes à distance. Description des services web : WSDL Décrit de façon précise les protocoles, les ports utilisés, les opérations pouvant être effectuées, les formats des messages d'entrée et de sortie et les exceptions pouvant être envoyées. Enregistrement et découverte de services web : UDDI (Universal Description, Discovery and Integration) Fournit l'infrastructure de base pour la publication et la découverte des services Web. 11

13 Cours SOA Services Web Etendus Mickael Baron LIAS (Poitiers) 12

14 Versatilité de SOAP Protocole polyvalent Nouvel outil RPC entre objets : les appels de méthodes et leurs arguments sont sérialisés en XML Protocole d envoi de messages : une requête comporte un seul message, une réponse un seul message Protocole d échange de documents XML, utile à l EDI (échange de données informatisés ou Electronic Data Interchange) 13

15 Un message SOAP Les messages SOAP sont utilisés pour envoyer (requête) et recevoir (réponse) des informations d un récepteur Un message SOAP peut être transmis à plusieurs récepteurs intermédiaires avant d être reçu par le récepteur final Le format SOAP peut contenir des messages spécifiques correspondant à des erreurs identifiées par le récepteur Un message SOAP est véhiculé vers le récepteur en utilisant un protocole de transport (HTTP, SMTP, ) 14

16 Organisation d un message SOAP 15

17 Organisation d un message SOAP Protocole de transport 15

18 Organisation d un message SOAP Protocole de transport Définit le document XML comme un message SOAP 15

19 Organisation d un message SOAP Protocole de transport Définit le document XML comme un message SOAP Optionnelle : stockage des informations spécifiques à la transaction 15

20 Organisation d un message SOAP Protocole de transport Définit le document XML comme un message SOAP Optionnelle : stockage des informations spécifiques à la transaction Contient des donnés à transporter. Peut inclure du code pour la gestion des erreurs 15

21 L enveloppe SOAP Un message SOAP est un document XML constitué d une enveloppe composée de deux parties Un en tête (header) qui peut être facultatif Un corps (body) 16

22 L enveloppe SOAP Toutes les balises XML associées à SOAP ont le préfixe soap ou soap env 17

23 Le corps SOAP L objectif visé par SOAP a été de fournir un mécanisme standardisé pour l appel de procédures distant (RPC) De ce fait les informations adressées au destinataire de messages SOAP doivent respecter un certain nombre de conventions Appel d une opération représentée par une structure Le nom de la structure est celui de l opération à appeler Chaque paramètre de l opération est défini comme un sous élément de la structure Si un paramètre est un type complexe (Personne par exemple) une nouvelle structure est définie contenant à son tour des sous éléments Le résultat est également représenté par une structure Le nom de la structure est celui de l opération suivi de Response Les paramètres sont également structurés 18

24 Le corps SOAP 19

25 Le corps SOAP Message SOAP pour la réponse, puisque le nom de l opération est suivi de Response Les paramètres de sortie suivent la même convention que les paramètres d entrée 19

26 L entête SOAP Utilisée pour transmettre des informations supplémentaires sur ce même message L élément peut être facultatif Doit être placé avant le corps Différents usages de l en tête Informations authentifiant l émetteur Contexte d une transaction Pour certains protocole de transport (FTP par exemple), l en tête peut être utilisé pour identifier l émetteur du message Un message SOAP peut transiter par plusieurs intermédiaires avant le traitement par le récepteur final Des attributs spécifiques à l entête SOAP peuvent être utilisés 20

27 21

28 Gestion des erreurs Balise <soap:fault> contenu dans le corps. L élément d erreur est facultatif et n apparaît que dans les messages de réponse, qu une seule fois Quatre sous balises facultatives faultcode faultstring faultactor detail Quatre types de code d erreur soap:server soap:client soap:versionmismatch soap:mustunderstand 22

29 23

30 Exemple de requête sur HTTP 24

31 Exemple de réponse sur HTTP 25

32 Le langage de description WSDL 26

33 Introduction Un document WSDL, au format XML, décrit Ce qui fait le service Où le trouver (nommage) Comment l invoquer Décrit l interface ET une partie de l implémentation!!! Mais rien sur sa sémantique (ce qu'il fait) En général, généré par un outil de développement 27

34 Structure d un document WSDL 28

35 Structure d un document WSDL Types : contient les définitions de types utilisant un système de typage donné (comme XSD) Message : décrit les noms et types d'un ensemble de champs à transmettre (paramètres d'invocation, valeur du retour, etc.) PortType/Interface : décrit un ensemble d'opérations. Chaque opération a 0 ou 1 message en entrée, 0 ou plusieurs messages en sortie Binding : spécifie une liaison d'un <porttype> à un protocole concret (SOAP1.1, etc.). Un <porttype> peut avoir plusieurs liaisons! Port/Endpoint : spécifie un point d'entrée comme la combinaison d'un <binding> et d'une adresse réseau Service : une collection de points d'entrée (endpoint) relatifs Opération : c'est la description d'une action exposée dans le port. 29

36 Structure d un document WSDL Types : contient les définitions de types utilisant un système de typage donné (comme XSD) Message : décrit les noms et types d'un ensemble Description de champs WSDL à transmettre (paramètres d'invocation, valeur du retour, etc.) PortType/Interface : décrit un ensemble d'opérations. Chaque opération a 0 ou 1 message en entrée, 0 ou plusieurs Des types messages sont utilisés en sortiepour définir Binding : spécifie une liaison d'un <porttype> des opérations à un protocole dans concret des (SOAP1.1, etc.). Un <porttype> peut porttypes/interfaces, avoir plusieurs liaisons! reliés à un Port/Endpoint : spécifie un point d'entrée comme la combinaison d'un <binding> et d'une adresse réseauport/endpoint par des bindings. Service : une collection de points d'entrée (endpoint) relatifs Opération : c'est la description d'une action exposée dans le port. 29

37 Exemple de fichier WSDL 30

38 Exemple de fichier WSDL 31

39 Plusieurs styles WSDL Un binding WSDL peut avoir plusieurs styles : RPC ou document (la sémantique n est pas très bien trouvée) Le passage des informations peut être codé (encoded) ou littéral (literal) Quatre méthodes de communication RPC/encoded RPC/literal Document/encoded Document/literal Ces méthodes sont spécifiées dans le WSDL dans l attribut type du binding ainsi que dans l attribute style de soap:binding 32

40 Mise en pratique du côté client 33

41 Test d un service Web existant 34

42 Test d un service Web existant 34

43 Test d un service Web existant Explorer les services fournis Explorer les EndPoints Tester et analyser les requêtes et les réponses 35

47 Un premier client en PHP 36

48 Un premier client en PHP 36

49 Un premier client en Java Deux étapes pour le développement d un client Java pour un WS génération de classes nécessaires au client codage du client en soi La génération des classes se fait avec l outil wsimport wsimport keep 37

50 Un premier client en Java Deux étapes pour le développement d un client Java pour un WS génération de classes nécessaires au client codage du client en soi La génération des classes se fait avec l outil wsimport wsimport keep 37

51 38

52 38

53 A la main, c est compliqué Heureusement, il y a des outils comme SpyXML (malheureusement payant) 39

58 Planning détaillé 25/1: CM + CM (présentation + client/serveur + conception) 1/2: CM + CM (RPC + Sockets + sujets projets) 8/2: CM (RMI) (QCM Sockets )+ TD (sockets) (Livrable : groupes projet + affectation de sujets / groupe) VACANCES FEVRIER 1/3: CM (RMI) + Projet (conception) (livrable AVANT la séance : spec projet) 8/3: CM (web services) (QCM RMI) + TD (RMI) 15/3: CM (web services) + Projet (implémentation) (livrable AVANT la séance : conception projet) 22/3: CM (REST) (QCM Web Services) + TD (web services) 29/3: CM (REST) + Projet (implémentation) 5/4: CM (EJB) (QCM REST) + TD (REST) VACANCES AVRIL 26/4: CM (EJB) + Projet 3/5: (QCM EJB) TD (EJB) + Projet 10/5: Projet (soutenances) + Projet (soutenances)

59 Mise en pratique du côté serveur 41

60 Première approche avec des annotations Intégrées au JDK 1.5, les annotations permettent d'ajouter des Métainformations au code (i.e. marquer des éléments Java afin de leur ajouter une propriété) Peuvent être utilisées sur n'importe quel type d élément Java (package, class, attribut, méthode, paramètre, etc.) Plusieurs annotations peuvent être utilisées sur un même élément Non prises en compte par la JVM (mais présentes dans le.class) : il faut écrire du code ou des outils qui utilisent ces informations 42

61 Première approche avec des annotations Utilisation suivi du mot clé correspondant à l'annotation L'API Java 5.0 propose de base 3 Déclaration et création de nouvelles annotations : comme une interface en utilisant le mot (java.lang.annotation.annotation) Possibilité de passer des informations éà une annotation : nom=valeur 43

62 Démarche API pour lesannotations Web services @OneWay Java 6 met à disposition un mini serveur web avec la classe Endpoint.publish() Notion de POJO Plain Old Java Object. Objet "Java classique", sans contrainte d'implémentation d'interface ou d'héritage 44

63 Serveur (como un POJO) 45

64 Serveur (como un POJO) 45

65 Serveur (como un POJO) ATTENTION : la méthode s appelle indexcorporel en interne mais elle est publiée comme index (@WebMethod) 45

66 Publication du service 46

67 Le WSDL 47

68 Le WSDL 47

69 Le WSDL 47

70 Changement du style du Binding Si on remplace dans la définition du service web la ligne = SOAPBinding.Style.RPC)) = SOAPBinding.Style.DOCUMENT), le WSDL change 48

71 Changement du style du Binding Si on remplace dans la définition du service web la ligne = SOAPBinding.Style.RPC)) = SOAPBinding.Style.DOCUMENT), le WSDL change 48

72 Le client Doit importer les classes générées à partir du serveur. wsimport d client keep p demo Les classes générées à la volée seront dans le package demo demo.imc demo.mywebservicesservice.java 49

73 50

74 51

75 Le code du client et le résultat 52

78 Analyse des paquets nécessaires L API JAX-WS permet au développeur d effectuer des tâches de haut niveau sur les services web. En arrière plan JAX WS utilise l API de bas niveau SAAJ L API SAAJ permettra au développeur d effectuer des taches bas niveau sur les services web (manipuler l en tête, enveloppe...). javax.jws et javax.jws.soap fournissent les annotations (métadonnées) permettant, à haut niveau de créer et utiliser les web services. Une occasion pour le développeur de masquer la complexité inhérente aux web services. 53

79 Analyse de la démarche du développement 2 approches s opposent : l approche bottom up (à partir du code source Java de l interface du service web) et l approche top down (à partir de l interface WSDL du service web). Nous avons mis en oeuvre l approche bottom up : Création de l interface java du service (optionnel) Création de l implémentation du service (obligatoire) Publication du service web (obligatoire) 54

80 Quelques remarques Notre web service était simple : renvoi d une chaîne et de deux réels. Comment gérer un service web qui doit gérer et retourner des types Objets? Comment coder le client du service web? 55

81 Démarche complète de développement Le développement d'un service web avec JAX WS requiert plusieurs étapes : Coder la classe qui encapsule le service compiler la classe utiliser la commande wsgen pour générer les fichiers requis pour le déploiement (schémas, WSDL, classes,...) Éventuellement packager le service dans un fichier.war et déployer le war dans un conteneur voir cours M Pauchet 56

82 Démarche complète de développement Le développement d'un service web avec JAX WS requiert plusieurs étapes : Coder la classe qui encapsule le service compiler la classe utiliser la commande wsgen pour générer les fichiers requis pour le déploiement (schémas, WSDL, classes,...) Éventuellement packager le service dans un fichier.war et déployer le war dans un conteneur voir cours M Pauchet Pour définir un endpoint avec JAX WS, il a plusieurs contraintes : la classe qui encapsule le endpoint doit être public, non static, non final, non abstract et être annotée elle doit avoir un constructeur par défaut (sans paramètre) il est recommandé de définir explicitement l'interface du SEI (service endpoint interface) les méthodes exposées par le service web doivent être public, non static, non final et être annotées les types des paramètres et de la valeur de retour de ces méthodes doivent être supportés par JAXB 56

83 Un exemple plus complexe 57

86 Démarche pour le serveur Compilation classique javac -d. *.java Utilisation de l outil wsgen pour pour générer les classes et fichiers requis pour l'exécution du service web wsgen cp. team.teams Publication du service (à partir du dossier père) java team.teamspublisher 58

89 Démarche pour le client Il faut générer le code client wsimport -p teamsclient -keep Ecrire le code du client 59

90 Démarche pour le client Il faut générer le code client wsimport -p teamsclient -keep Ecrire le code du client 59

91 Outil à tester : SOAP UI SOAP UI est un outil graphique de test de Services Web Disponible en standalone ou intégré dans les environnements de développement (type Eclipse) Peut s utiliser sur n importe quelle plateforme de développement Fonctionnalités de SOAP UI Supporte les Services Web étendus (WSDL + SOAP + UDDI) ou REST Inspecter des Services Web Invoquer des Services Web Développer des Services Web Simuler des Services Web Effectuer des tests qualités (temps de réponse,...) 60

92 Inspection de WS Nous pouvons créer un nouveau projet SoapUI pour le tester. Cela est fait par la saisie de l URL du fichier wsdl Une fois le projet créé, la fenêtre principal nous donne plusieurs possibilités Les endpoints Le fichier wsdl Des tests de conformité WS I 61

96 Inspection de WS 62

100 Un mot pour finir Une des difficultés de SOAP n est pas d implémenter le code, mais de choisir une des multiples façons de le faire. Il existe plusieurs implémentations de SOAP en Java Oracle depuis Java 6 a la sienne propre avec JAX WS, que nous venons d explorer Axis ( dans el monde Apache; et sa nouvelle version 2 qui n impose pas strictement le modèle de données CXF ( une alternative à Axis2 sur Apache 63