Valibot 表单验证错误处理最佳实践

Valibot 是一个强大的 TypeScript 数据验证库，它提供了丰富的验证功能和类型安全。在实际应用中，正确处理验证错误对于构建健壮的表单系统至关重要。本文将深入探讨 Valibot 的错误处理机制，特别是针对表单验证场景的最佳实践。

表单验证错误处理模式

Valibot 提供了两种主要的错误处理方式：

1. try/catch 模式：使用 parse 方法配合 try/catch 捕获验证错误
2. 安全解析模式：使用 safeParse 方法返回包含验证结果的对象

try/catch 模式实现

import * as v from 'valibot';

const LoginSchema = v.object({
  email: v.pipe(v.string(), v.nonEmpty(), v.email()),
  password: v.pipe(v.string(), v.nonEmpty(), v.minLength(6)),
});

type LoginSchema = typeof LoginSchema;

let formErrors: Partial<Record<v.IssueDotPath<LoginSchema>, string>> = {};

const handleLogin = async (data: unknown) => {
  try {
    formErrors = {};
    const result = v.parse(LoginSchema, data);
    // 处理登录逻辑...
  } catch (error) {
    if (v.isValiError<LoginSchema>(error)) {
      const flatIssues = v.flatten<LoginSchema>(error.issues);
      for (const key in flatIssues.nested) {
        formErrors[key as v.IssueDotPath<LoginSchema>] = 
          flatIssues.nested[key as v.IssueDotPath<LoginSchema>]![0];
      }
    } else {
      throw error;
    }
  }
};

安全解析模式实现

const handleLogin = async (data: unknown) => {
  formErrors = {};
  const result = v.safeParse(LoginSchema, data);
  
  if (result.success) {
    // 处理登录逻辑...
  } else {
    const flatIssues = v.flatten<LoginSchema>(result.issues);
    for (const key in flatIssues.nested) {
      formErrors[key as v.IssueDotPath<LoginSchema>] = 
        flatIssues.nested[key as v.IssueDotPath<LoginSchema>]![0];
    }
  }
};

类型安全处理技巧

Valibot 提供了强大的类型系统支持，正确处理类型可以显著提高代码的健壮性：

1. Schema 类型与输入类型区别：

   • typeof Schema 表示整个 Schema 的类型信息
   • InferInput<typeof Schema> 仅表示 Schema 的输入类型

2. 错误路径类型：

   • 使用 IssueDotPath<Schema> 获取验证错误的路径类型
   • 这确保了错误处理时的类型安全

3. 多 Schema 验证处理： 当需要验证多个 Schema 时，可以组合类型：

try {
  const address = parse(Address, data);
  const vehicle = parse(Vehicle, data);
} catch (error) {
  if (isValiError<typeof Address | typeof Vehicle>(error)) {
    const flatIssues = flatten<typeof Address | typeof Vehicle>(error.issues);
    // 处理错误...
  }
  throw error;
}

实际应用建议

1. 表单错误状态管理：

   • 定义错误状态类型为 Partial<Record<IssueDotPath<Schema>, string>>
   • 使用 flatten 方法将验证错误转换为扁平结构

2. 错误消息提取：

   • 从 flatIssues.nested 中提取每个字段的第一个错误消息
   • 注意处理可能的 undefined 情况

3. UI 集成：

   • 将错误状态映射到表单字段的错误提示
   • 在提交前清空错误状态

Valibot 的错误处理机制结合 TypeScript 的类型系统，可以构建出既安全又易于维护的表单验证逻辑。根据项目需求选择合适的模式（try/catch 或 safeParse），并充分利用类型系统提供的安全保障，可以显著提高前端应用的健壮性。