首页
/ Valibot 项目中自定义验证器的最佳实践

Valibot 项目中自定义验证器的最佳实践

2025-05-30 07:39:21作者:姚月梅Lane

Valibot 是一个用于数据验证的 TypeScript 库,随着其 API 的演进,开发者需要了解如何高效地创建自定义验证器。本文将深入探讨在 Valibot 中创建自定义验证器的几种方法,并分析各自的优缺点。

自定义验证器的基本模式

在 Valibot 中,创建自定义验证器通常有两种主要方式:

  1. 简单函数形式:适用于不需要严格类型检查的场景
  2. 类型安全形式:提供完整的类型安全,但需要更多样板代码

简单函数实现

对于不需要严格类型检查的场景,可以采用简洁的函数形式:

function nonEmpty(message = "Non-empty value required.") {
  return minLength(1, message);
}

这种方式的优点是代码简洁,但缺点是类型信息不够完整,IDE 可能无法提供完善的类型提示。

类型安全实现

如果需要完整的类型安全,可以采用以下形式:

function nonEmpty<TInput extends LengthInput>(
  message: string = 'Non-empty value required.'
): MinLengthAction<TInput, 1, string> {
  return minLength(1, message);
}

这种方式提供了完整的类型信息,但需要更多的样板代码。

高级类型模式

对于需要更精确类型控制的场景,可以使用以下模式:

function nonEmpty<
  TInput extends LengthInput,
  const TMessage extends ErrorMessage<MinLengthIssue<TInput, 1>>,
>(
  message: TMessage = 'Non-empty value required.' as TMessage
): MinLengthAction<TInput, 1, TMessage> {
  return minLength(1, message);
}

这种模式:

  1. 保留了输入类型的泛型参数
  2. 精确控制了错误消息的类型
  3. 确保了返回类型与 minLength 操作完全匹配

组合验证器的实现

对于组合多个验证器的场景,如创建一个既检查数字类型又检查整数的验证器:

function integerNumber<TMessage extends ErrorMessage<NumberIssue>>(message?: TMessage) {
  return pipe(number(message), integer());
}

Valibot 核心团队指出,目前还没有完美的方法来完全代理原始验证器的类型签名(包括处理 undefined 消息的重载),因此在实际应用中需要根据具体需求权衡类型精确性和代码简洁性。

实践建议

  1. 评估需求:如果项目对类型安全要求不高,简单函数形式可能更合适
  2. 类型导出:Valibot 已导出常用输入类型(ContentInput、LengthInput 等),可直接使用
  3. 权衡取舍:在类型安全和代码简洁性之间找到平衡点
  4. 内置验证器:优先使用 Valibot 内置的验证器(如非空检查现已内置)

通过理解这些模式,开发者可以在 Valibot 项目中更高效地创建和维护自定义验证器,同时根据项目需求选择最适合的实现方式。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
197
2.17 K
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
208
285
pytorchpytorch
Ascend Extension for PyTorch
Python
59
94
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
974
574
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
9
1
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
549
81
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.02 K
399
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
393
27
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
1.2 K
133