Valibot 中实现异步验证时自定义错误消息的方法

Valibot 是一个强大的 TypeScript 数据验证库，它提供了灵活的方式来验证数据结构。在实际开发中，我们经常需要结合异步操作进行验证，比如调用 API 验证手机号等场景。本文将介绍如何在 Valibot 中实现异步验证并返回自定义错误消息。

异步验证的常见需求

在表单验证等场景中，开发者经常需要：

1. 先验证基本格式（如非空、数字格式等）
2. 然后调用 API 进行业务逻辑验证（如手机号是否已注册）
3. 当 API 返回错误时，使用服务端提供的错误消息

基础方案：checkAsync 的局限性

Valibot 提供了 checkAsync 方法用于异步验证，但它只能返回布尔值来表示验证是否通过。当我们需要使用 API 返回的具体错误消息时，这种方法就显得不够灵活。

高级方案：使用 rawCheckAsync

Valibot 提供了更底层的 rawCheckAsync 方法，它允许开发者完全控制验证流程：

import * as v from 'valibot';

const Schema = v.pipeAsync(
  v.object({
    dialCode: v.pipe(
      v.string(),
      v.nonEmpty('Dial code is required'),
      v.decimal('Dial code should be a number')
    ),
    phoneNumber: v.pipe(v.string(), v.nonEmpty('Phone number is required')),
    countryCode: v.optional(v.string()),
  }),
  v.rawCheckAsync(async ({ dataset, addIssue }) => {
    if (dataset.typed) {
      const response = await fetch('...', { body: dataset.value });
      if (!response.ok) {
        addIssue({ message: await response.text() });
      }
    }
  })
);

rawCheckAsync 的核心优势

1. 完全控制验证流程：可以访问完整的验证上下文
2. 灵活添加问题：通过 addIssue 方法可以添加任意数量的验证问题
3. 支持自定义消息：可以直接使用 API 返回的错误消息
4. 类型安全：通过 dataset.typed 可以确保只在类型正确的数据上执行验证

实际应用建议

1. 错误处理：建议在 API 调用周围添加 try-catch 块，处理网络错误等异常情况
2. 性能优化：对于频繁触发的验证（如表单输入时），考虑添加防抖逻辑
3. 消息本地化：可以在 addIssue 前对 API 返回的消息进行本地化处理

通过使用 rawCheckAsync，开发者可以构建出既强大又灵活的数据验证流程，满足各种复杂的业务需求。