首页
/ Valibot 库中实现运行时自定义错误消息的最佳实践

Valibot 库中实现运行时自定义错误消息的最佳实践

2025-05-30 23:45:13作者:乔或婵

在表单验证和数据校验场景中,开发者经常需要根据运行时数据动态生成错误提示信息。Valibot 作为一款类型安全的 TypeScript 验证库,提供了多种灵活的方式来实现这一需求。

基础方案:函数式错误消息

最简单的动态消息生成方式是通过函数参数传递:

const Schema = v.string((issue) => `预期类型: ${issue.expected}`);

这种方式适用于简单的类型校验场景,但当错误消息需要基于复杂验证逻辑时,就会显得力不从心。

进阶方案:check 与 refine 结合

对于需要基于验证上下文生成消息的情况,Valibot 提供了更强大的组合方案:

const Schema = v.pipe(
  v.string(),
  v.check(
    ([c1, c2, c3]) => c1 !== 'f' || c2 == c3,
    ({ input: [c1, c2, c3] }) =>
      `首字母为"${c1}"时,后续两个字符"${c2}"和"${c3}"必须相同`
  )
);

这种模式将验证逻辑和消息生成紧密耦合,避免了重复代码,同时保持了良好的可读性。

高级方案:rawCheck 完全控制

对于最复杂的验证场景,Valibot 提供了底层的 rawCheck API:

const schema = v.pipe(v.string(), v.rawCheck(({ dataset, addIssue }) => {
  if (dataset.typed) {
    const [c1, c2, c3] = dataset.value
    if (c1 === "f" && c2 !== c3) {
      addIssue({ 
        message: `首字母为"${c1}"时,第二和第三个字符"${c2}"与"${c3}"应当相同`
      })
    }
  }
}))

rawCheck 提供了对验证流程的完全控制,包括:

  1. 访问原始输入数据
  2. 手动添加验证问题
  3. 处理类型化/非类型化数据场景

设计原理与最佳实践

Valibot 采用分层设计理念,从简单到复杂提供了不同层级的 API:

  1. 声明式验证:适合简单场景,使用预设错误消息
  2. 函数式消息:适合需要简单动态消息的场景
  3. check + 消息生成器:适合中等复杂度的条件验证
  4. rawCheck:适合需要完全控制验证流程的复杂场景

在实际项目中,建议根据场景复杂度选择合适的方案。对于表单验证等常见场景,check 组合方案通常是最佳选择;而对于需要处理多种边界条件的核心业务验证,则可以考虑使用 rawCheck。

Valibot 的这种设计既保证了简单场景的易用性,又为复杂场景提供了足够的灵活性,是 TypeScript 生态中数据验证的优秀解决方案。

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

热门内容推荐

最新内容推荐

项目优选

收起
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
176
260
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
858
507
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
129
182
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
255
299
ShopXO开源商城ShopXO开源商城
🔥🔥🔥ShopXO企业级免费开源商城系统,可视化DIY拖拽装修、包含PC、H5、多端小程序(微信+支付宝+百度+头条&抖音+QQ+快手)、APP、多仓库、多商户、多门店、IM客服、进销存,遵循MIT开源协议发布、基于ThinkPHP8框架研发
JavaScript
93
15
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
331
1.08 K
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
397
370
note-gennote-gen
一款跨平台的 Markdown AI 笔记软件,致力于使用 AI 建立记录和写作的桥梁。
TSX
83
4
CangjieCommunityCangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.07 K
0
kernelkernel
deepin linux kernel
C
21
5