Express-Validator 中 default 属性的正确使用方法

在 Express-Validator 库中，开发者经常需要对请求参数设置默认值，特别是在处理可选参数时。本文将详细介绍如何在 Express-Validator 的 checkSchema 方法中正确使用 default 属性。

常见错误用法

许多开发者会直接尝试在 schema 验证规则中这样设置默认值：

checkSchema({
  pageSize: {
    in: 'body',
    toInt: true,
    optional: true,
    default: 25,  // 这是错误的写法
    isInt: { options: { min: 1, max: 500 } },
    errorMessage: 'Invalid pageSize. Range is 1 to 500',
  },
})

这种写法会导致 TypeScript 类型检查错误，因为 Express-Validator 的 default 属性需要以特定格式设置。

正确设置方法

Express-Validator 要求 default 属性必须通过 options 对象来设置：

checkSchema({
  pageSize: {
    in: 'body',
    toInt: true,
    optional: true,
    default: { options: 25 },  // 正确的写法
    isInt: { options: { min: 1, max: 500 } },
    errorMessage: 'Invalid pageSize. Range is 1 to 500',
  },
})

工作原理

当请求中的 pageSize 参数为以下情况时：

• 空字符串 ('')
• null
• undefined
• NaN

Express-Validator 会自动将其替换为指定的默认值 25。这种机制特别适用于分页参数等场景，可以确保后续处理逻辑始终接收到有效的数值。

类型安全考虑

使用 TypeScript 时，正确的 options 格式不仅能通过类型检查，还能提供更好的代码提示和文档支持。这种设计也保持了 Express-Validator 配置项的一致性，因为其他验证规则（如 isInt）也采用类似的 options 对象结构。

实际应用场景

这种默认值设置方式在以下场景特别有用：

1. API 分页参数处理
2. 可选查询参数的默认值设置
3. 表单字段的默认值填充
4. 配置参数的默认值设定

通过正确使用 default 属性，开发者可以编写更健壮、更易维护的请求验证逻辑。