Web services REST

De $1

Version de 20:27, 22 Sep 2019

cette version.

Revenir à liste des archives.

Voir la version actuelle

Cours

Travaux pratiques

Etude et compréhension d'un web service RESTFUL en JEE6 : un serveur de bookmarks semblable à celui de delicious.com

Dans ce TP vous allez étudier un projet complet de web service REST, vous l'ouvrirez avec Eclipse, l'exécuterez, puis vous essaierez de comprendre sa conception. Ce projet a quelques particularités intéressantes...

Récupérer l'archive suivante et la décompresser dans votre workspace Eclipse

Il est recommandé d'être en JDK 1.6 et Eclipse Ganymède ou Galliléo, si vous avez un vieux JDK ou un Eclipse ancestral, on ne peut rien pour vous ;-)

Utilisation d'un serveur web embarqué dans l'application

Le projet utilise un serveur web (un container web dans le jargon) embarqué dans l'application. nul besoin de Tomcat, Glassfish, Jetty, JBoss ou autre serveur à installer ! Ce container web s'appelle Grizzly et on le retrouve comme "plugin" du serveur Glassfish v3 de Sun. Regardez en particulier le code de la classe bmserv/Server.java

// definition de l'URL de base du serveur et du port a ecouter
final String baseUri = "http://localhost:9998/";

// renseigne Grizzly sur l'emplacement des classes a deployer
final Map<String, String> initParams = new HashMap<String, String>();
initParams.put("com.sun.jersey.config.property.packages", "bmserv.resources"); 
		
