express-validator 命令式验证执行指南

express-validator 命令式验证执行指南

express-validator 项目地址: https://gitcode.com/gh_mirrors/exp/express-validator

前言

express-validator 是一个强大的 Express 中间件，用于处理请求数据的验证和清理。虽然它主要采用声明式的工作方式，但有时我们需要更灵活地控制验证流程。本文将深入探讨 express-validator 的命令式验证执行方式。

声明式 vs 命令式

express-validator 默认采用声明式验证方式，这种方式简洁明了：

app.post('/user', 
  body('email').isEmail(),
  body('password').isLength({ min: 6 }),
  (req, res) => { /* 处理逻辑 */ }
);

但有时我们需要更细粒度的控制，这时就可以使用命令式验证。

run() 方法详解

express-validator 提供了 run() 方法，允许我们手动执行验证链。这个方法可用于：

1. 验证链 (ValidationChain)
2. 清理链 (SanitizationChain)
3. checkSchema 创建的验证
4. oneOf 验证

基本用法

const result = await validationChain.run(req);

run() 方法返回一个 Promise，解析后会包含验证结果。

实际应用场景

场景一：标准化错误响应

我们可以创建可重用的验证中间件，统一处理错误响应：

const validate = (validations) => {
  return async (req, res, next) => {
    // 并行执行所有验证
    await Promise.all(validations.map(v => v.run(req)));
    
    const errors = validationResult(req);
    if (!errors.isEmpty()) {
      return res.status(400).json({ errors: errors.array() });
    }
    next();
  };
};

使用方式：

app.post('/register', validate([
  body('email').isEmail(),
  body('password').isLength({ min: 6 })
]), registerHandler);

场景二：顺序验证

有时我们需要按顺序执行验证，并在第一个验证失败时停止：

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

场景三：条件验证

当某些验证需要基于请求数据动态决定时：

app.post('/update', 
  body('email').isEmail(),
  async (req, res) => {
    // 只有密码存在时才验证确认密码
    if (req.body.password) {
      await body('passwordConfirmation')
        .equals(req.body.password)
        .withMessage('密码不匹配')
        .run(req);
    }
    
    // 处理验证结果
    const errors = validationResult(req);
    if (!errors.isEmpty()) {
      return res.status(400).json({ errors: errors.array() });
    }
    
    // 更新逻辑
  }
);

最佳实践

1. 错误处理：始终检查 validationResult 并适当处理错误
2. 性能考虑：并行验证通常比顺序验证更快
3. 代码组织：将常用验证逻辑封装为可重用中间件
4. 类型安全：在 TypeScript 项目中，明确指定 ValidationChain 类型

总结

express-validator 的命令式验证提供了更大的灵活性，适合需要精细控制验证流程的场景。通过 run() 方法，我们可以实现条件验证、自定义错误处理和验证流程控制等高级功能。

掌握命令式验证技巧，能让你的 Express 应用在数据验证方面更加灵活强大。

express-validator 项目地址: https://gitcode.com/gh_mirrors/exp/express-validator