Tutoriel sur l'utilisation d'Unfiltered pour l'implémentation de services Web REST en Scala

| Florian Hussonnois (Zenika) | Zenika |

Cet article se propose de présenter comment implémenter des services Web de type REST avec le langage fonctionnel Scala en utilisant la bibliothèque Unfiltered.

Pour réagir au contenu de cet article, un espace de dialogue vous est proposé sur le forum Commentez ♪

- Titre : Tutoriel sur l'utilisation d'Unfiltered pour l'implémentation de services Web REST en Scala

- Auteurs : Florian Hussonnois (Zenika), Zenika

- Parution : 23 juillet 2013

- Licence : Copyright ® 2013 Florian Hussonnois. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents, images, etc. sans l'autorisation expresse de l'auteur. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Introduction

- II. Un premier exemple

- II-A. Intents

- II-B. Plans

- II-C. Extractors

- II-D. ResponseFunction

- III. Configuration serveur

- IV. Un cas concret - Implémentation de services {Json}

- V. Conclusion

- VI. Liens

- VII. Remerciements

I - Introduction

La définition de REST trouve toute son essence à travers le protocole HTTP. Pourtant, la plupart des frameworks actuels reposent sur des API Java encore trop éloignées de ce dernier. La spécification de la JAX-RS (Java API for RESTful Web Services) a permis de simplifier la création de services REST au sein des applications JEE, entre autres, via l'utilisation des annotations. Cependant, ces implémentations gardent le plus souvent un accès direct à l'API Servlet rendant ainsi les applications Web dépendantes du serveur d'applications sur lequel elles sont déployées.

