Valibot库中对象交叉类型转JSON Schema的问题解析
2025-05-29 12:56:33作者:贡沫苏Truman
问题背景
Valibot是一个轻量级的TypeScript验证库,提供了将Schema转换为JSON Schema的功能。在实际使用中,开发者发现当使用intersect操作符组合多个对象类型时,生成的JSON Schema存在无法满足的约束条件。
问题现象
当开发者尝试将两个对象类型的交叉类型转换为JSON Schema时:
const schema = intersect([
object({ foo: string() }),
object({ bar: number() }),
]);
生成的JSON Schema会为每个对象添加additionalProperties: false约束:
{
"allOf": [
{
"type": "object",
"properties": { "foo": { "type": "string" } },
"additionalProperties": false
},
{
"type": "object",
"properties": { "bar": { "type": "number" } },
"additionalProperties": false
}
]
}
这导致任何同时包含foo和bar属性的对象都无法通过验证,因为每个子Schema都禁止额外的属性。
技术分析
Valibot与JSON Schema的差异
Valibot的intersect操作符在运行时验证时,实际上是要求对象同时满足所有子Schema的条件。然而在JSON Schema中,allOf与additionalProperties: false的组合会产生严格的约束,这与Valibot的预期行为不符。
严格对象与宽松对象
Valibot提供了三种对象类型定义方式:
object()- 基本对象类型,允许额外属性strictObject()- 严格对象类型,禁止额外属性looseObject()- 宽松对象类型,明确允许额外属性
在JSON Schema转换中,这三种类型应该有不同表现:
strictObject应转换为additionalProperties: falselooseObject应转换为additionalProperties: true- 普通
object不应添加additionalProperties约束
解决方案
临时解决方案
开发者可以使用对象合并替代交叉类型:
const MergedSchema = object({
...ObjectSchema1.entries,
...ObjectSchema2.entries,
});
长期解决方案
Valibot团队计划在v2版本的toJsonSchema中:
- 升级到支持
unevaluatedProperties的JSON Schema新版本 - 为不同类型对象提供准确的JSON Schema转换
- 保持与TypeScript类型的严格对应关系
最佳实践建议
- 避免在JSON Schema转换场景中使用
intersect组合多个strictObject - 优先使用对象合并语法替代交叉类型
- 明确区分使用
object、strictObject和looseObject的场景 - 等待v2版本对JSON Schema支持的改进
总结
Valibot在对象交叉类型的JSON Schema转换上存在与预期行为不符的问题,这源于JSON Schema规范的限制。开发者需要注意使用场景,选择合适的对象类型定义方式,并关注未来版本对此问题的改进。
登录后查看全文
热门项目推荐
相关项目推荐
kernelopenEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。C051
MiniMax-M2.1从多语言软件开发自动化到复杂多步骤办公流程执行,MiniMax-M2.1 助力开发者构建下一代自主应用——全程保持完全透明、可控且易于获取。Python00
kylin-wayland-compositorkylin-wayland-compositor或kylin-wlcom(以下简称kywc)是一个基于wlroots编写的wayland合成器。 目前积极开发中,并作为默认显示服务器随openKylin系统发布。 该项目使用开源协议GPL-1.0-or-later,项目中来源于其他开源项目的文件或代码片段遵守原开源协议要求。C01
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
GLM-4.7GLM-4.7上线并开源。新版本面向Coding场景强化了编码能力、长程任务规划与工具协同,并在多项主流公开基准测试中取得开源模型中的领先表现。 目前,GLM-4.7已通过BigModel.cn提供API,并在z.ai全栈开发模式中上线Skills模块,支持多模态任务的统一规划与协作。Jinja00
agent-studioopenJiuwen agent-studio提供零码、低码可视化开发和工作流编排,模型、知识库、插件等各资源管理能力TSX0126
Spark-Formalizer-X1-7BSpark-Formalizer 是由科大讯飞团队开发的专用大型语言模型,专注于数学自动形式化任务。该模型擅长将自然语言数学问题转化为精确的 Lean4 形式化语句,在形式化语句生成方面达到了业界领先水平。Python00
项目优选
收起
deepin linux kernel
C
26
10
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
445
3.35 K
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
823
398
Ascend Extension for PyTorch
Python
251
285
React Native鸿蒙化仓库
JavaScript
277
329
暂无简介
Dart
702
165
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
10
1
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
141
51
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.24 K
679
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
557
111