Express.js

Cet article est en construction: un auteur est en train de le modifier.

En principe, le ou les auteurs en question devraient bientôt présenter une meilleure version.

---

Introduction

Express.js est un framework basé sur Node.js pour le développement d'applications web. Express.js (appelé également Express par la suite) applique les mêmes caractéristiques générales de Node.js (non-blocking I/O, event-driven, …) mais dans le cadre plus spécifiques des applications web basées sur l’architecture requête/réponse. Le résultat est un framework très flexible qui permet surtout de créer des applications qui prévoient l’échange de données en temps réel entre plusieurs utilisateurs.

La plupart des informations contenues dans cette page se réfèrent à la version 4.x d'Express.js.

Objectifs de cette page

Cette page fait principalement référence au cours STIC I du Master MALTT et s'inscrit dans la perspective d'aborder les fondamentaux de la programmation à travers JavaScript. Plus en détail, Express.js permet de montrer de manière concrète et pragmatique des éléments conceptuels et techniques liés à l'architecture requête/réponse des applications web.

Pour comprendre le contenu de cette page la lecture des pages suivantes est conseillée :

• Introduction à la programmation
• JavaScript
• Tutoriel JavaScript de base
• Node.js

Avertissement de sécurité

Le même avertissement de sécurité de Node.js s'applique dans le cas d'Express.js, car les technologies utilisées sont très similaires.

Veuillez également être attentif au fait que les exemples illustrés dans cette page ont exclusivement une finalité propédeutique à l’apprentissage des concepts fondamentaux du développement web et ne sont pas conçu pour une utilisation en dehors d’un environnement contrôlé par le développeur (e.g. localhost).

Rappel sur l'architecture requête/réponse

À faire, en attente voir par exemple :

• Ce tutoriel sur OpenClassrooms qui explique le mécanisme
• La page sur le protocole HTTP sur Wikipedia
• Cette liste de codes HTTP sur Wikipedia pour connaître les différents status associés aux résultats d'une requête

Installation de Express.js

Installer le module Express

Comme tout module node.js qui se trouve sur npm, il y a deux possibilité pour installer Express.js :

1. En local dans le dossier de votre application
2. Globalement dans votre système

Installation locale dans le dossier de l'application

La commande pour installer Express.js en tant que module locale dans le dossier de votre application est le suivant :

npm install express

Ce type d'installation résulte dans l'arborescence suivante :

Votre_dossier
|- node_modules
   |- express
|- votre_fichier_node_principale.js

Installation globale dans le système

Pour installer Express.js de manière globale dans le système, la commande est la suivante :

npm install -g express

L'installation d'express de manière globale n'est cependant pas très intéressante, car ce type d'installation est plus appropriée pour des modules qui prévoient une utilisation en ligne de commande, ce qui n'est pas le cas pour Express. L'installation en locale est donc le choix plus adéquat.

Importer le module dans votre application

Encore une fois, Express.js est un "simple" module Node.js et par conséquent il est suffisant d'utiliser la fonction require() pour l'importer dans votre application :

var express = require('express');

Contrairement à d'autres modules tels que fs, cependant, qui retournent un objet avec des propriétés et des méthodes, Express.js retourne une fonction. Pour cette raison, on associe cette fonction à une autre variable (généralement appelée app) qui représente l'application web elle-même :

//Importer le module express
var express = require('express');
//Le module express exporte une fonction, donc associer la fonction à une variable
var app = express();

Première application web avec Express.js

Express.js est un framework basé sur le module http de Node.js (avec quelques éléments en plus). Donc l'architecture d'un service/serveur web créé avec Express.js est assez similaire à un serveur/service web créé avec le module http. Voici un exemple avec des commentaires pour faciliter la compréhension des différents éléments :

//Importer le module express
var express = require('express');
//Le module express exporte une fonction, donc associer la fonction à une variable
var app = express();

//Définir la route principale de l'application et envoyer une réponse
app.get('/', function(request, response) {
    //Express envois automatiquement les headers en fonction du contenu, dans ce cas du text/plain
    response.send("My first express app!");
});

//Le server http écoute sur la porte 9000
app.listen(9000);

//Message pour la console
console.log("Server listening at http://localhost:9000/");

Le changement plus important par rapport à un simple serveur web avec http concerne l'utilisation des "routes" avec la méthode app.get() qui a comme objectif d'intercepter les requêtes en fonction de l'URL. Dans cet exemple, nous spécifions la route "/", c'est-à-dire l'URL même de notre serveur/service web, qui dans notre cas est le localhost avec la porte 9000. Voici le résultat que vous obtenez à l'adresse http://localhost:9000 :

Simple application avec Express.js.

Ce simple exemple ne permet pas d’apprécier les potentialités de Express.js, mais donne néanmoins déjà un aperçu de sa "philosophie" de framework basé sur l'architecture requête/réponse. Dans la suite de cette page, nous fournirons quelques concepts théoriques et quelques exemples pour approfondir cette architecture.

Comprendre Express.js

Express.js permet d'exploiter la structure événementielle de Node.js dans le cadre spécifique des applications web basées sur l'architecture client/serveur et requête/réponse. Pour bien comprendre le fonctionnement de Express.js, il peut être utile de faire une comparaison avec un serveur web "normal" tel que Apache.

Le rôle de l'interprète

