首页
/ Zod项目中处理嵌套的Discriminated Union类型解析

Zod项目中处理嵌套的Discriminated Union类型解析

2025-05-03 10:51:49作者:宣海椒Queenly

在TypeScript开发中,我们经常需要处理复杂的类型结构,特别是当遇到嵌套的Discriminated Union类型时,类型定义和验证会变得尤为复杂。本文将通过一个实际案例,深入分析如何在Zod项目中处理这类复杂场景。

案例背景分析

我们有一个账单类型Bill,它包含一些基本属性如账单日期、ID、名称和余额。在此基础上,我们需要扩展出两种不同类型的发票:

  1. 标准发票(Invoice):包含发票数量和日期信息
  2. 付款发票(Payment):包含付款/信用额度和日期信息

其中,日期信息本身也是一个Discriminated Union类型,根据isPartial字段分为两种情况:

  • 非部分发票:日期字段为固定值0
  • 部分发票:包含实际的月份和年份

类型定义解析

原始TypeScript类型定义清晰地表达了这种嵌套结构:

type InvoiceType = Bill &
  (
    | ({ type: "Invoice"; invoices: number } & InvoiceDateType)
    | {
        type: "Payment";
        paymentsAndCredits: number;
        isPartial: 0 | 1;
        invoiceMonth: MonthType;
        invoiceYear: number;
      }
  );

这种结构体现了两个层次的Discriminated Union:

  1. 外层通过type字段区分Invoice和Payment
  2. 内层通过isPartial字段区分完整和部分发票

Zod实现挑战

在尝试用Zod实现这个类型验证时,遇到了几个关键问题:

  1. 嵌套Discriminated Union限制:Zod的discriminatedUnion方法目前只支持单一层级的区分,无法直接处理嵌套场景
  2. 类型组合方式:原始类型使用了交叉类型(&)和联合类型(|)的组合,需要找到等效的Zod表达式
  3. 属性继承关系:需要正确处理Bill基础类型与扩展类型之间的关系

解决方案探索

1. 基础类型定义

首先正确定义基础类型和月份枚举:

const billSchema = z.object({
  billDate: z.string(),
  billId: z.number(),
  name: z.string(),
  balance: z.number(),
});

const monthSchema = z.union([
  z.literal(1), z.literal(2), z.literal(3), z.literal(4),
  z.literal(5), z.literal(6), z.literal(7), z.literal(8),
  z.literal(9), z.literal(10), z.literal(11), z.literal(12)
]);

2. 日期类型处理

对于InvoiceDateType,可以使用discriminatedUnion

const invoiceDateSchema = z.discriminatedUnion("isPartial", [
  z.object({
    isPartial: z.literal(0),
    invoiceMonth: z.literal(0),
    invoiceYear: z.literal(0),
  }),
  z.object({
    isPartial: z.literal(1),
    invoiceMonth: monthSchema,
    invoiceYear: z.number(),
  }),
]);

3. 外层类型处理

由于Zod的限制,我们需要调整策略,可以考虑:

方案一:扁平化处理

将嵌套的Union展开为单一层级的多个类型:

const invoiceTypeSchema = z.discriminatedUnion("type", [
  z.object({
    type: z.literal("Invoice"),
    invoices: z.number(),
    isPartial: z.literal(0),
    invoiceMonth: z.literal(0),
    invoiceYear: z.literal(0),
  }),
  z.object({
    type: z.literal("Invoice"),
    invoices: z.number(),
    isPartial: z.literal(1),
    invoiceMonth: monthSchema,
    invoiceYear: z.number(),
  }),
  z.object({
    type: z.literal("Payment"),
    paymentsAndCredits: z.number(),
    isPartial: z.union([z.literal(0), z.literal(1)]),
    invoiceMonth: monthSchema,
    invoiceYear: z.number(),
  }),
]);

方案二:使用常规Union替代

放弃discriminatedUnion,改用常规union方法:

const invoiceTypeSchema = z.union([
  z.object({
    type: z.literal("Invoice"),
    invoices: z.number(),
  }).and(invoiceDateSchema),
  z.object({
    type: z.literal("Payment"),
    paymentsAndCredits: z.number(),
    isPartial: z.union([z.literal(0), z.literal(1)]),
    invoiceMonth: monthSchema,
    invoiceYear: z.number(),
  }),
]);

4. 最终组合

无论选择哪种方案,最终都可以通过intersectionextend方法组合基础类型:

export const invoiceSchema = billSchema.extend(invoiceTypeSchema);

最佳实践建议

  1. 评估复杂度:对于简单嵌套,扁平化处理可能更清晰;深度嵌套则需考虑重构类型设计
  2. 性能考量discriminatedUnion比常规union有更好的性能,优先考虑使用
  3. 类型安全:确保Zod模式与TypeScript类型保持同步,可以使用z.infer生成类型进行验证
  4. 文档注释:为复杂模式添加详细注释,说明设计意图和结构关系

总结

在Zod中处理嵌套的Discriminated Union类型确实存在挑战,但通过合理的策略调整和类型设计,我们仍然能够实现类型安全的验证。关键在于理解Zod的限制并灵活运用其提供的各种组合方法。对于特别复杂的场景,可能需要权衡类型表达的精确性和实现简洁性,找到最适合项目需求的解决方案。

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

热门内容推荐

最新内容推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
143
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
927
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
75
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