0

0

使用 Zod 实现未定义字段的透传

霞舞

霞舞

发布时间:2025-08-03 19:22:10

|

1084人浏览过

|

来源于php中文网

原创

使用 zod 实现未定义字段的透传

Zod 是一个流行的 TypeScript 优先的 schema 声明和验证库。在实际开发中,我们常常需要验证请求数据的一部分,而不是全部。然而,默认情况下,Zod 会过滤掉 schema 中未定义的字段,这可能会导致数据丢失。为了解决这个问题,Zod 提供了 passthrough() 方法,允许未定义的字段透传。

第一段引用上面的摘要:本文介绍了如何使用 Zod 验证请求数据子集时,保留未在 schema 中明确指定的字段。通过 passthrough() 方法,Zod 能够忽略未定义的键,从而实现数据的完整传递,避免意外的数据丢失。本文将提供详细的代码示例,帮助开发者理解和应用该功能。

使用 passthrough() 方法

passthrough() 方法是 Zod schema 对象的一个属性,调用它可以配置 Zod 在验证时忽略未定义的键。这意味着,如果请求数据中包含 schema 中未声明的字段,这些字段将被保留并传递下去,而不是被过滤掉。

以下是一个示例,展示了如何使用 passthrough() 方法:

import { z } from 'zod';

const schema = z.object({
  params: z.object({ dependent_id: z.string() }),
})

const req = {
  params: { dependent_id: "blah", bar: "baz" },
  body: { foo: "bar" },
  query: {}
}

const test = async () => {
  const { params, body, query } = await schema.passthrough().parseAsync(req);
  console.log("params: ", params)
  console.log("body: ", body)
  console.log("query: ", query)
}

test()

在这个例子中,schema 定义了一个包含 params 字段的对象,而 params 字段本身又是一个包含 dependent_id 字符串字段的对象。 req 对象包含 params、body 和 query 三个属性,其中 params 包含一个 bar 字段,body 包含一个 foo 字段,这些字段都没有在 schema 中定义。

瑞志企业建站系统(ASP版)2.2
瑞志企业建站系统(ASP版)2.2

支持模板化设计,基于标签调用数据 支持N国语言,并能根据客户端自动识别当前语言 支持扩展现有的分类类型,并可修改当前主要分类的字段 支持静态化和伪静态 会员管理功能,询价、订单、收藏、短消息功能 基于组的管理员权限设置 支持在线新建、修改、删除模板 支持在线管理上传文件 使用最新的CKEditor作为后台可视化编辑器 支持无限级分类及分类的移动、合并、排序 专题管理、自定义模块管理 支持缩略图和图

下载

通过调用 schema.passthrough(),我们告诉 Zod 忽略 schema 中未定义的字段。因此,parseAsync() 方法返回的结果将包含所有原始字段,而不仅仅是 dependent_id。

运行上述代码,将输出以下结果:

params:  { dependent_id: 'blah', bar: 'baz' }
body:  { foo: 'bar' }
query:  {}

可以看到,params 对象现在包含了 bar 字段,body 对象包含了 foo 字段,query 对象保持为空。

注意事项

  • passthrough() 方法会忽略所有未定义的键,包括嵌套对象中的键。
  • passthrough() 方法不会验证未定义的键的值类型。这意味着,即使未定义的键的值类型与 schema 中定义的类型不匹配,Zod 也不会报错。
  • passthrough() 方法只影响验证过程,不会改变原始数据。

总结

passthrough() 方法是 Zod 中一个非常有用的功能,它允许我们在验证请求数据子集时,保留未定义的字段。这在许多情况下都非常有用,例如,当我们只需要验证请求数据的一部分,而不需要验证全部数据时,或者当我们希望在请求数据中传递一些自定义字段时。通过合理使用 passthrough() 方法,我们可以更灵活地使用 Zod 来验证和处理数据。

相关专题

更多
js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

256

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

208

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1465

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

619

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

550

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

545

2024.04.29

go语言字符串相关教程
go语言字符串相关教程

本专题整合了go语言字符串相关教程,阅读专题下面的文章了解更多详细内容。

161

2025.07.29

c++字符串相关教程
c++字符串相关教程

本专题整合了c++字符串相关教程,阅读专题下面的文章了解更多详细内容。

80

2025.08.07

C++ 单元测试与代码质量保障
C++ 单元测试与代码质量保障

本专题系统讲解 C++ 在单元测试与代码质量保障方面的实战方法,包括测试驱动开发理念、Google Test/Google Mock 的使用、测试用例设计、边界条件验证、持续集成中的自动化测试流程,以及常见代码质量问题的发现与修复。通过工程化示例,帮助开发者建立 可测试、可维护、高质量的 C++ 项目体系。

8

2026.01.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
TypeScript 教程
TypeScript 教程

共19课时 | 2.2万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.1万人学习

TypeScript-45分钟入门
TypeScript-45分钟入门

共6课时 | 0.5万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号