Web services REST

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...

// 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
   ...

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

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);
}

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));
        ...
    }
}

 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

Blah blah

Ce TP est à rendre pour lundi prochain !!!

Envoyer par mail à (ou envoyer un URL pour récupérer le projet) à ...