Cours service web rest full

Cours Service Web REST FULL.pdf

Télécharger PDF

Service Web (Partie 2)

Ce document explore les concepts fondamentaux et l'implémentation des services web RESTful, en se concentrant sur les spécifications JAX-RS et l'utilisation de JSON pour l'échange de données.

Qu'est-ce qu'un Service Web RESTful ?

Un service web RESTful (Representational State Transfer) est une architecture logicielle pour les systèmes hypermédia distribués. Il utilise les protocoles standard du web, principalement HTTP, pour la communication entre le client et le serveur. L'objectif est de fournir un moyen standardisé et sans état (stateless) pour la communication et la manipulation de ressources.

Principe d'un Service Web REST

Le principe fondamental de REST est de considérer toutes les données comme des ressources, identifiables par des URL uniques. Les clients interagissent avec ces ressources en utilisant un ensemble d'opérations bien définies (les verbes HTTP).

Les Règles de RESTful (Contraintes de l'architecture REST)

Règle 1 : L'identification des ressources par URL

Chaque ressource doit être identifiée de manière unique par une URL (Uniform Resource Locator). L'URL doit être claire, descriptive et hiérarchique pour faciliter la compréhension et l'utilisation.

Exemple de construction d'URL avec RESTful :

Pour obtenir tous les utilisateurs : /api/utilisateurs
Pour obtenir un utilisateur spécifique : /api/utilisateurs/{id}
Pour obtenir les commandes d'un utilisateur : /api/utilisateurs/{id}/commandes

Règle 2 : Utilisation des Verbes HTTP pour les Opérations

Les opérations sur les ressources sont effectuées en utilisant les verbes HTTP standards, chacun ayant une sémantique spécifique :

GET : Récupérer une ressource (lecture). Ne doit pas modifier l'état du serveur.
POST : Créer une nouvelle ressource.
PUT : Mettre à jour (remplacer) une ressource existante.
PATCH : Mettre à jour (modifier partiellement) une ressource existante.
DELETE : Supprimer une ressource.

Exemples :

GET /api/produits : Récupère la liste de tous les produits.
POST /api/produits : Crée un nouveau produit.
PUT /api/produits/{id} : Met à jour le produit avec l'identifiant {id}.
DELETE /api/produits/{id} : Supprime le produit avec l'identifiant {id}.

Règle 3 : Représentation des Ressources

Les réponses HTTP doivent représenter l'état de la ressource dans un format standard (comme JSON ou XML). Le client et le serveur doivent s'entendre sur le format d'échange. Le corps de la réponse contient les données de la ressource, tandis que les en-têtes HTTP fournissent des métadonnées.

Règle 4 : HATEOAS (Hypermedia As The Engine Of Application State)

Les réponses des services RESTful doivent inclure des liens (hyperliens) vers d'autres ressources pertinentes, permettant au client de naviguer dans l'API sans avoir une connaissance préalable de toutes les URL. Cela rend l'API plus découplée et évolutive.

Exemple : Une ressource utilisateur pourrait inclure un lien vers ses commandes.

Règle 5 : Gestion de l'Authentification et de l'Autorisation

Bien que REST soit sans état, l'authentification est essentielle pour sécuriser l'accès aux ressources. Un mécanisme courant implique l'utilisation de jetons (tokens).

Exemple d'utilisation d'un jeton d'authentification :

Demande d'authentification : Le client envoie ses identifiants (nom d'utilisateur, mot de passe) au service d'authentification.
Génération du jeton : Le service valide les identifiants et génère un jeton (par exemple, un JWT - JSON Web Token).
Accès aux ressources : Ce jeton est ensuite inclus dans les en-têtes de chaque requête subséquente (par exemple, Authorization: Bearer [jeton]) pour accéder aux ressources protégées. Le serveur valide le jeton pour authentifier et autoriser la requête.

Pour une sécurité accrue, un jeton peut être utilisé pour générer un hachage (hash) de la requête. Ce hachage est ensuite passé comme jeton additionnel pour valider l'intégrité et l'authentification de la requête spécifique.

L'Idée Générale d'un Service Web REST

L'idée sous-jacente des services web REST est de tirer parti des principes et des technologies du World Wide Web pour construire des API robustes, évolutives et faciles à utiliser. Ils permettent aux systèmes de communiquer de manière standardisée en manipulant des ressources via des opérations simples et compréhensibles.

Introduction à JAX-RS

JAX-RS : La Spécification

JAX-RS (Java API for RESTful Web Services) est une spécification Java qui fournit une API pour créer des services web RESTful. Elle définit un ensemble d'annotations Java et d'interfaces pour simplifier le développement d'applications web conformes au style architectural REST.

JAX-RS : Implémentations

JAX-RS est une spécification, ce qui signifie qu'il existe plusieurs implémentations concrètes que les développeurs peuvent utiliser. Les implémentations les plus populaires incluent Jersey (l'implémentation de référence), RESTEasy, et Apache CXF.

JAX-RS : Fonctionnement

JAX-RS utilise des annotations pour mapper les classes et les méthodes Java aux ressources URI et aux verbes HTTP. Par exemple, l'annotation @Path est utilisée pour définir le chemin URI d'une ressource, et @GET, @POST, @PUT, @DELETE sont utilisées pour mapper les méthodes aux verbes HTTP correspondants.

Le Format JSON pour l'Échange de Données

Qu'est-ce que JSON ?