Une des différences fondamentales entre un serveur web Node.js/Express.js et un serveur traditionnel consiste dans le positionnement et le rôle de l'interprète du langage de programmation utilisé pour générer des pages web dynamiques.

Cycle requête/réponse avec un server web traditionnel

Un serveur "traditionnel" est principalement construit pour servir des pages statiques (i.e. en simple HTML) selon une simple association entre l’URL de la ressource souhaitée et le positionnement des fichiers HTML sur le serveur web. Pour générer des pages web dynamiques, donc, un serveur comme Apache nécessite de la présence d'un interprète, comme par exemple PHP, qui identifie des pages dynamiques en fonction de l'extension (.php). Dans le cas de ces pages, le serveur exécute les instructions contenues dans le fichier - qui servent normalement à générer du HTML - avant de renvoyer la ressource en tant que réponse. La carte conceptuelle suivante montre le cycle requête/réponse lorsque le serveur utilise un serveur HTTP "traditionnel" :

Cycle requête/réponse avec un server HTTP "traditionnel".

Cycle requête/réponse avec un server web Node.js/Express.js

Le même cycle requête/réponse est par contre très différent avec un serveur créé avec Node.js, comme c'est le cas de Express.js. Node.js permet en effet de créer directement un serveur HTTP qui est chargé de traiter les requêtes faites par un client et générer des réponses, comme par exemple des pages HTML. En d'autres termes, en accord avec le principe événementielle de Node.js, les requêtes faites à travers un protocole HTTP ne représentent qu'un type d'événement particulier, qui peut être géré avec un module http. Express.js est tout simplement un ensemble d'objets (avec des propriétés et méthodes) qui peuvent être utiles pour gérer le cycle requête/réponse. La carte conceptuelle suivante montre ce cycle avec Express.js :

Le cycle requête/réponse avec Express.js.

Single thread vs. Multi thread

Multi-thread: une copie pour chaque ressource

Une autre différence majeure entre Express.js et un server web traditionnel concerne l'architecture Multi- vs. Single-thread. Dans une architecture traditionnelle de type Multi-thread, le server associe à chaque requête une "copie" de la ressource qu'il crée ex-novo chaque fois qu'un client demande cette ressource. Les copies (i.e. les "threads") sont donc indépendantes les unes des autres et si deux clients demandent la même ressource de manière simultanée, ils vont obtenir les deux ressources telles qu'elles sont à ce moment exact dans le temps. Cela signifie que, dans le cas plus théorique que réel où deux requêtes sont traitées exactement en même temps, si la première requête apporte un changement à la ressource demandé, cette modification ne sera pas disponible dans l'autre requête simultanée. Voici un schéma illustrant une architecture Multi-thread:

Architecture Multi-thread d'un server web : chaque requête reçoit une "copie" de la ressource demandée.

Single thread: la même ressource pour tous

Express.js adopte plutôt une architecture de type Single-thread, dans laquelle chaque requête est traitée de manière individuelle en ayant accès à la même ressource. Si deux requêtes surviennent de manière simultanée, le server les insère dans une queue et détermine l'ordre de traitement. Normalement, celle qui reçoit la première position dans la queue sera également la première à être traitée, mais en raison de la nature fortement asynchrone de Node.js, il est difficile de prévoir exactement l'ordre de traitement. Ce qui est important à noter c'est plutôt le fait que l'architecture Single-thread fait ainsi que toutes les requêtes ont accès à la dernière version de la ressource, car toutes les requêtes ont accès à la même ressource et pas à des copies. Cela se traduit par le fait que une modification faite par la requête qui passe en première dans la queue de traitement sera déjà disponible dans la requête qui est passe en deuxième. Voici un schéma illustrant l'architecture Single-thread:

Architecture Single-thread d'Express.js : le server traite de manière centralisée toutes les requêtes, qui ont par conséquent accès à la même ressources (dans son état le plus actuel).

Veuillez noter que l'architecture Single-thread ne s'applique pas seulement à la même ressource (e.g. la page /about/ dans le cas du schéma), mais à toutes les ressources disponibles dans le server. Cela signifie que deux requêtes simultanées seront placées dans la queue de traitement même si elles demandent deux ressources différentes (e.g. une requête la page /about/ et l'autres la page /contact/). Ce mécanisme fait ainsi que toutes les requêtes qui arrivent sur un server Express.js soient traitées de manière centralisée et ont donc accès à la version la plus récente de toutes les données qui concernent toutes les ressources de l'application.

Le concept de "middleware"

Définition générale

Un middleware est un logiciel qui se situe entre le hardware et le software. Il permet la communication entre des logiciels qui ne sont initialement pas prévu pour communiquer. Le middleware permet aussi la communication entre bases de données. Toutes ces communications peuvent être réalisées de manière synchrone et asynchrones. Cela veut dire que les applications n'ont pas besoin d'être disponibles simultanément pour pouvoir communiquer.

L'échange de message fonctionne, de manière imagée, comme une boite mail. Les messages sont envoyés et reçus dans des queues de traitement. Ce type de programme est appelé MoM ou Message-Oriented-Middleware.

Les trois principales interactions que peut réaliser un middleware sont l'échange de message, l'appel de procédure ainsi que la manipulation d'objets.

Les middleware dans Express.js

Dans le cadre d'Express.js, le middleware maintient son rôle de couche intermédiaire, mais appliquée entre la requête et la réponse plutôt qu'entre le hard- et le soft-ware. Si on résume à l'essentiel l'architecture requête/réponse, on peut établir que la requête d'un client n'est pas satisfaite avant qu'elle ne reçoive une réponse. Donc, il y a des mécanismes intermédiaires entre la requête et la réponse qui sous-tendent la satisfaction de la requête avec la réponse appropriée.

En considération de l'architecture Single-thread d'Express.js (voir point précédent), toutes les requêtes passent par le même endroit et il faut donc des mécanismes qui permettent, parmi d'autres choses, de :

• Intercepter et identifier quel type de requête a été faite, par exemple :
  • Quelle ressource (e.g. quelle page) a été demandée?
  • Quel type de requête a été faite? Une requête de type GET, de type POST, etc.
  • La requête dispose-t-elle d'informations supplémentaires (données d'un formulaire web, cookie avec username, etc.) ?
  • Est-ce que la requête demande une ressource qui existe dans le server (ou existe encore) ?
• Construire une réponse appropriée à la requête, par exemple :
  • Est-ce que le client a le droit de recevoir tout le contenu de la réponse ou seulement une partie ?
  • Est-ce qu'il faut personnaliser la réponse ? Par exemple en envoyant les données dans un database qui ont été insérées par un utilisateur spécifique.

Une chaîne séquentielle de middleware

Une application web avec Express.js se compose normalement de plusieurs middleware qui ont justement le rôle d'évaluer la requête et envoyer, selon la logique de l'application, la réponse associée à un requête de ce type. Pour déterminer la logique de l'application, on fait recours à plusieurs middlewares représentant des étapes séquentielles. Voici une représentation schématique du cycle qui se crée :

1. Le server intercepte une requête
2. Passage dans le Middleware1, si la logique du Middleware1 prévoit une réponse, alors la requête est satisfaite, si non continuer dans le cycle
3. Passage dans le Middleware2, si la logique du Middleware2 prévoit une réponse, alors la requête est satisfaite, si non continuer dans le cycle
4. Passage dans le Middleware3, si la logique du Middleware3 prévoit une réponse, alors la requête est satisfaite, si non continuer dans le cycle
5. Etc.

De manière plus concrète, un middleware est une fonction qui accepte au moins trois arguments :

1. L'objet requête
2. L'objet réponse
3. Le prochain middleware qui doit être exécuté avec une fonction de callback (e.g. next()).

Le next() middleware sera executé si le middleware courant ne prévoit pas une réponse, autrement le cycle s'arrête. Si un middleware ne prévoit pas un next(), le processus va rester figé dans ce middleware, même s'il n'y a pas une réponse, ce qui se traduit normalement par une page "loading" sans arrêt. Il est donc important d'ajouter toujours la possibilité de poursuivre au prochain middleware si le middleware courant ne prévoit pas une réponse.

Voici le code "prototypique" d'une suite de middleware:

 //Définitions des middlesware
 //Middleware 1
 function myMiddleware1(request, response, next) {
   if(request ... ) {
      response.send("La requête a trouvé son bonheur");
   } else {
     next(); //On continue dans le cycle
   }
 }
 //Middleware 2
 function MyMiddleware2(request, response, next) {
   if(request ...) {
     response.send("La requête a trouvé son bonheur");
   } else {
     next(); //On continue dans le cycle
   }
 }
 //Middleware final
 function MyMiddlewareFinal(request, response) {
   response.send("La requête ne trouve pas son bonheur, désolé!");
 }
 
 //Utilisation hypothétique des middleware
 MyMiddleware1(request, response, Middleware2);
 MyMiddleware2(request, response, MiddlewareFinal);

En réalité, dans l’utilisation concrète d’Express.js, il n’est pas nécessaire de spécifier quel middleware sera exécuté successivement : Express.js crée automatiquement une liste (i.e. un « stack ») de middleware en fonction de leur position dans le code. Pour qu’un middleware soit pris en compte, il faut tout simplement l’appliquer à l’intérieur de l’application (i.e. l’associer à la variable app qui représente l’application express). Cela peut se faire de deux manières différentes qui sont illustrées dans le point suivant.

Positionnement et "scope" des middlewares

Les middlewares peuvent s'appliquer généralement de deux manières :

1. De manière "globale" à travers la notation app.use(myMiddleware)
2. De manière spécifique à une route à travers la notation app.get("/", myMiddleware, function (request, response) {...});

Dans les deux cas, il est possible d'appliquer plusieurs middlewares à la suite. De manière globale :

app.use(myMiddleware1);
app.use(myMiddleware2);
...

Ou de manière spécifique à une route :

app.get("/", myMiddleware1, myMiddleware2, ..., function (request, response) { ... });

