TypeScript中如何检查var是否与interface的元素及数据类型匹配
核心实现前提
TypeScript 的interface属于纯编译时类型,经过编译打包后会被完全擦除,运行时不存在任何和interface相关的元数据,因此根本无法直接把interface作为函数入参传递、或是在运行时拿到interface的定义信息。很多开发一开始找不到同类实现参考,本质就是陷入了“直接传interface当参数”的思维误区,所有同类校验需求的落地,核心都是手动建立一套可在运行时访问的校验规则,把interface定义和运行时规则做映射,最终实现“属性名称、数据类型完全匹配”的校验能力。
具体实现方案
方案1:手动双轨维护校验规则
不依赖任何额外工具,独立维护TS类型定义和运行时校验逻辑,灵活性最高。
- 先按照正常流程定义业务需要的interface:
interface User { id: number; name: string; isActive: boolean } - 手动为这个interface写一套对应的运行时校验规则,规则本质是“每个属性对应一个类型判断函数”:
// 泛型约束:校验规则必须覆盖interface的所有属性 type ValidatorRule<T> = Record<keyof T, (value: unknown) => boolean> const userValidator: ValidatorRule<User> = { id: (val) => typeof val === "number", name: (val) => typeof val === "string", isActive: (val) => typeof val === "boolean" } - 编写通用的泛型校验函数,实现“完全匹配”的核心逻辑:
function validate<T>(input: unknown, rule: ValidatorRule<T>): input is T { // 先判断入参是否为非空普通对象 if (typeof input !== "object" || input === null || Array.isArray(input)) return false const inputObj = input as Record<string, unknown> const inputKeys = Object.keys(inputObj) const ruleKeys = Object.keys(rule) // 校验属性数量完全一致:多传、少传属性都直接判定不匹配 if (inputKeys.length !== ruleKeys.length) return false // 逐属性校验存在性和类型合法性 for (const key of ruleKeys) { if (!(key in inputObj) || !rule[key](inputObj[key])) return false } return true }
这个方案的优劣势:无额外依赖、运行时体积极小,校验逻辑可以完全自定义;但需要手动同步维护TS类型和运行时校验规则,很容易出现两边定义不一致的问题。
方案2:通过运行时Schema反向推导TS类型
从根源上避免双轨维护的不一致问题,核心逻辑是先写可在运行时执行的校验规则,再通过TypeScript的类型推导能力,自动生成等价的interface定义。
实现示例:
- 先封装基础类型判断工具、对象校验器工厂:
// 基础类型守卫 const t = { string: (val: unknown): val is string => typeof val === "string", number: (val: unknown): val is number => typeof val === "number", boolean: (val: unknown): val is boolean => typeof val === "boolean" } // 对象校验器工厂,内置完全匹配的校验逻辑 function buildObjectValidator<T extends Record<string, (val: unknown) => boolean>>(schema: T) { return { validate: (input: unknown): input is { [K in keyof T]: T[K] extends (val: unknown) => val is infer R ? R : never } => { if (typeof input !== "object" || input === null || Array.isArray(input)) return false const inputObj = input as Record<string, unknown> const schemaKeys = Object.keys(schema) if (Object.keys(inputObj).length !== schemaKeys.length) return false for (const key of schemaKeys) { if (!(key in inputObj) || !schema[key](inputObj[key])) return false } return true } } } - 使用时只需写一遍运行时校验Schema,系统会自动推导出等价的TS类型:
// 定义校验Schema,同时自动生成对应的User类型,不需要单独写interface const UserValidator = buildObjectValidator({ id: t.number, name: t.string, isActive: t.boolean }) // 自动推导的等价类型 type User = ReturnType<typeof UserValidator.validate> extends (val: unknown) => val is infer U ? U : never // 实际调用校验 const testValue = { id: 123, name: "Tom", isActive: true } if (UserValidator.validate(testValue)) { // 此处testValue会被自动识别为User类型,校验过程已经完成了属性、类型的完全匹配检查 }
实现注意边界
- 所谓“完全匹配”的规则需要提前明确:例如是否允许嵌套对象也执行同样的无多余属性校验、是否区分“属性值为undefined”和“属性不存在”的差异、是否需要校验数组元素的类型等,这类细节没有统一的默认实现,需要根据业务场景在类型守卫中补充逻辑。
- 注意JS原生的类型判断坑:例如
typeof null返回"object"、数组的typeof同样返回"object",如果不主动加判空、判数组的逻辑,很容易出现校验误判。 - 永远不要尝试绕过TS的类型擦除机制:所有运行时校验必须基于可被JS执行的普通对象/函数实现,不存在任何方法可以直接把编译后的interface传递到运行时作为校验依据。
内容的提问来源于stack exchange,提问作者Jason Hakakha
相关产品推荐
相关产品推荐

