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

在使用Express-Validator进行表单验证时，开发者经常会遇到需要为可选字段设置默认值的情况。本文将通过一个典型场景，详细介绍如何在Express-Validator的checkSchema方法中正确使用default属性。

问题背景

在表单验证中，我们经常需要处理可选字段。当这些字段未被提供时，为其设置合理的默认值是一种常见的做法。例如，在分页查询中，如果用户没有指定每页显示数量，我们通常会设置一个默认值如25。

常见误区

许多开发者会直接尝试以下写法：

checkSchema({
  pageSize: {
    in: 'body',
    toInt: true,
    optional: true,
    default: 25,  // 这种写法是错误的
    isInt: { options: { min: 1, max: 500 } },
    errorMessage: '无效的pageSize，范围应为1到500'
  }
})

这种写法会导致TypeScript类型错误，因为Express-Validator的checkSchema方法不接受直接的default属性。

正确用法

正确的做法是将default值作为validator的选项传递：

checkSchema({
  pageSize: {
    in: 'body',
    toInt: true,
    optional: true,
    isInt: { 
      options: { 
        min: 1, 
        max: 500,
        default: 25  // 正确的default值设置位置
      } 
    },
    errorMessage: '无效的pageSize，范围应为1到500'
  }
})

工作原理

当请求中的pageSize字段为空(null/undefined)或无法转换为整数时，Express-Validator会自动使用25作为默认值。这个默认值会在后续的验证流程中被使用，包括类型转换和范围验证。

最佳实践

1. 明确区分可选字段和默认值：optional: true表示字段可以不存在，而default则指定当字段不存在时的替代值。

2. 类型一致性：确保default值的类型与验证器期望的类型一致。例如，如果使用了toInt转换，default值应该是数字而非字符串。

3. 验证顺序：default值会在验证前被应用，因此可以确保后续验证器处理的是有效的值。

4. 文档查阅：当不确定某个功能的用法时，查阅官方文档是避免错误的最佳方式。

总结

在Express-Validator中设置默认值时，必须将其作为验证器选项的一部分，而不是直接作为schema的属性。这种设计保持了API的一致性，同时也提供了更灵活的配置方式。理解这一点可以避免类型错误，并确保验证逻辑按预期工作。