登录
首页 >  文章 >  前端

ZodSchema透传未定义字段技巧解析

时间:2025-08-04 16:18:29 239浏览 收藏

偷偷努力,悄无声息地变强,然后惊艳所有人!哈哈,小伙伴们又来学习啦~今天我将给大家介绍《Zod Schema 透传未定义字段方法详解》,这篇文章主要会讲到等等知识点,不知道大家对其都有多少了解,下面我们就一起来看一吧!当然,非常希望大家能多多评论,给出合理的建议,我们一起学习,一起进步!

Zod Schema 中允许未定义字段透传的方法

在使用 Zod 进行数据验证时,有时我们只需要验证请求数据中的一部分字段,而希望保留其他未在 schema 中定义的字段。默认情况下,Zod 会过滤掉所有未在 schema 中明确指定的字段,导致数据丢失。本文将介绍如何使用 Zod 的 passthrough() 方法,允许未定义字段的透传,从而实现只验证部分数据的目的。

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();

在这个例子中,我们定义了一个 schema,只验证 params 对象中的 dependent_id 字段。但是,我们希望保留 params 对象中的 bar 字段,以及 body 和 query 对象中的所有字段。

通过在 schema 上调用 passthrough() 方法,我们可以实现这个目的。运行上述代码,将会输出:

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

可以看到,params 对象中的 bar 字段,以及 body 和 query 对象中的所有字段都被保留了下来。

注意事项:

  • passthrough() 方法会保留所有未在 schema 中定义的字段,包括嵌套对象中的字段。
  • passthrough() 方法只影响解析后的输出结果,不会影响 schema 的验证逻辑。也就是说,如果请求数据中包含无效的字段,仍然会抛出错误。
  • 除了 passthrough() 之外,Zod 还提供了 strict() 和 strip() 方法,分别用于禁止未定义字段和删除未定义字段。可以根据实际需求选择合适的方法。

总结:

passthrough() 方法是 Zod 中一个非常有用的功能,可以帮助我们灵活地处理请求数据,只验证部分字段,同时保留其他未定义字段。通过合理使用 passthrough() 方法,可以简化代码,提高开发效率。

好了,本文到此结束,带大家了解了《ZodSchema透传未定义字段技巧解析》,希望本文对你有所帮助!关注golang学习网公众号,给大家分享更多文章知识!

相关阅读
更多>
最新阅读
更多>
课程推荐
更多>