0

0

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

花韻仙語

花韻仙語

发布时间:2025-08-03 19:04:11

|

1050人浏览过

|

来源于php中文网

原创

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

本文介绍了如何使用 Zod 验证请求数据子集,并保留未在 Schema 中明确指定的字段。通过 passthrough() 方法,可以轻松实现未识别键的透传,避免数据丢失,从而更灵活地处理请求数据。

Zod 是一个流行的 TypeScript 优先的 schema 声明和验证库。默认情况下,Zod 会严格按照 schema 定义进行验证,过滤掉所有未在 schema 中定义的字段。但在某些场景下,我们希望保留这些未定义的字段,例如,只验证请求数据中的一部分,而将其他字段传递给后续的处理流程。这时,Zod 的 passthrough() 方法就派上用场了。

passthrough() 方法允许 Zod 将未识别的键直接传递。这意味着,即使请求数据中包含未在 schema 中定义的字段,Zod 也不会报错或过滤掉这些字段,而是将它们保留在解析后的结果中。

下面是一个示例,演示如何使用 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 对象中的 dependent_id 字段。但是,req 对象中还包含 params.bar、body.foo 和 query 字段,这些字段未在 schema 中定义。

通过在 schema 对象上调用 passthrough() 方法,我们告诉 Zod 保留所有未识别的键。因此,parseAsync() 方法返回的结果将包含所有原始字段,而不仅仅是 dependent_id。

输出结果如下:

PicWish
PicWish

推荐!专业的AI抠图修图,支持格式转化

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

可以看到,params 对象现在包含 dependent_id 和 bar 字段,body 对象包含 foo 字段,query 对象为空对象,所有未定义的字段都被保留了下来。

总结:

passthrough() 方法是 Zod 中一个非常有用的功能,它允许我们灵活地处理请求数据,只验证我们关心的字段,而将其他字段传递给后续的处理流程。这在需要处理复杂请求数据或与第三方 API 集成时非常有用。

注意事项:

虽然 passthrough() 方法可以方便地保留未识别的键,但也需要注意潜在的安全风险。如果请求数据中包含恶意字段,可能会导致安全漏洞。因此,在使用 passthrough() 方法时,需要仔细审查请求数据,确保其安全性。

相关专题

更多
高德地图升级方法汇总
高德地图升级方法汇总

本专题整合了高德地图升级相关教程,阅读专题下面的文章了解更多详细内容。

2

2026.01.16

全民K歌得高分教程大全
全民K歌得高分教程大全

本专题整合了全民K歌得高分技巧汇总,阅读专题下面的文章了解更多详细内容。

0

2026.01.16

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

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

10

2026.01.16

java数据库连接教程大全
java数据库连接教程大全

本专题整合了java数据库连接相关教程,阅读专题下面的文章了解更多详细内容。

32

2026.01.15

Java音频处理教程汇总
Java音频处理教程汇总

本专题整合了java音频处理教程大全,阅读专题下面的文章了解更多详细内容。

15

2026.01.15

windows查看wifi密码教程大全
windows查看wifi密码教程大全

本专题整合了windows查看wifi密码教程大全,阅读专题下面的文章了解更多详细内容。

42

2026.01.15

浏览器缓存清理方法汇总
浏览器缓存清理方法汇总

本专题整合了浏览器缓存清理教程汇总,阅读专题下面的文章了解更多详细内容。

7

2026.01.15

ps图片相关教程汇总
ps图片相关教程汇总

本专题整合了ps图片设置相关教程合集,阅读专题下面的文章了解更多详细内容。

9

2026.01.15

ppt一键生成相关合集
ppt一键生成相关合集

本专题整合了ppt一键生成相关教程汇总,阅读专题下面的的文章了解更多详细内容。

6

2026.01.15

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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号