Valibot 中自定义验证器的管道组合技巧

在 Valibot 这个强大的 TypeScript 验证库中，开发者经常需要创建自定义验证器来满足特定的业务需求。本文将深入探讨如何在 Valibot 中优雅地组合验证器管道，特别是解决自定义验证器与管道组合时遇到的常见问题。

管道组合的基本原理

Valibot 提供了 pipe 函数，允许开发者将多个验证器串联起来，形成一个验证管道。这种设计模式非常有用，因为它可以让我们将复杂的验证逻辑分解为多个小的、可复用的验证步骤。

import * as v from 'valibot';

const basicSchema = v.pipe(
  v.string(),
  v.minLength(5),
  v.maxLength(10)
);

自定义验证器的创建

当我们想要创建可复用的自定义验证器时，很自然地会想到将其封装为函数。例如，创建一个验证字符串长度的验证器：

const lengthValidator = (min: number, max: number) => v.pipe(
  v.string(),
  v.minLength(min),
  v.maxLength(max)
);

管道组合的限制

然而，当我们尝试将这样的自定义验证器与其他验证器组合时，会遇到一个关键限制：pipe 函数的第一个参数必须是一个基础模式（Schema），而不能是另一个管道或验证动作。

以下代码会导致错误：

// 错误的用法
const MySchema = v.object({
  someField: v.pipe(
    v.notEmpty(), // 这是一个动作，不是基础模式
    lengthValidator(1, 10)
  )
});

正确的解决方案

要解决这个问题，我们需要确保管道中的第一个验证器是一个基础模式。对于上面的例子，正确的做法是：

const MySchema = v.object({
  someField: v.pipe(
    v.string(), // 基础模式
    v.notEmpty(), // 动作
    lengthValidator(1, 10) // 自定义验证器
  )
});

替代方案：验证器数组展开

虽然上述方法可行，但有时我们可能希望保持自定义验证器内部的类型安全。这时可以考虑使用数组展开的方式：

const lengthValidator = (min: number, max: number) => [
  v.string(),
  v.minLength(min),
  v.maxLength(max)
];

const MySchema = v.object({
  someField: v.pipe(
    v.string(),
    ...lengthValidator(1, 10)
  )
});

这种方法的优点是保持了自定义验证器内部的类型安全，但缺点是牺牲了部分可读性。

最佳实践建议

1. 始终以基础模式开始管道：确保 pipe 的第一个参数是像 string()、number() 这样的基础模式。

2. 明确区分模式和动作：理解哪些函数返回模式，哪些返回动作，这对于正确组合验证器至关重要。

3. 考虑验证器的复用性：如果某个验证逻辑会在多个地方使用，将其封装为自定义验证器可以提高代码的可维护性。

4. 保持类型安全：TypeScript 的强大类型系统是 Valibot 的一大优势，确保自定义验证器不会破坏这一优势。

通过理解这些原则和技巧，开发者可以更有效地在 Valibot 中创建灵活且强大的验证逻辑，满足各种复杂的业务需求。