Unfiltered (http://unfiltered.databinder.net) est un « microframework » web qui permet ni plus ni moins l'intégration de services REST en Scala. Il est développé en partie par Nathan Hamblen. Unfiltered définit, entre autres, un niveau d'abstraction élevé pour le traitement des requêtes et des réponses, de manière à pouvoir exécuter toutes applications, utilisant la librairie « core », sur une variété de serveurs, tels que Tomcat ou encore Netty.

La bibliothèque se présente comme une simple couche de transition entre HTTP et Scala. Comme beaucoup d'autres frameworks, elle adopte pleinement certains concepts du langage comme pierre angulaire de son API. Pour cela, elle offre une approche élégante pour router les requêtes HTTP entrantes à travers l'utilisation du pattern matching.

II - Un premier exemple

Pour vous présenter les différents éléments de l'API et le vocabulaire utilisé au sein de celle-ci, voici un premier exemple.

1. object SayHello {

2. val intent = unfiltered.Cycle.Intent[Any, Any] {

3. case req@Path("/hello") => req match {

4. case POST(_) & Params(params) =>

5. OK ~> ResponseString("Hello " + params("name")(0).toString)

6. case _ => MethodNotAllowed ~> ResponseString("Method must be POST")

7. }

8. case req@Path(Seg("hello" :: name :: Nil)) => req match {

9. case GET(_) =>

10. OK ~> ResponseString("Hello " + name)

11. case _ => MethodNotAllowed ~> ResponseString("Method must be GET")

12. }

13. }

14. }

II-A - Intents

Tout d'abord, dans notre exemple nous avons commencé par implémenter une fonction appelée Intent et dont la spécification est la suivante :

1. type ResponseFunction[B] = HttpResponse[B] => HttpResponse[B]

2. type Intent[T] = PartialFunction[HttpRequest[T], ResponseFunction]

Cette fonction représente l'interface principale de l'API avec pour objectif de matcher une requête et de retourner une fonction permettant de produire la réponse correspondante.

Dans le cas présent, notre Intent matche les deux requêtes ci-dessous :

- POST /hello ;

- GET /hello/{name}.

Puis, elle retourne en réponse la chaîne de caractères « Hello » suivi du paramètre « name ». Par ailleurs, si une des URI est appelée avec une méthode HTTP qui n'est pas supportée, une erreur est alors retournée.

II-B - Plans

La définition d'une Intent n'est pas directement liée à une interface serveur particulière. De ce fait, Unfiltered définit un ensemble de traits dont le rôle est de lier une Intent à une interface serveur spécifique. Ces traits sont désignés sous le nom de Plan. Par exemple, le trait unfiltered.filter.Plan est une implémentation de l'interface javax.servlet.Filter qui délègue le traitement de la requête à sa méthode intent.

1. object SayHelloFilter extends

2. unfiltered.filter.Planify(SayHello.intent)

De la même manière, l'API définit un channel handler pour Netty.

1. object SayHelloHandler extends

2. unfiltered.netty.cycle.Planify(SayHello.intent)

Unfiltered utilise des classes génériques HttpRequest et HttpResponse pour encapsuler les objets propres à l'interface serveur sous adjacente. Cependant, chacune d'entre elles expose une méthode « underlying » donnant un accès direct aux objets en question. Ainsi, dans un contexte de conteneur de servlets, il reste possible de manipuler directement les objets HttpServletRequest/HttpServletResponse au sein de votre application.

II-C - Extractors

Intéressons-nous plus en détail à l'implémentation de notre Intent et plus précisément, à la manière dont une HttpRequest est routée. Comme mentionné un peu plus tôt, Unfiltered repose sur l'utilisation du pattern matching mais également sur celle des extracteurs. Les extracteurs sont un des mécanismes Scala permettant d'extraire des données d'un objet sur lequel est appliqué un pattern matching.

La plupart des extracteurs, fournis par l'API d'Unfiltered, définissent une méthode unapply() qui accepte en argument un objet HttpRequest :

1. def unapply(x: HttpRequest): (Y, HttpRequest)

Souvent, cette méthode retournera l'objet extrait de la requête sous la forme d'un Option[T]. Cependant, il peut s'avérer utile de retourner l'objet HttpRequest pour permettre le chaînage des extracteurs entre eux.

Dans l'exemple ci-dessus, nous utilisons quelques-uns d'entre eux pour router notre requête en fonction du Path( ) ou encore de la méthode HTTP avec GET(_) et POST(_). On trouve également l'objet Seg qui permet d'extraire une liste de String depuis les différents éléments du Path (séparés par des slashes (‘/')). Enfin, nous utilisons l'objet Params pour extraire les paramètres HTTP sous la forme d'une Map[String, Seq[String]].

Unfiltered possède de nombreux autres extracteurs, très intuitifs de par leur nom, pour matcher une HttpRequest. Cependant, vous serez rapidement amenés à créer vos propres extracteurs dans le but d'extraire le corps de la requête dans un certain format (par exemple Json) ou encore valider des paramètres. La validation des données étant une problématique récurrente, dès qu'il s'agit de manipuler des données client, Unfiltered propose la classe Params.Extract pour faciliter la création d'extracteur dont le rôle s'y prête.

L'utilisation de l'extracteur Params ne permet pas d'effectuer de contrôle sur les données dans le cas d'une requête POST; Il serait alors tout à fait possible de passer un paramètre vide.

Il suffit alors de définir un extracteur à l'aide de la classe Params.Extract, et de le chaîner à l'extracteur Params :

1. object NonEmptyName extends Params.Extract("name",Params.first ~> Params.nonempty)

Le premier paramètre correspond au nom du paramètre à extraire. Le deuxième paramètre correspond à un ParamMapper permettant d'effectuer une transformation sur le paramètre extrait. La définition de cette fonction est la suivante: Seq[String] => Option[T]. Il peut alors s'agir d'une condition de filtre ou d'une simple méthode de transformation. Unfiltered fournit un certain nombre de ParamMapper tel que Params.first et Params.noempty, qui sont chaînables via la méthode ~>.

1. object SayHello {

3. val intent = unfiltered.Cycle.Intent[Any, Any] {

4. case req@Path(Seg("hello" :: name :: Nil)) => req match {

5. case GET(_) =>

6. OK ~> ResponseString("Hello " + name)

7. case _ => MethodNotAllowed ~> ResponseString("Method must be GET")

8. }

9. case req@Path("/hello") => req match {

10. case POST(_) & Params(NonEmptyName(name)) =>

11. OK ~> ResponseString("Hello " + name.toString)

12. case POST(_) =>

13. BadRequest ~> ResponseString("""The parameter "name" is missing""")

14. case _ => MethodNotAllowed ~> ResponseString("Method must be POST")

15. }

16. }

17. }

Au-delà d'effectuer une simple validation, l'extracteur créé nous permet de router la requête en fonction de la présence ou non d'un paramètre.

II-D - ResponseFunction

Enfin, une Intent doit retourner une ResponseFunction. Pour cela, L'API offre des implémentations appelées Responders qui sont chaînables via l'utilisation de la méthode ~>. Ainsi, dans l'exemple ci-dessus les réponses sont composées en chaînant les Responders « OK »/« MethodNotAllowed » et « ResponseString ». De plus, l'utilisation des codes retour HTTP n'étant pas très explicites Unfiltered définit un objet pour chaque code retour, ici OK pour Status (200).

III - Configuration serveur

Maintenant que vous connaissez tout, ou presque, des mécanismes d'Unfiltered, il est temps de tester notre premier exemple.

Vous pouvez, dans un premier temps, télécharger le projet SBT ou Maven sur le repository GitHub suivant : https://github.com/Zenika/unfiltered-demo-json.

Le projet contient l'ensemble des exemples qui sont présentés dans la suite de cet article.

Une première approche consiste à ajouter la déclaration du SayHelloFilter dans le descripteur de déploiement web.xml de votre application, avant de la déployer dans votre conteneur de servlets favori.

web.xml

1. <web-app>

2. <filter>

3. <filter-name>SayHello</filter-name>

4. <filter-class>com.example.filter.SayHelloFilter</filter-class>

5. </filter>

6. <filter-mapping>

7. <filter-name>SayHello</filter-name>

8. <url-pattern>/*</url-pattern>

9. </filter-mapping>

10. </web-app>

Mais, il est très probable que beaucoup de personnes trouvent cette approche quelque peu fastidieuse. Heureusement, Unfiltered nous facilite la vie et offre la possibilité de réaliser des applications standalones, grâce à une intégration native de Jetty en tant que serveur embarqué. Pour cela, il suffit de créer un point d'entrée à notre application de la manière suivante :

1. object Server {

2. def main(args: Array[String]) {

3. unfiltered.jetty.Http.local(8080)

4. .filter(SayHelloFilter)

5. .run

6. }

7. }

IV - Un cas concret - Implémentation de services {Json}

Nous allons maintenant réaliser une application CRUD qui stockera des recettes de cocktails et exposera uniquement des services REST/Json.

Nous utiliserons pour cela, la classe suivante pour modéliser notre objet métier Cocktail.

1. package com.zenika.unfiltered.demo.domain

3. object Cocktail {

4. type Ingredient = String

5. type Quantity   = String

6. }

8. case class Cocktail(

9. val name: String,

10. val recipe: String,

11. val ingredients: List[(Cocktail.Ingredient, Cocktail.Quantity)]

12. )

Pour manipuler des données au format Json, Unfiltered s'appuie sur la librairie Json de Lift (https://github.com/lift/lift/tree/master/framework/lift-base/lift-json/). Cette librairie offre, en outre, une DSL pour écrire directement du Json en Scala ainsi que des parsers pour convertir des cases classes en Json et inversement. Si vous n'êtes pas familiarisés avec cette librairie, je vous invite à lire la documentation. Néanmoins cela n'est pas requis pour la suite de ce billet.

Unfiltered fournit :

- unfiltered.response.Json : il s'agit d'un Responder pour retourner une réponse au format Json ;

- unfiltered.request.JsonBody : il s'agit d'un extracteur pour transformer les données.

Ces objets manipulant la classe net.liftweb.json.JsonAST.JValue, nous allons définir une conversion implicite de notre objet Cocktail en un objet JValue. Pour cela, nous utiliserons simplement la DSL offerte par l'API Json.

Pour des raisons d'organisation, les conversions seront définies dans un objet CocktailRepresentations que nous pourrons, par la suite, importer dans notre Plan.

1. package com.zenika.unfiltered.demo.representation

3. import com.zenika.unfiltered.demo.domain.Cocktail

5. import net.liftweb.json.JsonDSL._

6. import net.liftweb.json.JsonAST.JValue

8. object CocktailRepresentation {

10. implicit def toJValue(cocktails: Seq[Cocktail]): JValue =

11. ("cocktails" -> cocktails.map(c => toJValue(c)))

13. implicit def toJValue(cocktail: Cocktail): JValue =

14. ("name" -> cocktail.name) ~

15. ("recipe" -> cocktail.recipe) ~

16. ("ingredients" ->

17. cocktail.ingredients.map(i =>

18. ("name" -> i._1) ~

19. ("quantity" -> i._2))

20. )

21. }

Dans les conversions implicites ci-dessus, les méthodes « ~ » et « -> » font partie de la DSL Json de Lift.

Nous pouvons dès à présent implémenter les services GET qui seront accessibles via les commandes CURL suivantes :

1. curl -X GET http://localhost:8080/cocktails --header &#8220;Accept: application/json&#8221;

2. curl -X GET http://localhost:8080/cocktails/{id} --header &#8220;Accept: application/json&#8221;

Voici l'implémentation des services REST. Pour rester simple, nous utilisons une Map pour enregistrer les cocktails.

1. package com.zenika.unfiltered.demo.plan

3. import unfiltered.request._

4. import unfiltered.response._

6. import com.zenika.unfiltered.demo.domain.Cocktail

7. import com.zenika.unfiltered.demo.representation.CocktailRepresentation._

9. object CocktailPlan extends unfiltered.filter.Plan {

11. val repository: scala.collection.mutable.Map[Int, Cocktail] = scala.collection.mutable.Map.empty

13. def intent = {

14. case req@ Path( Seg( "cocktails" :: id :: Nil ) ) => req match {

15. case GET(_) => req match {

16. case Accepts.Json(_) =>

17. repository.get(id.toInt).map(

18. (c: Cocktail) => Ok ~> Json(c) ) getOrElse{NotFound ~> ResponseString("resource not found") }

19. case _ =>

20. NotAcceptable ~> ResponseString("You must accept application/json")

21. }

22. }

23. case req@ Path("/cocktails") => req match {

24. case GET(_) => req match {

25. case Accepts.Json(_) => OK ~> Json(repository.values.toSeq)

26. case _ =>

27. NotAcceptable ~> ResponseString("You must accept application/json")

28. }

29. }

30. }

31. }

Avant d'implémenter nos services PUT et POST, il est nécessaire de convertir un flux Json en un objet Cocktail. Unfiltered propose la classe unfiltered.request.JsonBody qui permet d'extraire les données d'une requête au format Json en un objet JValue de la librairie Lift. Son utilisation étant quelque peu limitée, nous allons définir deux nouvelles classes pour faciliter la manipulation de nos objets.

1. package com.zenika.unfiltered.demo.common

3. import com.zenika.unfiltered.domain.Cocktail

4. import unfiltered.request._

5. import net.liftweb.json.JsonAST._

7. class JsonMapper[A](f: Option[JValue] => Option[A]) extends (Option[JValue] => Option[A]) {

8. def apply(oj: Option[JValue]) = f(oj)

9. }

11. object JsonObjectBody  {

13. implicit val formats = net.liftweb.json.DefaultFormats

15. class Extract[A]( f: JsonMapper[A] ) {

17. def this(  ) (implicit mf: Manifest[A]) = this( new JsonMapper[A]( _.map(_.extractOpt[A]).getOrElse(None)) )

19. def unapply[T](req: HttpRequest[T]): Option[A] = f( unfiltered.request.JsonBody(req) )

21. }

22. }

La classe JsonMapper n'est rien d'autre qu'une fonction qui prend en argument un Option[JValue] et qui retourne un Option[A]. Comme son nom l'indique, son rôle est de mapper un objet Json vers notre objet métier, qui dans notre cas n'est autre que Cocktail.

Ensuite, l'objet JsonObject contient une classe Extract dont le but est de faciliter la création d'extracteurs à l'aide d'un JsonMapper. Par défaut, elle utilise un JsonMapper qui transforme naturellement l'objet Json en un certain objet de type A via la méthode extractOpt[A] de la librairie Lift.

Nous allons, cependant, devoir créer un Mapper spécifique pour notre objet. En effet, si vous regardez bien la structure de classe Cocktail, vous remarquez que les ingrédients sont représentés par une List[(Cocktail.Ingredient, Cocktail.Quantity)].

Traduit directement en Json, nous aurons un flux sous la forme :

1. {ingredients: [{"_1": "rhum", "_2": "100ml"}, {"_1": "orange", "_2": "300ml"}]}

Vous conviendrez que l'utilisation de la notation Scala n'est ici pas très explicite. Il serait préférable d'avoir un flux Json de la forme suivante :

1. {ingredients: [{"name": "rhum", "quantity": "100ml"}, {"name": "orange", "quantity": "300ml"}]}

Pour cela, il est nécessaire de transformer, après extraction, l'objet Json pour le faire matcher avec la classe Cocktail. Cette opération est réalisable à l'aide de la méthode transform( ) de la classe JValue qui accepte en argument une fonction partielle pour réaliser le mapping.

Nous pouvons alors nous en servir pour créer l'Extracteur suivant :

1. import unfiltered.request._

2. import unfiltered.response._

3. import com.zenika.unfiltered.demo.domain.Cocktail

4. import com.zenika.unfiltered.demo.common.{JsonBody, JsonMapper}

5. import net.liftweb.json.JsonAST.{JValue, JObject, JField}

7. object CocktailBody extends JsonBody.Extract[Cocktail](new JsonMapper((o: Option[JValue]) => {

9. implicit val formats = net.liftweb.json.DefaultFormats

11. o.map(_.transform {

12. case JObject(List(JField("name", n), JField("quantity", q))) => JObject(List(JField("_1", n), JField("_2", q)))

13. }.extractOpt[Cocktail]).getOrElse(None)

14. }))

Il est alors possible d'utiliser cette classe comme tout autre extracteur pour matcher l'HttpRequest.

Une partie du code a été omise pour ne pas surcharger l'article.

1. case req@ Path( Seg( "cocktails" :: id :: Nil ) ) => req match {

2. // PUT /cocktails/{id} --header "Content-Type: application/json"

3. case PUT(_) & RequestContentType(ct) => ct match {

4. case "application/json" => req match {

5. case CocktailBody(c) => {

6. if( repository.contains(id.toInt)) {

7. repository.update(id.toInt, c)

8. Ok ~> ResponseString("The cocktail has been successfully updated")

9. } else NotFound ~> ResponseString("resource not found")

10. }

11. case _ => BadRequest ~> ResponseString("data must be valid application/json")

12. }

14. case _ => UnsupportedMediaType ~> ResponseString("content-type must be application/json")

15. }

16. case req@ Path("/cocktails") => req match {

17. // POST /cocktails --header "Content-Type: application/json"

18. case POST(_) & RequestContentType(ct) => ct match {

19. case "application/json" => req match {

20. case CocktailBody(c) => {

21. repository += (repository.lastOption.map(x => x._1).getOrElse(0) + 1) -> c

22. Created ~> ResponseString("The cocktail has been successfully created")

23. }

24. case _ => BadRequest ~> ResponseString("Invalid json data")

25. }

26. }

27. }

Nous pouvons maintenant ajouter notre premier cocktail. Pour cela, vous pouvez utiliser la commande suivante :

1. curl -i -X POST http://localhost:8080/cocktails \

2. --header "Content-Type:application/json" \

3. --data '{"name":"Mojito","recipe":"Mélanger les ingrédients","ingredients":[{"name":"Rhum","quantity":"6cl"},{"name":"jus de citron","quantity":"3cl"},{"name":"eau gazeuse","quantity":"30cl"}]}'

Mais vous avez oublié l'ingrédient secret ! Vous pouvez modifier votre cocktail avec la commande suivante :

1. curl -i -X PUT http://localhost:8080/cocktails/1 \

2. --header "Content-Type:application/json" \

3. --data '{"name":"Mojito","recipe":"Mélanger les ingrédients","ingredients":[{"name":"Rhum","quantity":"6cl"},{"name":"jus de citron","quantity":"3cl"},{"name":"eau gazeuse","quantity":"30cl"}, {"name": "feuilles de menthe", "quantity":"3"}]}'

V - Conclusion

Au-delà du fait qu'Unfiltered offre l'avantage d'être simple d'approche, celui-ci n'impose aucune contrainte en terme d'implémentation. La manière dont une Intent doit être définie est ainsi laissée aux développeurs. Unfiltered reste extensible de par la simplicité de son API. Bien que l'on puisse lui reprocher certains manques sur le binding des paramètres, vous pouvez être certain qu'il n'y a aucune magie derrière le traitement des requêtes. Et, comme le dit Maxime Lévesque (créateur de l'ORM Squeryl écrit en Scala) :

In my opinion, Unfiltered's main strength is in what it doesn't do

Enfin, pour les points négatifs (il y en a toujours), la documentation n'est pas forcément complète et il peut rapidement s'avérer nécessaire de regarder le code source.

N'hésitez pas à consulter directement la documentation d'Unfiltered pour plus d'éléments (gestion des services asynchrones, des cookies ou encore de l'authentification). Par ailleurs, je vous invite aussi à regarder la présentation faite par Nathan Hamblen; http://vimeo.com/39951111. Merci à vous et n'hésitez pas à me faire part de vos remarques ou de vos retours d'expérience sur Unfiltered.

VI - Liens

- Documentation Unfiltered : http://unfiltered.databinder.net/

- Slides de Présentation, par Doug Tangren : http://unfiltered.lessis.me/

- Github Lift-Json : https://github.com/lift/lift/blob/master/framework/lift-base/lift-json/README.md

- Github Unfiltered : https://github.com/softprops/Unfiltered/blob/master/README.markdown

VII - Remerciements

Cet article a été publié avec l'aimable autorisation de Florian Hussonnois. L'article original (Unfiltered - Implémenter des services REST en Scala) peut être vu sur le blog/site de Zenika.

Nous tenons à remercier zoom61 pour sa relecture orthographique attentive de cet article et Mickael Baron pour la mise au gabarit.