express-validator 项目中的 Schema 验证指南

express-validator 项目中的 Schema 验证指南

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

什么是 Schema 验证？

Schema 验证是 express-validator 提供的一种基于对象结构的验证方式，它允许开发者以声明式的方法定义请求数据的验证规则和净化规则。与传统的链式调用验证方法相比，Schema 验证提供了更直观、更结构化的配置方式。

本质上，Schema 验证在底层仍然使用验证链(validation chains)实现，只是为开发者提供了另一种更简洁的接口选择。如果你更喜欢配置化的验证方式，而不是编写 JavaScript 函数，那么 Schema 验证将是你的理想选择。

Schema 的基本结构

Schema 是一个普通的 JavaScript 对象，通过 checkSchema() 函数进行加载。在这个对象中：

• 每个键(key)代表需要验证的字段名
• 对应的值(value)是该字段的验证规则配置

一个典型的 Schema 验证示例：

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

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

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

Schema 的高级特性

通配符支持

express-validator 支持使用通配符来验证嵌套对象或数组中的字段。这在处理复杂数据结构时特别有用。

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

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

这个例子会对 addresses 数组中的每个元素的 street 和 number 字段进行验证：

• 所有 street 字段不能为空
• 所有 number 字段必须是整数

验证选项配置

每个验证规则都可以通过 options 属性进行详细配置：

checkSchema({
  age: {
    isInt: {
      options: { min: 18, max: 99 },
      errorMessage: '年龄必须在18到99岁之间'
    }
  }
});

自定义错误消息

可以通过 errorMessage 属性为每个验证规则指定自定义错误消息：

checkSchema({
  email: {
    isEmail: {
      errorMessage: '请输入有效的电子邮件地址'
    }
  }
});

Schema 验证的优势

1. 可读性强：验证规则以结构化方式呈现，一目了然
2. 易于维护：集中管理所有验证规则，修改方便
3. 灵活性高：支持嵌套对象、数组等复杂数据结构的验证
4. 一致性：统一的配置方式，减少代码风格差异

实际应用建议

在实际项目中，建议将 Schema 验证规则单独存放在配置文件中，这样可以使路由处理逻辑更加清晰，也便于统一管理和复用验证规则。

例如，可以创建一个 validationSchemas.js 文件：

// validationSchemas.js
module.exports = {
  userRegistration: {
    username: {
      isEmail: true,
      errorMessage: '用户名必须是有效的电子邮件'
    },
    password: {
      isLength: {
        options: { min: 8 },
        errorMessage: '密码长度至少8个字符'
      }
    }
  },
  productCreation: {
    name: {
      notEmpty: true,
      errorMessage: '产品名称不能为空'
    },
    price: {
      isFloat: {
        options: { min: 0 },
        errorMessage: '价格必须是正数'
      }
    }
  }
};

然后在路由中使用：

const { checkSchema } = require('express-validator');
const schemas = require('./validationSchemas');

router.post('/register', checkSchema(schemas.userRegistration), (req, res) => {
  // 处理注册逻辑
});

这种组织方式使得验证逻辑与业务逻辑分离，大大提高了代码的可维护性。

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