Express-Validator 手动执行验证指南

Express-Validator 手动执行验证指南

express-validator An express.js middleware for validator.js. 项目地址: https://gitcode.com/gh_mirrors/ex/express-validator

前言

Express-Validator 作为 Express 中间件的验证库，通常推荐以声明式的方式在路由处理器中使用验证链。但在某些复杂场景下，开发者可能需要更灵活地控制验证流程。本文将深入探讨如何手动执行 Express-Validator 的验证逻辑。

理解 ContextRunner 接口

Express-Validator 的核心验证功能都实现了 ContextRunner 接口，这包括：

• 验证链 (ValidationChain)
• checkExact() 方法
• checkSchema() 方法
• oneOf() 方法

这个接口提供了 run() 方法，允许我们手动触发验证流程。

自定义验证执行器

基本实现

我们可以创建一个可复用的验证执行器中间件，它能够：

1. 顺序执行验证链
2. 遇到第一个验证失败时立即终止
3. 自动处理错误响应

const { validationResult } = require('express-validator');

const validate = (validations) => {
  return async (req, res, next) => {
    for (const validation of validations) {
      const result = await validation.run(req);
      if (!result.isEmpty()) {
        return res.status(400).json({ errors: result.array() });
      }
    }
    next();
  };
};

TypeScript 实现

import { body, validationResult, ContextRunner } from 'express-validator';

const validate = (validations: ContextRunner[]) => {
  return async (req: Request, res: Response, next: NextFunction) => {
    for (const validation of validations) {
      const result = await validation.run(req);
      if (!result.isEmpty()) {
        return res.status(400).json({ errors: result.array() });
      }
    }
    next();
  };
};

使用示例

app.post('/signup', validate([
  body('email').isEmail(),
  body('password').isLength({ min: 6 })
]), async (req, res) => {
  // 此处请求已通过所有验证
  const user = await User.create(req.body);
  res.json(user);
});

条件验证场景

有时我们需要根据请求数据动态决定是否执行某些验证：

app.post('/update-settings',
  body('email').isEmail(),
  body('password').optional().isLength({ min: 6 }),
  async (req, res) => {
    const { password } = matchedData(req);
    if (password) {
      await body('passwordConfirmation')
        .equals(password)
        .withMessage('密码不匹配')
        .run(req);
    }

    // 检查验证错误并更新用户设置
    const errors = validationResult(req);
    if (!errors.isEmpty()) {
      return res.status(400).json({ errors: errors.array() });
    }
    
    // 处理业务逻辑
  }
);

最佳实践建议

1. 优先使用声明式验证：在大多数情况下，使用标准的验证链方式更简洁可靠
2. 考虑使用 .if() 方法：对于条件验证，validationChain.if() 通常是更好的选择
3. 错误处理一致性：确保手动验证的错误处理方式与自动验证保持一致
4. 性能考量：顺序验证在遇到错误时立即返回，可以提高性能

总结

手动执行验证为 Express-Validator 提供了额外的灵活性，特别适合以下场景：

• 需要自定义验证流程控制
• 实现复杂的条件验证逻辑
• 在非标准路由处理器中集成验证

通过理解 ContextRunner 接口和 run() 方法的工作原理，开发者可以更灵活地构建健壮的验证系统，同时保持代码的可维护性。

express-validator An express.js middleware for validator.js. 项目地址: https://gitcode.com/gh_mirrors/ex/express-validator