Joi pour JavaScript (Node.js) : guide complet avec exemples

Introduction à Joi : qu'est-ce que c'est et pourquoi l'utiliser

Joi est une bibliothèque puissante pour la validation de données dans l'environnement JavaScript (Node.js). Elle permet de décrire des schémas de données à l'aide d'une API simple et expressive, puis de vérifier la conformité d'objets réels à ces schémas. Joi est particulièrement populaire lors du développement de la partie serveur d'applications web, où il est nécessaire de valider les requêtes entrantes, les configurations, les données de formulaires et toute autre structure de données.

Les principales raisons d'utiliser Joi :

• Sécurité : empêche l'introduction de données incorrectes ou malveillantes dans votre application
• Lisibilité du code : les schémas Joi sont faciles à lire et à comprendre
• Flexibilité : prend en charge les structures imbriquées complexes, la validation conditionnelle et les règles personnalisées
• Intégration : fonctionne parfaitement avec Express, Koa, Fastify et d'autres frameworks
• Erreurs détaillées : fournit des messages d'erreur clairs avec l'indication précise de l'emplacement du problème

Installation de Joi

L'installation de Joi dans un projet Node.js se fait via npm ou yarn :

# Avec npm
npm install joi

# Avec yarn
yarn add joi

# Si vous utilisez TypeScript, installez les types (optionnel)
npm install @types/joi --save-dev

Après l'installation, vous pouvez importer Joi dans votre projet :

const Joi = require('joi');
// ou pour les modules ES :
// import Joi from 'joi';

Démarrage rapide : premier exemple de validation

Créons un schéma simple pour valider les données d'un utilisateur et testons-le :

const Joi = require('joi');

// Définition du schéma de validation
const schema = Joi.object({
    username: Joi.string()
        .alphanum()
        .min(3)
        .max(30)
        .required(),
    password: Joi.string()
        .pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')),
    email: Joi.string()
        .email({ minDomainSegments: 2, tlds: { allow: ['com', 'net'] } })
});

// Données à valider
const userData = {
    username: 'jean_dupont',
    password: 'monMotDePasse123',
    email: 'jean@exemple.com'
};

// Exécution de la validation
const { error, value } = schema.validate(userData);

if (error) {
    console.log('Erreur de validation :', error.details);
} else {
    console.log('Données valides :', value);
}

Dans cet exemple, nous avons créé un schéma pour un objet avec trois champs. La méthode validate() retourne un objet avec deux propriétés : error (si des erreurs existent) et value (les données validées).

Méthodes principales de Joi

1. Joi.string() — Validation des chaînes de caractères

Fonction : Crée un validateur pour les valeurs de type chaîne. Offre de nombreuses méthodes pour vérifier la longueur, le format, le contenu et d'autres caractéristiques de la chaîne.

Paramètres : Sans paramètres. Retourne un objet validateur auquel on peut appliquer une chaîne de méthodes.

Exemple :

const schema = Joi.string()
    .min(3)           // longueur minimale de 3 caractères
    .max(10)          // longueur maximale de 10 caractères
    .alphanum()       // uniquement lettres et chiffres
    .required();      // champ obligatoire

console.log(schema.validate('Bonjour'));    // { value: 'Bonjour' }
console.log(schema.validate('Salut'));       // { error: ... } - chaîne trop courte
console.log(schema.validate('Bonjour123')); // { value: 'Bonjour123' }
console.log(schema.validate('Bonjour!'));   // { error: ... } - contient des caractères spéciaux

2. Joi.number() — Validation des nombres

Fonction : Crée un validateur pour les valeurs numériques. Permet de vérifier la plage, le caractère entier, la positivité et d'autres propriétés des nombres.

Paramètres : Sans paramètres. Prend en charge une chaîne de méthodes pour la configuration.

Exemple :

const schema = Joi.number()
    .integer()       // uniquement les nombres entiers
    .min(0)