讲师中心 微信公众号
AI工具推荐 视频效率加速

TypeScript 类型验证:使用 Zod 实现运行时结构校验

酷雪小哥_9696

酷雪小哥_9696

发布时间:2026-09-03 20:33:19

|

834人浏览过

|

来源于php中文网

原创

TypeScript 类型验证:使用 Zod 实现运行时结构校验

本文介绍如何借助 zod 库在运行时严格校验 javascript 对象是否符合 typescript 接口定义的结构,实现类型安全的输入验证与数据解析。

本文介绍如何借助 zod 库在运行时严格校验 javascript 对象是否符合 typescript 接口定义的结构,实现类型安全的输入验证与数据解析。

Zod 是一个以零依赖、类型优先为理念的运行时验证库,它不仅能生成精确的 TypeScript 类型,还能在运行时对任意对象进行结构和值的双重校验。当你定义了如 interface f { tmp: number } 这样的静态类型时,Zod 可将其映射为可执行的验证逻辑,从而桥接编译期类型与运行时数据之间的鸿沟。

基础用法:手动构建对应 Schema

最直观的方式是根据接口字段,显式创建 Zod schema:

import { z, ZodError } from "zod";

interface f {
  tmp: number;
}

// 手动声明 schema,与 interface 保持语义一致
const schema = z.object({
  tmp: z.number(),
});

const myObject = { tmp: 123 };

try {
  const validatedObject: f = schema.parse(myObject); // ✅ 成功返回并推导出类型 f
  console.log("Object is valid:", validatedObject);
} catch (error) {
  if (error instanceof ZodError) {
    console.error("Validation failed:", error.issues); // 推荐使用 .issues(.errors 已废弃)
  } else {
    throw error;
  }
}

✅ 注意:schema.parse() 返回值自动具备 f 类型(得益于 Zod 的类型推导),无需额外断言;若校验失败则抛出 ZodError,其 .issues 属性提供结构化错误信息(如路径、期望类型、实际值等)。

TypeScript
TypeScript

{"answer":"编写类型安全的 TypeScript,合理运用类型收窄、推断模式与严格模式最佳实践。"}

下载

进阶技巧:从接口自动生成 Schema(减少重复)

为避免手动维护 schema 与 interface 的一致性(尤其在字段增多时易出错),可利用 TypeScript 的类型反射能力 + Zod 的 z.object() 灵活性,实现“接口驱动”的 schema 构建:

import { z, ZodError } from "zod";

interface f {
  tmp: number;
  name?: string;
  active: boolean;
}

// 动态构建 schema —— 字段名与类型均来自 interface 定义
const schema = z.object({
  tmp: z.number(),
  name: z.string().optional(), // 注意:TS 中 ? 对应 .optional()
  active: z.boolean(),
} satisfies Record<keyof f, z.ZodTypeAny>);

const myObject = { tmp: 42, active: true };

try {
  const validatedObject: f = schema.parse(myObject);
  console.log("Validated:", validatedObject); // { tmp: 42, active: true }
} catch (error) {
  if (error instanceof ZodError) {
    console.error("Errors:", error.issues);
  }
}

⚠️ 重要说明:

  • TypeScript 接口本身无法被运行时读取,因此不存在真正的“自动推导”(如 z.infer<typeof f></typeof> 不合法)。所谓“自动”,实为开发者通过类型约束(如 satisfies)+ 显式声明保障一致性;
  • 若需更高阶自动化(如基于装饰器或代码生成),可结合 zod-to-json-schema 或构建时工具(如 zod-dts),但通常手动维护已足够清晰可控;
  • 使用 satisfies 断言可确保 z.object({...}) 的键集与 keyof f 完全匹配,配合 TS 编译器报错即时发现遗漏字段。

最佳实践总结

  • ✅ 始终使用 schema.safeParse() 处理不可信输入(如 API 请求体、localStorage 数据),避免异常中断流程;
  • ✅ 对复杂嵌套接口,善用 z.array()、z.union()、z.record() 等组合 schema;
  • ✅ 在函数入参处封装验证逻辑,形成「守门人」模式:
    const handleUserInput = (raw: unknown) => {
      const result = schema.safeParse(raw);
      if (!result.success) throw new Error(`Invalid input: ${result.error.message}`);
      return result.data; // 类型为 f,100% 可信
    };
  • ✅ 结合 z.infer<typeof schema></typeof> 替代手写 interface(推荐单源事实):
    const schema = z.object({ tmp: z.number() });
    type f = z.infer<typeof schema>; // 自动同步,杜绝不一致

Zod 不仅让类型验证变得简洁可靠,更将 TypeScript 的设计意图延伸至运行时——每一次 parse() 都是对契约的确认,每一次 safeParse() 都是对健壮性的加固。

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4426

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1109

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4344

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

880

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1776

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3185

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4153

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2680

2023.09.20

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

20

2026.09.30

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebStorm 官方调试文档
WebStorm 官方调试文档

共0课时 | 0人学习

TypeScript 教程
TypeScript 教程

共19课时 | 6.6万人学习

TypeScript——十天技能课堂
TypeScript——十天技能课堂

共21课时 | 1.7万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn