Zod中含可选值联合类型的Schema解析异常,求正确实现方案
我来帮你分析下这个问题哈~
首先得澄清下:你写的TypeScript类型{ baz: string } & ({ foo: string } | { bar: string })其实是不允许只有baz的情况(必须同时有baz + foo/bar),但你的测试用例里却包含了解析{baz}的场景,这说明你实际想要的是支持三种输入的Schema:
- 仅含
baz字段 - 含
baz和foo字段 - 含
baz和bar字段
回到你原来的写法为什么会失败:Zod的z.object()默认是严格模式,也就是会拒绝Schema中未定义的额外字段。当你用FooOrBar.and(Baz)生成Schema后,解析{bar, baz}时,Zod会先尝试第一个union成员交叉后的Schema({foo?: string, baz: string}),这个Schema不允许出现bar字段,所以直接匹配失败;虽然第二个union成员的Schema是匹配的,但Zod在交叉类型与union的组合逻辑中,会因为第一个匹配失败的错误直接抛出,而没有继续尝试第二个合法的匹配项,最终导致解析失败。
下面给你两个更优雅的正确实现方案:
方案一:直接定义三种合法场景的Union(推荐)
这是最直观也最符合Zod设计思路的写法,直接把你需要支持的三种输入情况做成Union,还能利用extend复用基础Schema:
it('works with explicit union of valid cases', () => { // 基础的baz字段Schema const Baz = z.object({ baz: z.string() }) // 基于Baz扩展出带foo的Schema const FooBaz = Baz.extend({ foo: z.string() }) // 基于Baz扩展出带bar的Schema const BarBaz = Baz.extend({ bar: z.string() }) // 最终Schema是三种合法情况的Union const Schema = z.union([Baz, FooBaz, BarBaz]) const foo = 'foo!' const bar = 'bar!' const baz = 'baz!' expect(Schema.parse({ baz })).toEqual({ baz }) expect(Schema.parse({ foo, baz })).toEqual({ foo, baz }) expect(Schema.parse({ bar, baz })).toEqual({ bar, baz }) })
这个方案的好处是逻辑清晰到爆炸,谁看都懂你要支持啥输入,还完全避免了交叉类型的隐晦坑点,后续维护也方便。
方案二:调整严格模式,保留交叉+Union的写法
如果你坚持想用交叉类型的写法,只需要给Union里的Object加上.passthrough(),允许它们接受额外字段,这样Zod就不会因为存在未定义的字段而拒绝匹配了:
it('works with union and intersection (fixed strict mode)', () => { const FooOrBar = z.union([ // 允许额外字段,避免bar字段导致第一个Union成员匹配失败 z.object({ foo: z.string().optional() }).passthrough(), // 允许额外字段,避免foo字段导致第二个Union成员匹配失败 z.object({ bar: z.string().optional() }).passthrough() ]) const Baz = z.object({ baz: z.string() }) const Schema = FooOrBar.and(Baz) const foo = 'foo!' const bar = 'bar!' const baz = 'baz!' expect(Schema.parse({ baz })).toEqual({ baz }) expect(Schema.parse({ foo, baz })).toEqual({ foo, baz }) expect(Schema.parse({ bar, baz })).toEqual({ bar, baz }) })
总结
优先选方案一,代码可读性和可维护性都更高;方案二更贴近你原来的写法,但需要理解Zod严格模式的影响,避免踩坑。
内容来源于stack exchange

