
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 中定义。
支持模板化设计,基于标签调用数据 支持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 来验证和处理数据。









