Comment utiliser express-validator comme middleware dans Express App

Bonjour à tous, Dans cet article, nous apprendrons comment configurer le validateur express en tant que middleware, nous approfondirons également en détail le cas d'utilisation approprié des méthodes checkand body dans validateur express.
express-validator est une bibliothèque puissante pour valider et nettoyer les entrées dans les applications Express. Il fournit un ensemble robuste de fonctions de validation et de nettoyage qui peuvent être utilisées pour garantir que les données entrantes répondent à des exigences spécifiques. Cette documentation vous guidera dans la configuration du middleware de validation et illustrera les principales différences entre les méthodes check et body pour la validation.

Après avoir installé le validateur express, suivez les étapes ci-dessous

Configuration des règles de validation

Vous pouvez utiliser body() ou check() pour configurer les règles de validation.

• check() : un validateur flexible qui peut vérifier les données dans différentes parties d'une requête (telles que req.body, req.query et req.params).
• body() : un validateur plus ciblé qui se concentre spécifiquement sur la validation des données dans req.body.
• validationResult() : Pour récupérer et gérer les résultats de validation dans une fonction middleware.

Définir un middleware de validation

Pour rendre votre validation réutilisable et garder vos routes propres, définissez des règles de validation dans une fonction middleware. Voici un exemple de fonction middleware pour un itinéraire d'enregistrement d'utilisateur qui vérifie les champs d'e-mail et de mot de passe.

import { check, validationResult } from 'express-validator';

// DEFINE VALIDATION RULES
const validateRegistration = [
    check('email')
        .isEmail()
        .withMessage('Please enter a valid email address')
        .isLength({ max: 100 })
        .withMessage('Email cannot exceed 100 characters'),

    check('password')
        .isLength({ min: 6 })
        .withMessage('Password must be at least 6 characters long')
        .isLength({ max: 255 })
        .withMessage('Password cannot exceed 255 characters'),

    // CHECK FOR VALIDATION ERRORS
    (req, res, next) => {
        const errors = validationResult(req);
        if (!errors.isEmpty()) {
            return res.status(400).json({ errors: errors.array() });
        }
        // IF NO ERRORS, MOVE TO NEXT MIDDLEWARE
        next(); 
    }
];

Utiliser un middleware dans les routes

Après avoir défini votre middleware de validation, utilisez-le dans la route qui gère la requête entrante. Cela maintient la validation séparée de la logique de routage.

import express from 'express';
const app = express();

app.use(express.json());

app.post('/register', validateRegistration, (req, res) => {
    // USE YOUR REGISTRATIO LOGIC HERE
    res.status(201).json({ message: 'User registered successfully' });
});

app.listen(3000, () => {
    console.log('Server running on http://localhost:8080');
});

Comment ça marche

• Définissez les règles de validation : spécifiez les exigences de validation de chaque champ (telles que la longueur et le format) à l'aide de check() ou body().
• Vérifier les erreurs : utilisez validationResult() pour déterminer si des erreurs de validation existent. Si des erreurs sont détectées, elles sont renvoyées au client avec un code d'état 400.
• Continuer : si aucune erreur n'est trouvée, next() est appelé pour poursuivre la logique du gestionnaire de route ou passer au middleware suivant.

Désormais, toute demande de /register sera validée selon les règles de validateRegistration avant l'exécution de la logique d'enregistrement.

Comparaison détaillée : chèque vs corps

check() et body() sont des fonctions d'express-validator qui définissent des règles de validation pour les données entrantes. Cependant, ils diffèrent par l'endroit où ils recherchent les données dans la requête et par la manière dont elles sont généralement utilisées.

• vérifier()

1. Portée : validateur à usage général.
2. Zones de validation : peuvent vérifier les données dans plusieurs parties de la requête (telles que req.body, req.query, req.params).
3. Cas d'utilisation typiques : utile lorsque vous avez besoin de flexibilité, par exemple lorsqu'un champ peut être présent dans l'URL, la chaîne de requête ou le corps en fonction de la requête.

Exemple d'utilisation de check()

import { check, validationResult } from 'express-validator';

// DEFINE VALIDATION RULES
const validateRegistration = [
    check('email')
        .isEmail()
        .withMessage('Please enter a valid email address')
        .isLength({ max: 100 })
        .withMessage('Email cannot exceed 100 characters'),

    check('password')
        .isLength({ min: 6 })
        .withMessage('Password must be at least 6 characters long')
        .isLength({ max: 255 })
        .withMessage('Password cannot exceed 255 characters'),

    // CHECK FOR VALIDATION ERRORS
    (req, res, next) => {
        const errors = validationResult(req);
        if (!errors.isEmpty()) {
            return res.status(400).json({ errors: errors.array() });
        }
        // IF NO ERRORS, MOVE TO NEXT MIDDLEWARE
        next(); 
    }
];

Ici, check('email') recherchera le champ email dans toutes les parties de la requête, y compris req.body, req.query et req.params.

• corps()

1. Portée : cible spécifiquement req.body.
2. Zone de validation : examine uniquement le corps de la requête, ce qui la rend idéale pour les requêtes qui contiennent des données dans le corps (telles que les requêtes POST, PUT ou PATCH).
3. Cas d'utilisation typiques : préféré lors du traitement des soumissions de formulaires ou des charges utiles JSON, où vous savez que les données ne seront que dans le corps de la demande.

Exemple d'utilisation de body()

import express from 'express';
const app = express();

app.use(express.json());

app.post('/register', validateRegistration, (req, res) => {
    // USE YOUR REGISTRATIO LOGIC HERE
    res.status(201).json({ message: 'User registered successfully' });
});

app.listen(3000, () => {
    console.log('Server running on http://localhost:8080');
});

Ici, body('email') vérifiera uniquement le champ email dans req.body, donc il ne le détectera pas s'il se trouve dans req.query ou req.params.

Quand les utiliser

• check() : lorsque l'emplacement des données peut varier, comme dans un paramètre d'URL, une chaîne de requête ou un corps.
• body() : lorsque vous souhaitez uniquement valider les données dans req.body, ce qui est courant pour les API qui acceptent les données de formulaire ou les charges utiles JSON.

Exemple avec les deux
Vous pouvez utiliser à la fois check() et body() dans le même tableau de validation pour gérer les données de différentes parties de la requête.

import { check } from 'express-validator';

const validateEmail = [
    check('email')
        .isEmail()
        .withMessage('Invalid email address'),

    (req, res, next) => {
        const errors = validationResult(req);
        if (!errors.isEmpty()) {
            return res.status(400).json({ errors: errors.array() });
        }
        next();
    }
];

Dans cet exemple :
body('email') valide uniquement l'e-mail dans le corps de la demande.
check('token') recherche un jeton dans req.body, req.query et req.params.

Conclusion

L'utilisation du validateur express de cette manière maintient la validation propre, gérable et suffisamment flexible pour gérer une variété de formats et de sources d'entrée, contribuant ainsi à garantir l'intégrité et la sécurité des données dans votre application.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!