Zod透传未指定字段的技巧分享

还在为Zod数据验证时字段丢失而烦恼吗？本文为你揭秘Zod透传未指定字段的实用方法！Zod默认会过滤掉Schema中未定义的字段，但通过 `.passthrough()` 方法，你可以轻松保留这些未识别的键，确保数据的完整性。本文提供详细代码示例，展示如何利用 `.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: "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()

在上面的代码中，我们首先定义了一个 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透传未指定字段的技巧分享》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！