Veuillez noter que les middlewares "globaux" sont appliqués à partir de leur positionnement dans la logique de l'application, c'est-à-dire que si une route est déclarée avant l'utilisation d'un middleware "global", celui-ci ne sera pas appliqué à cette route, mais seulement à celles décalrées ensuite :

 //Importer le module express
 var express = require('express');
 //Le module express exporte une fonction, donc associer la fonction à une variable
 var app = express();
 
 //Déclaration d'un middleware qui affiche un message "Working in progress"
 function workingInProgress (request, response) {
   response.send("Working in progress");
 }

 //Déclaration d'une route pour la homepage qui n'est pas affectée par le middleware
 app.get("/", function (request, response) {
   response.send("Welcome!");
 });

 //Application du middleware à toutes les routes suivantes
 app.use(workingInProgress);

 //Déclaration d'une route qui sera affectée par le middleware workingInProgress()
 app.get("/about", function (request, response) {
   //Ce message ne sera pas affiché, car "overruled" par le middleware global
   response.send("About");
 });

 //Déclaration d'une autre route qui sera affectée par le middleware workingInProgress()
 app.get("/contacts", function (request, response) {
   //Ce message ne sera pas affiché, car "overruled" par le middleware global
   response.send("Contacts");
 });

 //Lancer le server
 app.listen(3000, console.log("Server listening to http://localhost:3000);

Voici le résultat qui sera affiché selon le type de requête faite:

• http://localhost:xxxx/ (homepage) --> Welcome
• http://localhost:xxxx/about --> Working in progress
• http://localhost:xxxx/contacts --> Working in progress

En d'autres termes, en fonction de l'architecture single-thread d'Express.js, la logique de l'application ne fait pas de distinction entre les requêtes /about et /contacts, car elles sont traités par le middleware global workingInProgress() avant qu'on ne puisse faire une distinction en fonction des différentes routes de type GET. Au contraire, la requête de type "/" (homepage) satisfait les conditions de la requête en envoyant une réponse avant le middleware global workingInProgress(), c'est pourquoi elle affichera le message prévu dans sa route.

Exemple: le express.static() middleware

Un bon exemple propédeutique pour comprendre le fonctionnement des middlewares concerne l’utilisation d’un middleware mis directement à disposition par le module express : le express.static() middleware. Nous avons vu dans le premier exemple d’application avec Express.js que pour accéder à une ressource particulière on utilise des routes, e.g. app.get('/url', …) avec un url différente pour chaque ressource. Il est claire que cette démarche n’est pas très pratique si on pense notamment au fait qu’un site web présente normalement plusieurs ressources et que certains d’entre elles ne sont pas des pages, mais tout simplement des fichier « statiques » tels que des images, des feuilles CSS, des fichiers JavaScript, etc. Il serait peu pratique si on devait spécifier une route pour chacune de ces ressources, parce que ceci serait en contraste avec l’utilité d’Express.js de faciliter la création d’application web.

Pour mettre en place facilement un mécanisme qui permet d’accéder à des ressources statiques de ce type, Express.js met à disposition un middleware à appliquer de manière globale qui accepte comme argument la référence absolue à un dossier qui contient les fichiers statiques. On peut mettre en place un serveur statique avec une simple ligne de code en utilisant le principe du middleware :

app.use(express.static(__dirname + '/dossier/qui/contient/les/fichiers/'));

La notation __dirname représente un simple raccourci pour identifier le dossier dans lequel se trouve le script qui contient cette ligne de code, ainsi qu’on puisse par la suite référencer le dossier qui contient les fichiers statiques en termes relatives. Imaginons que le serveur statique est censé afficher le contenu d’un dossier appelé public qui se trouve dans la même position du script qui crée l’application web, l’arborescence serait la suivante :

Dossier-application
|- public
   |- page.html
   |- style.css
   |- image.jpg
- server.js

Le code pour mettre en place le server statique serait par conséquent :

app.use(express.static(__dirname + '/public/'));

Notre dossier avec les fichiers statique contient trois fichiers, un fichier html, un fichier css et une image. La fonction du middleware consiste à créer une mécanisme qui intercepte la requête faite à l'application et contrôle s'il y a un fichier statique qui correspond à l'url de la requête. Veuillez noter que le nom du dossier ne doit pas faire partie de l'url de la requête, donc dans ce cas les ressources statiques serent accessibles aux addresses suivantes :

• Une requête http://localhost:xxxx/page.html
• Une requête http://localhost:xxxx/style.css
• Une requête http://localhost:xxxx/image.jpg

De manière conceptuelle, donc, express.static() agit selon la logique suivante :

• Intercepter la requête
• Contrôler s'il existe une ressource dans le dossier des fichiers statiques dont la référence correspond à la requête
  • Si une ressource de ce type existe, alors la requête est satisfaite et le contenu de ce fichier peut être envoyé en réponse
  • Si une ressource de ce type n'existe pas, alors continuer avec le prochain middleware

Étant donné qu'il s'agit d'un middleware, les mêmes principes de positionnement et d'application illustrés plus haut s'applique également à express.static(). On peut illustrer un exemple. Imaginons de créer une route de ce type :

app.get("/page.html", function (request, response) {
  response.send("Je suis une route, pas un fichier statique");
});

La route possède un url qui est en conflit avec le fichier page.html servi par le server statique. Le type de ressource qui sera renvoyée en réponse dependra donc de la position du middleware par rapport à cette route :

• Si app.use(express.static(...)) apparait AVANT la route, alors le fichier statique sera affiché
• Si le server apparait APRES la route, alors le message "Je suis une route, pas un fichier statique" sera affiché

Veuillez noter à ce propos qu'un fichier appelé "index.html" intercepte une route de type "/", comme c'est souvent le cas dans les server traditionnels. De plus, le server statique prend automatiquement en compte également les sous-dossiers, c'est-à-dire qu'une requête avec url "/images/image1.jpg" ira cherche le fichier image1.jpg dans le dossier __dirname + "/public/images" sans avoir à déclarer un autre middleware pour le sous-dossier spécifique.

• Voir la documentation sur le site officiel pour plus de détails sur express.static()

Synthèse

Grâce aux points précédents, nous pouvons illustrer maintenant les principales caractéristiques d’Express.js en s’appuyant sur certains éléments théoriques et techniques :

• Express.js est un module de Node.js construit « on top of » le module natif http. L’utilité principale d’Express.js consiste à fournir aux développeurs une structure de l’application qui facilite l’échange requête/réponse.
• La structure d’une application Express.js se compose principalement de deux éléments fondamentaux : les middlewares et les routes
• Les middleware :
  • sont tout simplement des fonctions qui sont exécutées de manière séquentielle selon leur position dans le code de l’application. La chaine de middleware s’arrête exclusivement lorsqu’un middleware envoie une réponse au client qui a fait la requête.
  • peuvent exécuter tout type d’opération. Ces opérations sont souvent en relation avec la requête (e.g. contrôler si la requête répond à certains conditions, comme par exemple si l’utilisateur dispose d’un cookie d’authentification), mais peuvent également être en lien avec d’autres éléments d’une application (e.g. interroger une base de données, écrire le contenu d’un fichier, etc.).
• Les routes :
  • représentent une forme de « middleware finale », car elle est censée renvoyer une réponse en fonction de l’url spécifié par la requête. Les routes peuvent donc être considérées comme des « sorties » du cycle de middleware une fois que la requête du client a été satisfaite.
  • définissent normalement des pages considérées "dynamiques", c'est-à-dire dont le contenu est créé en fonction de certains conditions ou en assemblant différentes sources de données, pas tout simplement des fichiers html statiques.

Workflow d'une application Express.js avec l'articulation entre middleware et routes

En conclusion, une application Express.js n'est qu'un ensemble de middleware et de routes. Par la suite, nous allons illustrer certains des éléments principaux d'Express.js qui facilitent l'articulation entre middleware et routes.

• Voir la documentation sur comment écrire un middleware sur le site officiel
• Voir la documentation sur comment utiliser un middleware sur le site officiel (avec exemples avancées)
• Voir la documentation sur les routes sur le site officiel

Les éléments principaux de Express.js

Cette section présente un aperçu des éléments principaux du framework. Il s’agit d’une adaptation par rapport à la documentation de l’API (version 4.x) disponible sur le site officiel dans la mesure où :

• Seulement certains des propriétés et méthodes seront illustrés, ceux qui ont le plus de probabilité d’être utilisé pour des débutant/novices
• Les aspects purement techniques d’utilisation des propriétés et méthodes seront implémentés par des explications théorique se référant à la section « Comprendre Express.js ».

Express.js se base sur les éléments principaux suivants :

1. L'application : l'ensemble de tous les éléments qui contribuent au fonctionnement global (i.e. la logique)
2. La requête : les informations envoyées par le client à l'application;
3. La réponse : les informations envoyées par l'application au client;
4. Le router : des "sous-système" de routes qui peuvent être ajoutées à l'application

L'application

L’application se traduit généralement par la variable var app = express(), c’est-à-dire un objet/fonction qui présente les propriétés et les méthodes principales pour créer une application web. Voici une liste non exhaustive des éléments principaux associé à l’objet app.

app.get()

Cette méthode permet d’intercepter une requête de type GET avec un path spécifique et d’y associer une fonction de callback qui, normalement, génère une réponse adaptée à la requête. Exemple :

app.get('/mypath', function (request, response) {
  res.send('GET request to http://localhost:3000/mypath');
});

app.post()

Cette méthode permet d'intercepter une requête de type POST avec un path spécifique et d'y associer une fonction de callback qui, normalement, gère les données qui ont été envoyée en POST (e.g. à travers un formulaire web). Pour le traitement de ces données on utilise souvent un module spécifique qui permet d’accéder facilement aux éléments de la requête POST (voir le module body-parser plus bas dans la section suivante). Exemple :

app.post('/submit', function (request, response) {
  res.send('POST request to http://localhost:3000/submit');
});

app.all()

Cette méthode permet d'intercepter tout type de requête HTTP (GET, POST, PUT, DELETE, ...) avec un path qui peut-être également de plus haut niveau par rapport à un route spécifique. Par exemple cette méthode applique un middleware myMiddleware() à toute route qui commence avec /admin/ (donc par exemple /admin/index.html, /admin/dashboard/, /admin/blog/new/) :

app.all('/admin/*', myMiddleware);

app.param()

Cette méthode permet d'exécuter un middleware pas sur la base d'une route spécifique ou de plus haut niveau, mais sur la base d'un paramètre dynamique contenu dans la requête. Un paramètre dynamique est associé à une route avec la notation :param comme par exemple dans la route GET suivante :

app.get('/students/profile/:student_id', function (request, response) {
  //On peut récupérer un paramètre à l'intérieur de l'array params associé à l'objet request
  var id = Number(request.params.student_id);
  //E.g. Chercher l'étudiant dans une base des données et afficher son nom, prénom, etc.
  //...
});
app.get('/students/grade/:student_id', function (request, response) {
  var id = Number(request.params.student_id);
  //E.g. Chercher l'étudiant dans une base des données et afficher son nom, prénom, etc. ainsi que ses notes, ...
});

Au lieu de récupérer le nom et le prénom de l’étudiant dans les deux routes spécifiques qui utilisent le paramètre student_id, on peut plutôt créer une sorte de « règle » selon laquelle à chaque fois qu’une route propose ce paramètre, il est très probable qu’on nécessite de ses informations. On peut donc créer un middleware basé directement sur le paramètre :

app.param('student_id', function (request, response, next) {
  console.log("J'ai besoin des informations sur l'étudiant");
  next();
});

À ce moment, si vous essayez d'accéder aux deux routes définies plus haut, le message à la console s'affichera dans les deux cas. Vous pouvez donc déplacer la recherche des informations sur l'étudiant à l'intérieur de ce middleware et les réutiliser ensuite dans toutes les routes qui prévoient le paramètre student_id.

app.use()

Cette méthode permet d'appliquer un middleware à un path spécifique de la requête. Si aucun path n’est spécifié, alors c’est comme si on l’appliquait au path « root » (i.e. /). Exemples :

myFirstMiddleware = function (request, response, next) {
  console.log("Middelware 1 has been called.";
  next();
}
mySecondMiddleware = function (request, response, next) {
  console.log("Middleware 2 has been called;
  next();
}
app.use(myFirstMiddleare);
app.use('/admin', mySecondMiddleware);

Le tableau suivant montre quel middleware va s'appliquer en fonction de 4 hypothétiques path :

Path	myFirstMiddleware	mySecondMiddleware
/	Oui	Non
/about/us.html	Oui	Non
/admin/	Oui	Oui
/admin/dashboard/create/user	Oui	Oui

app.listen()

Cette méthode s'applique normalement à la fin du fichier qui représente l'application car il s'agit de la méthode qui crée le server web. Il s'agit en effet d'une méthode qui fait appel au module http.createServer de Node.js, en lui passant la variable app (qu'on le rappelle, c'est une fonction de type express()) pour gérer le mécanisme requête/réponse du module http. La méthode accepte plusieurs arguments, en phase de test et développement en local il est bien de passer le nombre d'une porte supérieur à 3000 pour éviter des conflits avec d'autres portes utilisés par d'autres services sur votre ordinater. Exemple :

app.listen(3000);

Il est une bonne pratique de passer également une deuxième fonction avec tout simplement un console.log pour être sûr que le server web marche :

app.listen(3000, console.log("Server listening to http://localhost:3000"));

La requête

L’objet requête correspond à une « HTTP request » qui est faite par le client sur le server créé avec l’application express(). L’objet requête propose plusieurs propriétés et méthodes qui permettent d’évaluer de manière plus approfondie la requête par rapport à un server statique, où il y a tout simplement une équivalence entre l’URL d’accès et le path de la ressource statique. Avec Node.js/Express.js, la requête peut être analysée par rapport à d’autres informations qui permettent de la définir de manière à la fois plus spécifique et plus étendue. On peut par exemple discriminer la requête par rapport à :

• Des données qui sont envoyée dans le « body » de la requête telles que des données envoyées par un formulaire web
• Des cookies qui permettent d’identifier si l’utilisateur a fait le login sur une page
• L’adresse IP du client
• Le query string (e.g. des paramètres qui sont envoyé sous forme d’association clé/valeur comme dans l’url http://localhost:3000/students.html?order=lastname&sort=asc&limit=10)
• Etc.

Veuillez noter deux choses importantes à propos de l’objet requête en Express.js :

1. Dans cette page on fait référence à cet objet avec le nom request, tandis que souvent dans d’autres tutoriels et même dans la documentation officielle on utilise l’abréviation req. Vu que cet objet est passé en tant qu’argument dans les middleware de callback, en réalité son nom n’est pas important à condition d’être consistent dans le choix.
2. Avec la version 4.x certains éléments de la requête sont gérés par des modules externes qu’il faut importer (i.e. utiliser la fonction require()) pour qu’ils soient plus facilement accessibles à travers l’objet requête. C’est le cas notamment des données envoyées dans le body, les cookies, les fichiers à uploader, etc. Certains des modules les plus utiles dans ce cas seront brièvement abordés directement ici, mais une liste plus exhaustive est disponible plus bas dans la page.

Voici par la suite une liste des propriétés et des méthodes principales liées à l’objet requête.

request.path

Cette propriété permet d’accéder au path associé à une requête. Dans un server web statique, le path correspond au chemin d’une ressource par rapport au dossier « root » du server, ce qui est d’ailleurs également le cas pour le express.static() middleware présenté plus haut dans la page. Cependant, dans Express.js le path assume plutôt une valeur sémantique qui permet d’organiser les routes en fonction de ce qu’elles sont censées représenter, plutôt que leur position physique.

Dans l’addresse http://localhost:3000/users l’objet request.path coresspond à /users. On peut facilement déduire que cette objet est utilisé dans le cas de la méthode app.get() vue plus haut dans cette section. Cette méthode, en effet, ne fait que comparer la valeur de l’objet request.path avec la route proposée dans la méthode app.get(‘/users’, …). Si les deux correspondent, alors la fonction de callback sera exécutée et la réponse envoyé au client.

request.params

Cette propriété est associé à un objet qui contient les associations clé/valeur des paramètres dynamiques utilisés dans les routes. Un paramètre dynamique est une partie du path qui peut varier sans néanmoins changer la route qui va gérer la fonction de callback. Imaginons une route de ce type :

app.get('/places/:country/:region/:city', function (request, response) {
  var message = "Welcome to " + request.params.city + ", " + request.params.region + ", " + request.params.country "!!";
  response.send(message);
});

Une requête avec URL http://localhost:3000/places/switzerland/ticino/lugano/ produira un objet de ce type :

request.params = {
  country: 'switzerland',
  region: 'ticino',
  city: 'lugano'
}

La réponse sera donc "Welcome to lugano, ticino, switzerland!!". Avec un URL de type http://localhost:3000/places/italy/lombardia/milano/ la réponse sera plutôt "Welcome to milano, lombardia, italy!!". Dans les deux cas, la même route sera exécutée, même si les path diffèrent dans leur structure, parce qu'ils présentent la même structure paramètrique.

request.query

Cette propriété est similaire à la propriété request.path mais s'applique aux éléments du path qui se réfèrent au query string, c'est-à-dire l'association clé/valeurs qui peut être ajoutée à la fin d'un url sous cette forme :

http://localhost:3000/students/list.html?order=lastname&sort=asc&start=0&limit=20

Le query string commence après le caractère ? et chaque association clé/valeur et séparée par le caractère &. L'association se fait avec le symbole d'affectation = utilisé également dans JavaScript selon la notation key = value. Dans cet exemple de url, on aurait un objet query.string qui contient ces valeurs :

request.query = {
  order: "lastname",
  sort: "asc",
  start: 0,
  limit: 20
}

La différence entre paramètres et query string peut parfois être arbitraire. De manière générale, on utilise les paramètres lorsqu'on connait à l'avance le nombre spécifique d'informations variables qui seront transmises à travers l'url et lorsque les paramètres sont obligatoires. Le query string est par contre utile lorsque ce nombre n'est pas connu à l'avance ou peut varier. On pourrait très bien imaginer d'accèder à la page http://localhost:3000/students/list.html sans spécifier de paramètres et la page affichera automatiquement les premiers 20 étudiants triés par leur nom de famille.

request.body

Cette propriété est associée aux éléments qui sont passés dans le body d'une requête, par exemple à travers la méthode POST d'un formulaire HTML. À partir d'Express.js 4.x. cette propriété résulte undefined et il est nécessaire d'utiliser un middleware pour que les données passées à travers le body de la requête soit élaborées pour donner un objet comme dans le cas de request.path ou request.query. Il faut également noter à ce sujet que les données qu'on peut passer à travers le body peuvent être plus complexes et nombreuses, d'où l'intérêt d'utiliser un middleware qui prend en charge cette opération comme par exemple:

• Le module body-parser qui permet de gérer différents types de données dans le body (e.g. form, JSON, etc.)
• Le module multer qui permet de gérer les fichiers uploadés à travers un formulaire

Voir la section sur les modules/middleware utiles pour plus de détails.

request.cookie

Le même principe de request.body s'applique à la propriété request.cookie qui est undefined et nécessite également l'utilisation d'un module/middleware pour associer les cookies présents dans le client à l'objet de la requête.

• Le module cookie-parser, illustré également plus bas dans cette page, permet cette opération

La réponse

L’objet réponse correspond à une « HTTP response » que le server envoie au client qui a fait une requête à l’application express(). L’objet réponse possède plusieurs propriétés et méthodes qui permettent d’adapter les deux éléments principaux de la réponse : les headers (i.e. les entêtes) et le body (i.e. le contenu, très souvent du HTML).

Comme c’était le cas pour la requête qui est souvent abrégée en req dans les tutoriels et documentation officielle de Express.js, la réponse (i.e. response) figure souvent avec la notation res. Pour une question de clarté, cette page utilise le nom complet response, mais cela est seulement conventionnel.

Voici de suite une liste non exhaustive des propriétés et méthodes principales associées à la réponse.

response.send()

Cette méthode représente la manière la plus simple et flexible pour envoyer une réponse au client. Voici un exemple basilaire qui affiche simplement du HTML en réponse à une requête de type GET :

 app.get('/mypage.html', function (request, response) {
   response.send('<h1>Just html, please!</h1>');
 });

Lorsqu’on accède à cette page à travers un client, nous pouvons constater qu'elle possède automatiquement certaines informations dans les entêtes comme par exemple :

• Un status de 200
• Un Content-Length de 27
• Un Content-Type de type text/html avec charset de type utf8

Par contre, si on passe en tant qu’argument un Objet ou un Array JavaScript, la réponse sera automatiquement transformée en format JSON à la fois pour les entêtes et pour le contenu. Voici un exemple :

app.get('/my/stic-1/grade.json', function (request, response) {
  var grades = {
      ex1: "4.5",
      ex2: "4.75",
      ex3: "5.5"
  }
  response.send(grades);
});

Contrairement à l’exemple précédent, dans ce cas le Content-Type de la résponse sera application/json plutôt que text/html, et le contenu sera automatiquement affiché en tant que JSON :

{"ex1":"4.5","ex2":"4.75","ex3":"5.5"}

Pour envoyer du JSON il existe également une méthode spécifique response.json() qui marche pratiquement de la même manière, sauf quelques exceptions.

response.sendFile()

Cette méthode permet d'envoyer en résponse le contenu d'un fichier. Le fichier peut être une page HTML, mais également un fichier PDF ou autres types de format qui est généralement supporté par des navigateurs web. Exemple :

app.get("/", function (request, response) {
   //We use the sendFile method to serve a static HTML page
   //The method accepts the absolute path to the file, so we use the shortcut __dirname
   response.sendFile(__dirname + '/files/homepage.html');
});

L'intérêt de pouvoir renvoyer un fichier tel qu'il est, mais sans utiliser le middleware express.static(), peut concerner par exemple le contrôle sur un fichier PDF: si la requête présente certains caractéristiques (e.g. utilisateur a fait le login), alors le fichier sera disponible, autrement on peut afficher un message d'erreur. La méthode sendFile() accepte également des options, vous pouvez vous référez à la documentation officielle pour plus de détails.

response.redirect()

Cette méthode permet de rédiriger la requête vers une autre déstination qui peut être interne (e.g. une autre route) ou externe à l'application (e.g. un autre site). Exemples:

app.get("/internal", function (request, response) {
   response.redirect('/otherpage');
});
app.get("/external", function (request, response) {
   response.redirect('http://edutechwiki.unige.ch');
});

response.status()

Cette méthode permet de définir un code de status (e.g. 200, 404, etc.) pour la réponse. Il est utilisé souvent en combinaison avec la méthode response.send(). Par exemple :

app.get("/profile/:user", function (request, response) {
   //Si on ne trouve pas un utilisateur avec ce nom
   response.status(404).send("Cet utilisateur n'existe pas");
});

response.render()

Cette méthode est utilisée dans le cadre des "templates engines", c'est-à-dire des middlewares (voir plus bas dans cette page) qui permet de passer des données à ce qu'on appelle une "view". Chaque "template engine" possède sa propre syntaxe pour intégrer les données que la view reçoit depuis l'application, mais le fonctionnement est toujours très similaire. La fonction render() accepte généralement deux arguments :

1. La référence à la view qui va servir de template
2. Un objet avec associations clé/valeur des données à passer

Voici un exemple théorique, pour des exemples pratiques voir la section sur les middleswares utiles plus bas :

//WARNING : the code to include and use the template middleware is missing from this example
//Define some data that will be included in the templates
var notes = [
    {
        ex: 1,
        grade: 5.75
    }, {
        ex: 2,
        grade: 5.5
    }, {
        ex: 3,
        grade: 6
    }
];

//Define a route for the homepage that uses the homepage.ejs template
app.get("/", function (request, response) {
    //Use the response.render() method, which accepts the filename of the template and an array of data to pass to it
    //In this case we pass a variable with the cours name STIC I and the notes object defined above
    //These two variables will be accessible in the template
    response.render('homepage.ejs', {
        cours: "STIC I",
        notes: notes
    });
});

Dans la view homepage.ejs nous aurons accès aux variables "cours" et "notes" avec leur contenu respectif.

Le router

L'objet router permet de créer une application à l'intérieur d'une autre application Express.js, ce qui facilite notamment l'organisation du code et des routes. Un router est, encore une fois, un "simple" middleware et il est par conséquent possible d'ajouter un router à une autre application, en choisissant notamment le "mount" point (le path sur lequel le nouveau router va être ajouté aux routes de l'application sous-jacente). Voici un exemple :

var express = require('express');
//Création de l'application principale
var app = express();
//Création d'une "sous-application" avec un Router()
var admin = express.Router();

//Middlewares et routes pour l'app principale
function myAppMiddleware(request, response, next) {
    console.log("Middleware de l'app principale");
    next();
}
app.use(myAppMiddleware);

app.get("/", function (request, response) {
    response.send("Homepage");
});

//Middleware et routes pour la "sous-application"
function myAdminMiddleware(request, response, next) {
    console.log("Middleware de la sous-application");
    next();
}
admin.use(myAdminMiddleware);

admin.get("/", function (request, response) {
    response.send("Homepage Admin");
});

//On ajoute la sous-application à l'app principale avec un "mount point"
app.use("/admin", admin);

//Server
app.listen(3000, console.log("Server listening at port 3000"));

Notre application possède à ce point deux routes, qui sont cependant gérées par deux applications différentes :

• La homepage "/" est gérée par l'application principale var app = express();
• La page d'administration "/admin" est gérée par la sous-application/router var admin = express.Router();

Cette démarche est particulièrement pratique si on considère la possibilité de diviser une grande application en différents modules Node.js. De cette manière il est possible d'organiser le code, par exemple dans la perspective de partager le travail avec d'autres développeurs qui s'occupent de fonctionnalités spécifiques.

Modules/Middleware utiles

La philosophie d’Express.js est volontairement très minimaliste, ce qui se reflète principalement sur deux aspects reliés :

1. Le framework propose « out of the box » juste les éléments essentiels, mais dès que des fonctionnalités plus avancées sont nécessaires, il faut implémenter des éléments « externes » (parfois ces éléments faisaient partie de versions précédentes à la version 4, mais ont été enlevé justement en raison de cette philosophie) ;
2. Le développeur peut donc choisir quels éléments ajouter et parmi les éléments mêmes il a normalement le choix entre plusieurs modules qui proposent des fonctionnalités similaires mais avec des différences au niveau de la syntaxe, du fonctionnement interne, etc. Par exemple, Express.js ne propose aucun « template engine », mais le développeur peut choisir parmi une longue liste de possibilité selon ses préférences.

De suite nous proposons une liste non exhaustive de module qui peuvent être adoptés en tant que middleware.

Liens

• Site officiel du framework
• [API officielle de la version 4.x http://expressjs.com/en/4x/api.html]