Construire et comprendre le middleware Express à travers des exemples

Si vous avez fait un développement Node significatif au cours des sept ou huit dernières années, vous avez probablement utilisé Express pour construire un serveur web à un moment donné. Bien que vous puissiez créer un serveur dans Node sans utiliser de bibliothèque, cela ne vous donne pas beaucoup de choses hors de la boîte et peut être assez lourd pour ajouter des fonctionnalités. Express est une bibliothèque de serveur minimaliste, « sans opinion », et est devenue la norme de facto pour la création d’applications Web dans Node. Pour comprendre Express, vous devez comprendre Express Middleware.

Qu’est-ce que Express Middleware?

Middleware signifie littéralement tout ce que vous mettez au milieu d’une couche du logiciel et d’une autre. Les intergiciels Express sont des fonctions qui s’exécutent pendant le cycle de vie d’une requête au serveur Express. Chaque intergiciel a accès au HTTP request et response pour chaque route (ou chemin) à laquelle il est attaché. En fait, Express lui-même est entièrement composé de fonctions d’intergiciel. En outre, l’intergiciel peut soit mettre fin à la requête HTTP, soit la transmettre à une autre fonction intergicielle à l’aide de next (nous y reviendrons bientôt). Ce  » chaînage  » d’intergiciels vous permet de compartimenter votre code et de créer des intergiciels réutilisables.

Dans cet article, j’expliquerai ce qu’est un intergiciel, pourquoi vous l’utiliseriez, comment utiliser les intergiciels Express existants et comment écrire votre propre intergiciel pour Express.

Requêtes pour écrire un intergiciel Express

Il y a quelques choses que vous devrez installer pour créer, utiliser et tester les intergiciels Express. Tout d’abord, vous aurez besoin de Node et de NPM. Pour vous assurer que vous les avez installés, vous pouvez exécuter:

npm -v && node -v

Vous devriez voir les versions de Node et NPM que vous avez installées. Si vous obtenez une erreur, vous devez installer Node. J’utilise la dernière version des deux au moment de cet article, à savoir Node 10.9.0 et NPM 6.4.1, mais tous les exemples devraient fonctionner avec les versions 8+ de Node et les versions 5+ de NPM.

J’utiliserai également la version 4.x d’Express. C’est important car des changements majeurs ont été apportés de la version 3.x à la 4.x.

Il sera également utile d’avoir Postman installé pour tester les routes utilisant tout verbe HTTP autre que GET.

Moyen logiciel Express : Les bases

Pour commencer, vous allez utiliser le plus basique des intergiciels intégrés d’Express. Cela vous donnera l’occasion de voir comment les intergiciels sont utilisés et comment les intergiciels Express sont structurés.

Créer un nouveau projet et npm init le…

npm initnpm install express --save

Créer server.js et coller le code suivant :

const express = require('express');const app = express();app.get('/', (req, res, next) => { res.send('Welcome Home');});app.listen(3000);

Lancer le serveur via node server.js, accéder à http://localhost:3000, et vous devriez voir s’imprimer « Welcome Home » dans votre navigateur.

La fonction app.get() est un intergiciel de niveau application. Vous remarquerez que les paramètres passés à la méthode sont reqres, et next. Il s’agit de la requête entrante, de la réponse en cours d’écriture, et d’une méthode à appeler pour passer l’appel à la fonction middleware suivante une fois que le middleware actuel est terminé. Dans ce cas, une fois la réponse envoyée, la fonction se termine. Vous pourriez également enchaîner d’autres intergiciels ici en appelant la méthode next().

Regardons quelques autres exemples des différents types d’intergiciels.

Express Exemple d’intergiciel de journalisation des requêtes

Dans Express, vous pouvez configurer un intergiciel pour qu’il soit un intergiciel  » global  » ; ce qui signifie qu’il sera appelé pour chaque requête entrante.

Changez le contenu de server.js en :

const express = require('express');const app = express();app.use((req, res, next) => { console.log(req); next();});app.get('/', (req, res, next) => { res.send('Welcome Home');});app.listen(3000);

const express = require('express');const app = express();const requireJsonContent = () => { return (req, res, next) => { if (req.headers !== 'application/json') { res.status(400).send('Server requires application/json') } else { next() } }}app.get('/', (req, res, next) => { res.send('Welcome Home');});app.post('/', requireJsonContent(), (req, res, next) => { res.send('You sent JSON');})app.listen(3000);

node server.js

npm install @okta/[email protected] --save

const oidc = new ExpressOIDC({ issuer: 'https://{yourOktaDomain}/oauth2/default', client_id: '{yourClientId}', client_secret: '{yourClientSecret}', redirect_uri: 'http://localhost:3000/authorization-code/callback', scope: 'openid profile'});

app.use(oidc.router);

app.get('/protected', oidc.ensureAuthenticated(), (req, res) => { res.send('Top Secret');});

app.use((err, req, res, next) => { // middleware functionality here})

app.get('/my-other-thing', (req, res, next) => { next(new Error('I am passing you an error!'));});app.use((err, req, res, next) => { console.log(err); if(!res.headersSent){ res.status(500).send(err.message); }});

app.get('/nonexistant', (req, res, next) => { let err = new Error('I couldn\'t find it.'); err.httpStatusCode = 404; next(err);});app.get('/problematic', (req, res, next) => { let err = new Error('I\'m sorry, you can\'t do that, Dave.'); err.httpStatusCode = 304; next(err);});// handles not found errorsapp.use((err, req, res, next) => { if (err.httpStatusCode === 404) { res.status(400).render('NotFound'); } next(err);});// handles unauthorized errorsapp.use((err, req, res, next) => { if(err.httpStatusCode === 304){ res.status(304).render('Unauthorized'); } next(err);})// catch allapp.use((err, req, res, next) => { console.log(err); if (!res.headersSent) { res.status(err.httpStatusCode || 500).render('UnknownError'); }});