Valibot 中嵌套变体验证的实现与思考

Valibot 是一个强大的 TypeScript 数据验证库，最近在 GitHub 上有一个关于嵌套变体(variant)验证的有趣讨论。本文将深入分析这个问题及其解决方案，帮助开发者更好地理解 Valibot 的变体验证机制。

问题背景

在 Valibot 中，variant 方法允许开发者基于一个判别字段(discriminator)来验证不同的数据结构。然而，当开发者尝试嵌套使用多个 variant 时，遇到了验证逻辑上的问题。

考虑以下典型场景：

const Schema = v.variant('type', [
  v.variant('subType', [
    v.object({ type: 'yes', subType: 'yes', test1: v.string() }),
    v.object({ type: 'yes', subType: 'no', test2: v.string() })
  ]),
  v.variant('subType', [
    v.object({ type: 'no', subType: 'yes', test3: v.string() }),
    v.object({ type: 'no', subType: 'no', test4: v.string() })
  ])
]);

当输入数据无效时，验证器总是进入第一个子变体进行检查，而忽略了外层判别字段(type)的值，这显然不符合预期行为。

技术分析

问题的根源在于 Valibot 当前实现中，嵌套的 variant 会忽略外层的判别字段。具体来说：

1. 当前行为：验证器会顺序检查每个子 variant，而不管外层判别字段是否匹配
2. 预期行为：应该先根据外层判别字段过滤可能的子 variant，然后再进行验证

解决方案探讨

Valibot 维护者提出了两种可能的解决方案：

1. 递归检查过滤：让外层 variant 先验证判别字段，然后只对匹配的子 variant 进行进一步验证
2. 多判别字段支持：引入类似 v.multiVariant(['type', 'subType'], [...]) 的语法

经过讨论，第一种方案被确定为更优解，因为它：

• 保持了 API 的简洁性
• 提供了更大的灵活性
• 更符合 Valibot 的整体设计哲学

错误处理策略

对于复杂的嵌套变体验证，错误处理也是一个重要考量。考虑以下情况：

const result = v.safeParse(Schema, { type: 'A' });

当多个子判别字段都无效时，有两种错误报告方式：

1. 简单模式：只报告第一个无效的子判别字段
2. 详细模式：返回一个总错误，包含所有无效子判别字段的详细信息

最终 Valibot 选择了简单模式，因为：

• 实现更简单
• 对用户更友好
• 实际应用中，用户应避免这种模糊情况

实际应用建议

对于需要在表单等场景中使用复杂变体验证的开发者，建议：

1. 合理设计数据结构：确保每个判别字段组合都能唯一确定一个变体
2. 避免过度嵌套：过深的变体嵌套会增加复杂度和维护成本
3. 考虑使用联合类型：对于简单场景，union 可能是更直接的选择

总结

Valibot 通过改进嵌套 variant 的验证逻辑，解决了复杂变体验证的问题。这一改进使得开发者能够更灵活地构建复杂的数据验证规则，同时保持了库的易用性和一致性。理解这一机制有助于开发者在实际项目中构建更健壮的数据验证层。