首页
/ Valibot 中 getDefaults 方法的行为分析与最佳实践

Valibot 中 getDefaults 方法的行为分析与最佳实践

2025-05-29 23:07:20作者:江焘钦

Valibot 是一个用于数据验证和模式定义的 TypeScript 库。最近社区中关于其 getDefaults 方法的行为引发了一些讨论,特别是关于该方法如何处理嵌套可选对象的默认值问题。

getDefaults 方法的基本行为

getDefaults 是 Valibot 提供的一个实用方法,用于获取模式(Schema)中定义的默认值。在简单场景下,它能够很好地工作:

const SimpleSchema = v.object({
  name: v.optional(v.string(), '默认名字')
});

console.log(v.getDefaults(SimpleSchema)); 
// 输出: { name: '默认名字' }

嵌套可选对象的问题

问题出现在处理嵌套的可选对象时。考虑以下模式定义:

const NestedOptionalSchema = v.optional(
  v.object({
    k1: v.optional(
      v.object({
        k2: v.optional(v.string(), 'value2')
      }),
      {}
    )
  }),
  {}
);

当使用 parse 方法解析 undefined 时,会得到完整的默认值结构:

console.log(v.parse(NestedOptionalSchema, undefined));
// 输出: { k1: { k2: 'value2' } }

getDefaults 方法却只能返回最外层的默认值:

console.log(v.getDefaults(NestedOptionalSchema));
// 输出: {}

技术原因分析

这种差异行为源于设计上的考量:

  1. 可选对象的歧义性:对于可选对象,无法确定用户期望返回 undefined 还是继续检查内部模式
  2. 性能考虑:深度遍历所有可能的嵌套结构可能会影响性能
  3. 明确性:保持方法行为的可预测性和明确性

当前解决方案

目前推荐的解决方案是:

  1. 避免在可选对象内部再嵌套可选对象,改为使用非可选对象结构
  2. 如果需要完全默认值,可以使用 parse 方法并传入 undefined
  3. 对于特殊需求,可以复制并修改 getDefaults 的源码实现
// 推荐的模式定义方式
const RecommendedSchema = v.object({
  k1: v.object({
    k2: v.optional(v.string(), 'value2')
  })
});

console.log(v.getDefaults(RecommendedSchema));
// 输出: { k1: { k2: 'value2' } }

未来可能的改进

Valibot 团队正在考虑改进 getDefaults 方法,使其能够:

  1. 提供配置选项来控制是否深度解析可选对象
  2. 添加一个新的方法来专门处理深度默认值场景
  3. 改进文档以更清楚地说明方法的行为边界

最佳实践建议

基于当前实现,建议开发者:

  1. 尽量在模式设计时就明确默认值结构
  2. 对于复杂嵌套结构,考虑使用辅助函数来获取完整默认值
  3. 关注 Valibot 的更新,未来版本可能会提供更灵活的默认值获取方式

理解这些行为差异有助于开发者更有效地使用 Valibot 进行数据验证和默认值管理。

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

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8