Valibot 自定义验证器参数配置指南

概述

Valibot 是一个强大的 TypeScript 验证库，它允许开发者创建自定义验证器来满足特定的验证需求。本文将详细介绍如何正确配置自定义验证器的参数，特别是 expects 属性和 actionIssue 方法的用法。

自定义验证器结构

在 Valibot 中，自定义验证器需要返回一个符合 BaseValidation 接口的对象。这个对象包含几个关键属性：

1. async: 布尔值，指示验证器是否异步
2. message: 验证失败时的默认错误信息
3. expects: 描述验证器期望的输入类型
4. _parse: 包含实际验证逻辑的方法

expects 属性详解

expects 属性用于描述验证器期望接收的输入类型。虽然可以设置为 null，但最佳实践是提供有意义的类型描述：

expects: "UUID string with sequence"

这样当验证失败时，错误信息会更加清晰，帮助开发者快速定位问题。

actionIssue 方法参数

actionIssue 是 Valibot 提供的用于创建验证错误的方法。最新版本要求传入4-5个参数：

1. 验证器上下文 (this)
2. 验证器函数本身
3. 被验证的值
4. 期望的类型描述
5. (可选) 自定义错误信息

正确用法示例：

return actionIssue(this, validateUuidWithSequence, value, 'UUID');

验证器实现示例

以下是一个完整的 UUID 验证器实现：

import * as v from 'valibot';

function validateUuidWithSequence(): v.BaseValidation<string> {
  return {
    async: false,
    message: 'Invalid UUID with sequence',
    expects: 'UUID string with sequence',
    _parse(value: string) {
      if (value.length < 36) {
        return v.actionIssue(this, validateUuidWithSequence, value, 'UUID');
      }
      return v.actionOutput(value);
    },
  };
}

替代方案：使用 custom() 方法

对于简单的验证需求，Valibot 提供了 custom() 方法来简化自定义验证器的创建：

const uuidValidator = v.string([
  v.custom((value) => value.length >= 36, 'Invalid UUID')
]);

这种方式的优点是简洁，但缺点是错误信息较为单一，不如完整自定义验证器灵活。

最佳实践建议

1. 对于复杂验证逻辑，推荐使用完整自定义验证器
2. 始终为 expects 提供有意义的描述
3. 确保 actionIssue 参数完整
4. 简单验证可使用 custom() 方法简化代码
5. 保持验证逻辑的原子性，每个验证器只关注一个方面

通过遵循这些指导原则，您可以充分利用 Valibot 的强大功能，构建健壮且易于维护的数据验证逻辑。