express-validator 7.0.0 架构验证指南：使用Schema进行声明式验证

express-validator 7.0.0 架构验证指南：使用Schema进行声明式验证

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

什么是Schema验证？

在express-validator中，Schema验证是一种基于对象的验证和净化请求数据的方式。它提供与传统验证链完全相同的功能——实际上，在底层实现中，express-validator完全使用验证链来处理Schema验证！

Schema验证特别适合那些希望采用更声明式编程风格的开发者。如果你不喜欢使用JavaScript函数来定义验证规则，而是倾向于通过配置对象来描述验证逻辑，那么Schema验证将是你的理想选择。

Schema验证的优势

1. 更清晰的代码结构：验证规则以结构化对象形式呈现，便于阅读和维护
2. 更好的可复用性：Schema对象可以轻松地在不同路由间共享
3. 更直观的配置：每个字段的验证规则集中在一个地方，一目了然
4. 与验证链等效的功能：不会因为使用Schema而损失任何功能

如何定义Schema

Schema是一个普通的JavaScript对象，通过checkSchema()函数传递给express-validator。对象的键表示要验证的字段，值则是该字段的验证规则。

每个字段的验证规则对象可以包含：

• 验证器（如isEmail、isLength等）
• 净化器（如trim、escape等）
• 错误消息
• 其他配置选项

基础示例

checkSchema({
  username: {
    errorMessage: '用户名格式不正确',
    isEmail: true,
  },
  password: {
    isLength: {
      options: { min: 8 },
      errorMessage: '密码长度至少为8个字符',
    },
  },
});

在这个例子中，我们定义了两个字段的验证规则：

1. username字段必须是有效的电子邮件格式
2. password字段长度至少为8个字符

高级字段选择

express-validator的Schema验证支持通配符和globstar语法，用于处理嵌套对象或数组中的字段验证。

需要注意的是，在JavaScript中，*字符不能直接作为对象键使用，必须用引号包裹：

checkSchema({
  'addresses.*.street': {
    notEmpty: true,
  },
  'addresses.*.number': {
    isInt: true,
  },
});

这个例子展示了如何验证一个包含多个地址的数组，确保每个地址的street字段不为空，number字段是整数。

Schema验证的常见配置选项

1. errorMessage：自定义错误消息
2. options：验证器的配置选项
3. bail：在第一个验证失败后停止执行后续验证
4. if：条件验证，只在特定条件下执行验证
5. custom：自定义验证函数

最佳实践

1. 保持Schema简洁：避免在一个Schema中定义过多的验证规则
2. 复用Schema：将常用的验证Schema提取为模块
3. 合理使用错误消息：提供清晰、友好的错误提示
4. 结合类型检查：在验证前确保字段存在且类型正确
5. 分层验证：将基础验证和业务逻辑验证分开

总结

express-validator的Schema验证提供了一种声明式、结构化的方式来定义请求数据的验证规则。它不仅保持了与验证链相同的功能完整性，还通过更直观的对象结构提高了代码的可读性和可维护性。无论是简单的表单验证还是复杂的嵌套对象验证，Schema验证都能优雅地处理。

对于追求代码整洁和可维护性的项目，Schema验证无疑是一个值得考虑的选择。它特别适合中大型项目，或者需要频繁修改验证规则的场景。

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