讲师中心 微信公众号
AI工具推荐 视频效率加速

Zod 中基于字段值动态设置必填项的优雅实现方式

梦雪君_2981

梦雪君_2981

发布时间:2026-08-16 10:09:22

|

320人浏览过

|

来源于php中文网

原创

Zod 中基于字段值动态设置必填项的优雅实现方式

本文介绍如何在 Zod 中实现类似 Yup 的条件必填验证(如当 is_change_part === 'Yes' 时 barcode_old 必填),重点推荐使用 z.discriminatedUnion 构建类型安全、声明式且可静态推导的联合模式。

本文介绍如何在 zod 中实现类似 yup 的条件必填验证(如当 `is_change_part === 'yes'` 时 `barcode_old` 必填),重点推荐使用 `z.discriminatedunion` 构建类型安全、声明式且可静态推导的联合模式。

在 Zod 中实现字段级条件验证,核心目标是:让类型系统能准确反映运行时约束,并避免手动 superRefine 带来的类型丢失与冗余逻辑。你最初尝试的 superRefine 方案虽可行,但存在明显缺陷:它将验证逻辑移至运行时,导致 TypeScript 无法在编译期推导 barcode_old 在 'Yes' 分支下的非空性,从而削弱类型安全性与开发体验。

✅ 推荐方案:使用 z.discriminatedUnion 实现类型驱动的条件模式

该方法通过将不同业务状态(如 is_change_part: "Yes" 和 "No")建模为独立的、结构明确的对象 Schema,再用 discriminatedUnion 统一聚合,天然支持:

  • 编译期类型推导(例如:data.is_change_part === 'Yes' 时,data.barcode_old 自动为 string,非 string | undefined);
  • 零运行时开销的声明式验证;
  • 清晰的语义表达与可维护性。
import { z } from 'zod';

const stringRequired = z.string().min(1);

// 主体 Schema:定义所有字段的基础结构(含可选字段)
const baseSchema = z.object({
  serial_number: stringRequired,
  barcode_old: z.string().optional(), // 默认可选
  is_change_part: z.enum(['Yes', 'No']), // 强制枚举,提升类型安全
  category: stringRequired,
  sub_category: stringRequired,
});

// 条件分支 Schema:按 is_change_part 值精确建模
const schemaWhenYes = z.object({
  is_change_part: z.literal('Yes'),
  barcode_old: stringRequired, // ✅ 此处强制必填,类型系统自动识别
});

const schemaWhenNo = z.object({
  is_change_part: z.literal('No'),
  // barcode_old 无需在此声明 —— 它在 baseSchema 中已定义为 optional,且此分支不约束其存在性
});

// 合并为带判别逻辑的联合 Schema
export const Schema = z.discriminatedUnion('is_change_part', [
  schemaWhenYes,
  schemaWhenNo,
]).and(baseSchema); // 使用 .and() 合并基础字段,确保 serial_number 等始终存在

⚠️ 注意事项:

  • z.discriminatedUnion 要求判别字段(此处为 'is_change_part')在每个分支中必须是 字面量类型(如 z.literal('Yes')),不可用 z.string() 替代,否则联合类型会退化为 any。
  • .and(baseSchema) 是关键:它将公共字段(如 serial_number, category)注入到每个分支中,避免重复定义,同时保留所有必需字段的约束。
  • 若需额外校验(如 is_change_part 只能为 'Yes' | 'No'),z.enum(['Yes', 'No']) 已在 baseSchema 中保证,无需重复。

? 进阶提示:对于更复杂的多层条件(如嵌套字段或多个控制字段),可组合 z.union + z.object 或封装为自定义 z.custom(),但 discriminatedUnion 应作为首选——它是最符合 Zod 设计哲学(“Schema 即类型”)的原生解决方案。

总结:告别 superRefine 的手动 addIssue,拥抱 discriminatedUnion——它让条件验证从“运行时检查”升级为“编译期契约”,真正实现类型即文档、Schema 即规范。

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4246

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1069

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4144

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

860

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1736

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3085

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4033

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2580

2023.09.20

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn