Yup 嵌套对象验证中defined属性的注意事项

在JavaScript数据验证库Yup中，当处理嵌套对象结构时，开发者经常会遇到一个常见的验证陷阱：即使父级对象被标记为notRequired，其内部标记为defined的子属性仍然可能导致意外的验证失败。

问题场景分析

考虑以下TypeScript类型定义：

type ObjectType = {
    property: string;
} | null | undefined

开发者期望使用Yup来验证符合这种类型的数据结构。在Yup中，通常会这样定义schema：

const schema = yup.object({
  parent: yup.object({
    child: yup.string().defined()
  }).notRequired()
});

直觉上，我们会认为当parent为undefined时，不应该验证其内部的child属性。然而实际上，Yup在这种情况下仍然会检查child属性是否已定义，导致验证失败。

技术原理探究

Yup的这种行为源于其验证机制的设计特点：

1. 深度验证策略：Yup默认会对整个对象树进行验证，包括所有嵌套层级
2. defined验证的严格性：.defined()验证器会检查值是否为undefined，即使父对象不存在
3. notRequired的局限性：.notRequired()仅表示字段可以缺失，不影响已定义字段的验证规则

解决方案与实践建议

针对这一问题，开发者可以采用以下几种解决方案：

方案1：使用nullable()和optional()组合

const schema = yup.object({
  parent: yup.object({
    child: yup.string().defined()
  }).nullable().optional()
});

方案2：条件验证

const schema = yup.object({
  parent: yup.object().when('parent', {
    is: (value) => value !== undefined,
    then: (schema) => schema.shape({
      child: yup.string().defined()
    }),
    otherwise: (schema) => schema
  })
});

方案3：自定义验证逻辑

const schema = yup.object({
  parent: yup.mixed().test({
    name: 'optional-object',
    message: '${path} must be an object when defined',
    test: (value) => {
      if (value === undefined || value === null) return true;
      return yup.object({
        child: yup.string().defined()
      }).isValidSync(value);
    }
  })
});

最佳实践总结

1. 明确区分nullable()、optional()和notRequired()的使用场景
2. 对于复杂的嵌套结构，考虑使用条件验证或自定义验证函数
3. 在定义schema时，始终考虑边界情况（null、undefined、空对象等）
4. 编写单元测试覆盖各种可能的输入情况

理解Yup的这些验证行为特点，可以帮助开发者构建更健壮的数据验证逻辑，避免在生产环境中出现意外的验证失败。