Valibot 中联合类型校验的深度解析与最佳实践

Valibot 是一个强大的 TypeScript 校验库，在处理复杂数据结构时表现出色。本文将深入探讨 Valibot 中联合类型(union)校验的工作原理，特别是当联合类型包含嵌套对象结构时的特殊行为。

联合类型校验的基本原理

在 Valibot 中，v.union() 方法用于定义可以接受多种类型的校验规则。其内部工作机制如下：

1. 首先尝试匹配所有提供的选项
2. 如果没有选项完全匹配输入值，检查是否只有一个选项返回了类型匹配的输出
3. 如果有且仅有一个类型匹配的选项，返回该选项的校验错误
4. 否则，返回一个通用错误，并将所有收集到的子错误作为附加信息

这种设计确保了校验系统能够处理复杂的类型组合，同时提供尽可能精确的错误反馈。

嵌套对象校验的挑战

当联合类型中包含对象结构时，校验行为会变得更加复杂。考虑以下典型场景：

const SubSchema = v.object({
  a: v.number(),
  b: v.pipe(v.number(), v.picklist([1, 2, 3, 4])),
});

const Schema = v.object({
  value: v.union([v.literal(-1), SubSchema]),
});

在这种情况下，如果传入的 value 是一个对象但 b 属性值不在允许范围内，系统会返回一个通用类型错误而非具体的值错误。这是因为 Valibot 优先处理类型层面的校验，确保数据结构整体符合预期。

最佳实践方案

针对这种嵌套校验场景，Valibot 提供了几种优化方案：

方案一：使用自定义校验函数

const SubSchema = v.object({
  a: v.number(),
  b: v.pipe(
    v.number(),
    v.check(
      (input) => [1, 2, 3, 4].includes(input),
      (issue) => `Expected (1 | 2 | 3 | 4) but received ${issue.received}`,
    ),
  ),
});

这种方法直接明确定义了值的范围检查，能够生成更精确的错误信息。

方案二：使用范围验证（适用于连续数值）

const SubSchema = v.object({
  a: v.number(),
  b: v.pipe(v.number(), v.minValue(1), v.maxValue(4)),
});

对于连续的数值范围，这种方案更加简洁高效。

方案三：等待 values 验证器

Valibot 即将推出的 values 验证器将简化离散值的校验：

const SubSchema = v.object({
  a: v.number(),
  b: v.pipe(v.number(), v.values([1, 2, 3, 4])),
});

设计哲学与建议

Valibot 的这种校验行为体现了其设计哲学：

1. 类型安全优先：确保数据结构整体符合预期
2. 渐进式反馈：从类型层面到值层面的逐步细化
3. 可组合性：通过管道操作符组合多种校验规则

在实际开发中，建议：

1. 对于简单场景，优先使用内置验证器
2. 对于复杂业务规则，合理使用自定义校验函数
3. 注意错误信息的清晰度和对终端用户的友好性
4. 考虑使用 TypeScript 类型提示增强开发体验

通过理解 Valibot 的内部机制和这些最佳实践，开发者可以构建出既健壮又用户友好的数据校验系统。