Yup嵌套Schema中when条件验证的使用技巧

前言

Yup作为JavaScript生态中广泛使用的表单验证库，其强大的条件验证功能.when()方法为开发者提供了灵活的验证逻辑。本文将深入探讨在嵌套Schema结构中正确使用.when()方法的技术细节，帮助开发者避免常见陷阱。

嵌套Schema验证的核心问题

在Yup的验证体系中，Schema可以多层嵌套以匹配复杂的数据结构。当我们需要在嵌套对象内部实现字段间的条件验证时，.when()方法的行为可能会让开发者感到困惑。

典型场景分析

考虑一个产品规格表单，其中包含重量(weight)和尺寸(dimension)信息，而尺寸又包含宽度(width)、高度(height)和长度(length)三个子字段。业务需求是：当任一尺寸字段有值时，其他尺寸字段都必须填写。

错误实现方式

初学者可能会尝试以下写法：

Yup.object().shape({
  weight: Yup.number().nullable(),
  dimension: Yup.object().shape({
    width: Yup.number(),
    height: Yup.number()
      .when(['width', 'length'], {
        is: (width, length) => {
          return width || length;
        },
        then: (schema) => schema.required('This field is required'),
      }),
    length: Yup.number(),
  }),
})

这种写法的问题在于，在嵌套结构中直接使用同级字段名作为依赖项时，Yup可能无法正确解析上下文关系。

正确解决方案

实际上，Yup完全支持在嵌套Schema中使用.when()方法，关键在于正确指定字段路径：

Yup.object().shape({
  weight: Yup.number().nullable(),
  dimension: Yup.object().shape({
    width: Yup.number(),
    height: Yup.number()
      .when(['dimension.width', 'dimension.length'], {
        is: (width, length) => width || length,
        then: (schema) => schema.required('Height is required when width or length is provided'),
      }),
    length: Yup.number(),
  }),
})

或者更简洁的写法：

Yup.object().shape({
  weight: Yup.number().nullable(),
  dimension: Yup.object().shape({
    width: Yup.number(),
    height: Yup.number()
      .when(['$width', '$length'], {
        is: (width, length) => width || length,
        then: (schema) => schema.required(),
      }),
    length: Yup.number(),
  }),
})

技术原理剖析

Yup的.when()方法在嵌套结构中工作时，遵循以下规则：

1. 依赖字段的路径解析是基于当前Schema层级的相对路径
2. 可以使用完整路径(如'dimension.width')或特殊前缀'$'来引用同级字段
3. 条件函数(is)接收的参数顺序与依赖字段数组顺序一致

最佳实践建议

1. 对于简单嵌套，使用'$'前缀引用同级字段最为简洁
2. 对于深层嵌套，建议使用完整路径以确保准确性
3. 复杂的条件验证可以考虑拆分为多个.when()调用
4. 始终为条件验证提供清晰的错误信息

常见问题排查

当.when()条件不生效时，可以检查：

1. 依赖字段路径是否正确
2. 条件函数(is)的逻辑是否合理
3. 是否在正确的Schema层级上应用验证规则
4. 字段名拼写是否准确

总结

Yup的嵌套Schema验证功能强大而灵活，通过掌握.when()方法在嵌套结构中的正确使用方式，开发者可以构建出既严谨又用户友好的表单验证逻辑。理解Yup的路径解析机制是避免验证问题的关键所在。