如何使用 Zod 允许未在 Schema 中指定的对象字段透传？

本文介绍了如何使用 Zod 验证请求数据子集时，允许未在 Schema 中明确指定的对象字段透传。通过 .passthrough() 方法，Zod 可以保留未识别的键，从而避免数据过滤，确保完整性。本文提供了详细的代码示例，帮助开发者理解和应用此功能，从而更灵活地处理请求数据验证。

在使用 Zod进行数据验证时，有时我们只需要验证请求数据中的部分对象字段，而希望保留其他未在 Schema 中明确指定的字段。情况默认下，Zod 会过滤掉所有未在 Schema 中定义的字段，这在某些场景下可能不是我们期望的行为。本文将介绍如何使用 Zod 的 .passthrough() 方法来实现字段的透传。

使用 .passthrough() 方法

Zod 提供了.passthrough() 方法，可以用于指定当遇到未在 Schema 中定义的按键时，Zod 的行为。使用 .passthrough() 方法后，Zod 将会保留这些未识别的键，而不是彻底过滤掉。

下面是一个例子：import { z } from 'zod'；const schema = z.object({ params： z.object({ dependent_id： z.string() })，})const req = { params： { dependent_id： quot；blahquot；， bar： quot；bazquot； }， body： { foo： quot；barquot； }， query： {}}const test = async () =gt； { const { params， body， query } = wait schema.passthrough().parseAsync(req)； console.log(quot；params： quot；， params) console.log(quot；body： quot；， body) console.log(quot；query： quot；， query)}test()登录后复制

在上面的代码中，我们首先定义了一个Zod Schema，它只验证req.params对象中的dependent_id 然后，我们调用 schema.passthrough() 方法，告诉 Zod 保留所有未在 Schema 中定义的键。

当我们运行 test() 函数时，输出结果如下：params： { dependent_id： 'blah'， bar： 'baz' }body： { foo： 'bar' }query： {} 登录后复制

可以看到，params 对象中除了 dependent_id 字段外，bar body 和 query 对象也按照原来的数据输出。

注意事项.passthrough() 方法会影响整个 Schema 的验证行为，包括修饰的对象。

如果需要更精细地控制字段的透传行为，可以考虑使用 .extend() 方法来扩展 Schema，并为需要透传的字段定义类型为 z.any() 或 z.unknown() 的 Schema。

总结

通过使用 Zod 的 .passthrough()方法，我们可以轻松地实现对象字段的透传，从而更灵活地处理请求数据验证。这在验证需要请求数据子集，同时保留其他未指定字段的场景下非常有用。希望本文能够帮助你更好地理解和使用Zod。

以上就是如何使用Zod允许未在Schema中指定的对象字段透传？的详细内容，更多请关注乐哥常识网其他文章相关！