Valibot中使用variant实现跨字段条件验证

在表单验证和数据结构校验中，经常会遇到需要根据一个字段的值来验证另一个字段的情况。Valibot作为一款强大的TypeScript校验库，提供了variant方法来实现这种跨字段的条件验证。

跨字段验证的常见场景

在实际开发中，我们经常会遇到这样的业务逻辑：

• 当用户选择"保存到S3"选项时，必须填写S3配置信息
• 当选择"国际地址"时，必须填写国家字段
• 当勾选"接收通知"时，必须填写通知方式

这些场景都需要根据一个字段的值来决定另一个字段的校验规则。

Valibot的variant解决方案

Valibot提供了variant方法专门处理这类条件验证场景。variant方法允许我们根据某个字段的值来动态选择不同的校验规则。

基本用法

variant方法接收两个参数：

1. 用于判断的字段名
2. 一个对象，包含不同值对应的不同校验规则

实际案例解析

以文章开头提到的S3配置验证为例，我们可以这样实现：

import * as v from 'valibot';

const schema = v.variant('saveToS3', {
  true: v.object({
    saveToS3: v.literal(true),
    s3Config: v.object({
      bucket: v.string(),
      region: v.optional(v.string(), 'us-east-1'),
      key: v.optional(v.string()),
    }),
  }),
  false: v.object({
    saveToS3: v.literal(false),
    s3Config: v.optional(v.never()),
  }),
});

这个schema实现了以下逻辑：

1. 当saveToS3为true时，必须提供s3Config对象，且其中bucket字段为必填
2. 当saveToS3为false时，不允许提供s3Config配置

深入理解variant的工作原理

variant方法本质上是一个类型安全的条件分支验证器。它会：

1. 首先检查指定的判断字段
2. 根据该字段的值选择对应的校验规则
3. 应用选中的规则验证整个对象

这种设计确保了类型安全，TypeScript能够正确推断出不同条件下的对象类型。

进阶用法

处理枚举值

当判断字段是枚举类型时，可以为每个枚举值指定不同的验证规则：

v.variant('type', {
  email: v.object({ type: v.literal('email'), address: v.string([v.email()]) }),
  phone: v.object({ type: v.literal('phone'), number: v.string([v.minLength(10)]) })
})

嵌套variant

variant可以嵌套使用，处理更复杂的条件验证场景：

v.variant('userType', {
  admin: v.object({
    userType: v.literal('admin'),
    permissions: v.array(v.string()),
    department: v.variant('isManager', {
      true: v.object({ isManager: v.literal(true), teamSize: v.number() }),
      false: v.object({ isManager: v.literal(false) })
    })
  }),
  guest: v.object({
    userType: v.literal('guest'),
    expiryDate: v.string()
  })
})

最佳实践

1. 保持判断字段简单：尽量使用布尔值或简单枚举作为判断字段
2. 明确所有可能值：为判断字段的所有可能值提供验证规则
3. 类型安全优先：利用literal确保类型系统能正确推断
4. 合理处理可选字段：使用optional和never明确表达字段的存在性

常见问题解决方案

如何处理默认值？

可以在对象校验中使用optional配合默认值：

v.object({
  region: v.optional(v.string(), 'us-east-1')
})

如何验证互斥字段？

使用variant配合never：

v.variant('paymentMethod', {
  credit: v.object({
    paymentMethod: v.literal('credit'),
    cardNumber: v.string(),
    bankAccount: v.never()
  }),
  bank: v.object({
    paymentMethod: v.literal('bank'),
    bankAccount: v.string(),
    cardNumber: v.never()
  })
})

Valibot的variant方法为复杂的条件验证提供了优雅而类型安全的解决方案，能够满足各种业务场景下的校验需求。通过合理设计判断逻辑和验证规则，可以构建出既健壮又易于维护的校验系统。