try {
    // Création du serveur embarqué
    // On deploie les ressource a baseURI, indique où sont les ressources (initParams)
    // et on retourne un SelectorThread, qui permettra d'enregistrer des listeners pour
    // afficher l'état du serveur
    SelectorThread threadSelector = GrizzlyWebContainerFactory.create(baseUri, initParams);

   ServerStateListener ssl = new ServerStateListener(); // Creation d'un listener pour suivre l'etat du serveur
   threadSelector.getController().addStateListener(ssl); // Enregistrement du listener
   ...

Si vous regardez attentivement le main() qui se trouve dans Server.java et que vous suivez le fil du code, vous verrez qu'on associe aussi une console de commandes (un shell) au serveur, pour pouvoir l'arrêter, etc.

Lancez l'application et regardez ce qu'il se passe lorsque vous cliquez sur les différents liens de la page d'accueil

Faites run sur la classe Server.java, et dans firefox ouvrez l'url : http://localhost:9998 cliquez sur les différents URLs de la page qui s'affiche, remarquez les résultats.

Les modèles de données et leurs contrôleurs

Les modèles (package bmserv.model)

le projet consiste en un serveur de Bookmarks (favoris web). Un Bookmark est associé à un utilisateur, à son URI, il a une description etc... Voici le constructeur de la classe modele/Bookmarks.java

public Bookmark(final String title, final String urlstr, final String descr, final String authid) {
	this.title = title;
	this.urlstr = urlstr;
	this.authid = authid;
	this.description = descr;
	this.id = createBmId(authid, urlstr);
}

De même, on retrouve une classe pour décrire un utilisateur (User.java) et une classe pour décrire un Tag (un mot-clé). La classe la plus importante est la classe Tagging.java qui décrit l'association d'un User, d'un Bookmark et d'un Tag. On peut avoir plusieurs Taggings pour décrire un seul Bookmarks ou pour associer plusieurs Tags à un Bookmark.

Exemple (chaque ligne correspond à un tagging):

On se retrouve avec un modèle ressemblant à un modèle relationnel classique...

Etudiez donc les classes des modèles. Pour le moment, ignorez les annotations de code commençant par "@"...

Les contrôleurs (package bmserv.model.handlers)

A chaque modèle on va associer une "façade" proposant des fonctionnalités pour les manipuler : creer un tag, chercher un tag, lister tous les tags etc...

Exemple pour la création d'un Tagging :

public class TaggingHandler {
    ...
    private static List<Tagging> taggings = new ArrayList<Tagging>();
    ...

    public void createTagging(final String authorid, final String bmid, final String tagid){
	GregorianCalendar dateGreg = new GregorianCalendar();
	java.util.Date dateDate = dateGreg.getTime();		 

	DateFormat dateFormat = new SimpleDateFormat("yyyy-MM-ddTHH:mm:ss.SSSZ");
	String datestr = dateFormat.format(dateDate);
		 
	taggings.add(new Tagging(datestr, authorid, bmid, tagid));
        ...
    }
}

Etudiez donc les différents contrôleurs de manière à avoir une vue d'ensemble.

 La définition du service REST

Ca se passe dans le package bmserv. Le paradigme REST suppose qu'une donnée (un tag, un user, un bookmark, un bnookmarking) est une donnée qui doit avoir un URL unique. On peut aussi associer des URLs pour afficher un ensemble de données (équivalent des select sql). Par ailleurs, selon qu'on utilise ces URLs via du HTTP GET, POST, PUT ou DELETE, on va faire des recherches, des ajouts, des modifications ou de la suppression de ces données.

Pour associer des URls aux contrôleurs, regardez les classes du package bmserv.resources. Par exemple :

package bmserv.resources;
...

@Path("/bookmark")
public class BookmarkResource {
	@GET
	@Path("/id/{bmid}")
	@Produces("text/xml")
	public bmserv.model.Bookmark getBookmarkFromId(@PathParam("bmid") String bmid) {
		Bookmark bm = Server.bmh.getBookmarkFromId(bmid);
		return bm;
	}
	
	@GET
	@Path("/all")
	@Produces("text/xml")
	public bmserv.model.handlers.BookmarkHandler getAllBookmarks() {
		return Server.bmh;
	}
}

Remarquez l'utilisation des annotations de code pour définir les URIs associés aux méthodes qui seront appelées lorsqu'ils seront invoqués. Dans cet exemple les réponses seront toutes en XML mais on aurait pu tout aussi bien indiquer qu'on les renvoie aussi en Json...

La sérialisation / Désérialisation / Persistence des données en XML 

Les formats d'échange des web services REST sont XML ou JSon (objets sérialisés en Javascript, vous verrez ça lors de la prochaine séance). Dans ce projet, on a utilisé une API Java très pratique : JAXB, pour transformer automatiquement des objets en XML et vice versa, pour transformer un flux XML en Objet.

Pour indiquer comment on veut transformer en XML un objet, on ajoute des annotations de code aux modèles. Regardez à nouveau les modèles et remarquez les annotations@XmlElement, @XmlAttribute, etc

@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "taggings")
public class TaggingHandler {
	@XmlElement(name = "tagging", required=true)
	private static List<Tagging> taggings = new ArrayList<Tagging>();

Signifie que les taggings seront sérialisés entre <taggings> ... </taggings> et qu'entre ces deux balises, chaque élément sera un <tagging>...</tagging> au singulier. La manière dont les éléments seront transformés est spécifié dans les classes des modèles, par exemple dans tagging.java :

@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name="tagging", propOrder={
		"id",
		"authorid",
		"tagid",
		"bmid",
		"date"
	}
)
@XmlRootElement(name = "tagging")
public class Tagging {
	@XmlElement(name = "id")
	private String id;
	@XmlElement(name = "tagid")
	private String tagid;
	@XmlElement(name = "bmid")
	private String bmid;
	@XmlElement(name = "authorid")
	private String authorid;
	@XmlElement(name = "date")
	private String date;

Persistence sous forme de fichiers XML

Les classes Loader et Writer du package bmserv sont utilisées pour la persistence sous forme de fichiers XML. Regardez comment elles fonctionnent. Elles sont utilisées par le main() dans la classe Server.java pour charger des fichiers lors du lancement de l'application et reconstruire les Collections de Tags, Users, etc. à partir du XML, et aussi pour sauvegarder les fichiers lorsqu'on quitte le serveur (cf ServerStateListener.java, méthode onStop) :

@Override
	public void onStopped() {
		System.out.println("==> Server stopped !\n");
		try {
			Writer.serialize();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

 

Ajout de fonctionnalités

Maintenant, on va vous demander de rajouter de la fonctionnalité au projet :

  1. Ajouter un web service de consultation des Taggings en format html, l'url sera http://localhost:9998/tagging/all/html et devra renvoyer sous la forme d'une table HTML l'ensemble des Taggings, avec évidemment les Ids des relations (User id, Tag Id, Bookmark id). Vous vous inspirez des autres web services qui renvoient par exemple les Bookmarks ou les Users
  2. Créer une classe de formulaire permettant de rajouter un Bookmark. Vous utiliserez la méthode POST pour appeler l'URL http://localhost:9998/form/bookmark/add en "postant" le contenu du formulaire. La méthode appelée devra rajouter le bookmark à la liste des bookmarks existants.
  3. Bonus pour les bons :
    1. créer un web service pour ajouter un Tagging (liant un Bookmark Id à un tag id et au user courant), 
    2. Modifier le code pour respecter vraiment la norme REST en renvoyant dans le XML non pas les Ids des relations, mais les URi complets. Regarder le cours concernant l'utilisation des classes Jersey (page 41 des transparents du cours de Carols Mc Donald) + exemples d'utilisation dans les projets netbeans 6.8 vus en cours.

En-tête (sans les annotations de code) de la méthode à implémenter dans la classe BoomarkResource.java :

public String create(@Context HttpServletRequest req, MultivaluedMap<String, String> formParams){

Ce TP est à rendre pour lundi prochain !!!

Envoyer par mail à (ou envoyer un URL pour récupérer le projet) à ... micbuffa at gmail point com ou à freddy point limpens at inria point fr