JSON (JavaScript Object Notation – Notation d'Objets JavaScript) est un format léger d'échange de données. Il est devenu un standard de facto pour les services web RESTful en raison de sa simplicité et de sa lisibilité.

Caractéristiques de JSON :

Facile à lire et à écrire pour les humains.
Facilement analysable (parse) et générable par des machines.
Indépendant du langage de programmation.

Ces propriétés font de JSON un format d'échange de données idéal pour les API web.

JSON : Exemple

Un exemple simple de données JSON pourrait être :

{
    "nom": "Dupont",
    "prenom": "Jean",
    "age": 30,
    "estActif": true,
    "adresse": {
        "rue": "123 Rue de la Paix",
        "ville": "Paris"
    },
    "hobbies": ["lecture", "sport"]
}

Comparaison XML / JSON

Historiquement, XML était un format d'échange de données très utilisé. Cependant, JSON a gagné en popularité, notamment pour les services web RESTful, en raison de sa syntaxe plus concise et de sa meilleure intégration avec JavaScript.

XML :

<personne>
    <nom>Dupont</nom>
    <prenom>Jean</prenom>
    <age>30</age>
</personne>

JSON :

{
    "nom": "Dupont",
    "prenom": "Jean",
    "age": 30
}

Généralités sur JAX-RS

JAX-RS simplifie grandement la création de services web RESTful en Java en fournissant des annotations pour mapper les requêtes HTTP aux méthodes Java, gérer les types de médias (JSON, XML), et extraire les paramètres des requêtes (chemins, requêtes, en-têtes).

Développement d'un Service RESTful avec JAX-RS et NetBeans

Implémentation d'un Service RESTful avec JAX-RS dans NetBeans

NetBeans, comme d'autres IDE, facilite le développement de services web RESTful avec JAX-RS. Lors de l'ajout d'un service RESTful à un projet Java EE, NetBeans peut générer automatiquement la structure de base.

La Classe ApplicationConfig.java

Dans un projet JAX-RS, la classe ApplicationConfig.java (ou une classe similaire étendant javax.ws.rs.core.Application) est essentielle. Elle configure l'application JAX-RS, notamment en spécifiant les classes de ressources qui composent le service web.

Nommage des Classes de Ressources RESTful

La classe qui représente un service RESTful (une ressource) est généralement annotée avec @Path pour définir le chemin de base de la ressource. Le nom de la classe doit être explicite par rapport à la ressource qu'elle gère (par exemple, ProduitResource, UtilisateurService).

Structure d'une URL de Service RESTful

Une URL de service RESTful suit une structure logique pour identifier les ressources. Prenons l'exemple :

http://localhost:8080/BookTrainRest/webresources/trains/numTrain-{id}

http://localhost:8080 : L'adresse du serveur et le port.
/BookTrainRest : Le nom du projet ou du contexte de l'application web.
/webresources : Le chemin du servlet JAX-RS (souvent configuré dans web.xml ou via annotation).
/trains : Le chemin de base de la ressource "trains" défini par l'annotation @Path sur la classe de ressource.
/numTrain-{id} : Un sous-chemin qui peut inclure un paramètre de chemin (ici, {id}) pour identifier un train spécifique.

Comment Développer un Service Web RESTful avec JAX-RS ?

Le développement d'un service web RESTful avec JAX-RS implique généralement les étapes suivantes :

Création du projet : Démarrer un nouveau projet web (par exemple, Maven Web Project) dans un IDE comme NetBeans ou IntelliJ.
Ajout des dépendances JAX-RS : Inclure les bibliothèques JAX-RS (par exemple, Jersey) dans le fichier de configuration du projet (pom.xml pour Maven).
Création d'une classe de ressource : Définir une classe Java annotée avec @Path pour le chemin de base de la ressource.
Définition des méthodes d'opération : Ajouter des méthodes à cette classe, annotées avec @GET, @POST, @PUT, @DELETE pour les différentes opérations. Utiliser @PathParam, @QueryParam, @Consumes, @Produces pour gérer les entrées et sorties.
Configuration de l'application JAX-RS : Créer une classe qui étend javax.ws.rs.core.Application ou configurer le servlet JAX-RS dans web.xml.
Déploiement : Déployer l'application sur un serveur d'applications compatible Java EE (comme GlassFish, WildFly, Tomcat avec l'extension appropriée).

Foire Aux Questions (FAQ)

Qu'est-ce que la principale différence entre REST et SOAP ?

REST est un style architectural qui utilise des protocoles HTTP standards et se concentre sur les ressources et leur état, tandis que SOAP est un protocole basé sur XML avec un contrat de service strict et qui utilise généralement des enveloppes pour structurer les messages.

Pourquoi JSON est-il préféré à XML dans les services RESTful modernes ?

JSON est souvent préféré pour sa syntaxe plus légère et plus facile à lire et à écrire pour les humains et les machines, sa meilleure intégration avec JavaScript (très utilisé dans le développement web client) et sa concision par rapport à XML, ce qui réduit la taille des messages échangés.

Qu'est-ce que JAX-RS et quel est son rôle ?

JAX-RS (Java API for RESTful Web Services) est une spécification Java qui fournit un cadre pour le développement de services web RESTful. Son rôle est de simplifier ce développement en utilisant des annotations pour mapper les requêtes HTTP aux méthodes Java, rendant le code plus clair et plus facile à maintenir.