reflect-metadata 与设计类型
在运行时获取参数和属性的类型。
reflect-metadata 与设计类型 是 CoddyKit 上的免费 TypeScript Academy 课时。 这是第 3 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 TypeScript Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 TypeScript Academy 课程共包含 4 节课。
反射元数据与设计类型
在标准化元数据出现之前,TypeScript 可以通过反射元数据库和 emitDecoratorMetadata 编译器标志,在运行时发出设计时类型信息。本课介绍这种较旧但仍广泛使用的机制。
启用此功能
需要完成两件事:启用编译器选项,并在程序入口点导入一次该库。
// tsconfig.json
// {
// "compilerOptions": {
// "experimentalDecorators": true,
// "emitDecoratorMetadata": true
// }
// }
import "reflect-metadata";发出哪些内容
启用 emitDecoratorMetadata 后,编译器会为带装饰器的成员发出三个键:design:type、design:paramtypes 和 design:returntype。这些值是构造函数(例如 String、Number)。
读取设计类型
对于带装饰器的属性,Reflect.getMetadata("design:type", target, key) 会返回该属性类型的构造函数。
import "reflect-metadata";
function track(target: any, key: string) {
const t = Reflect.getMetadata("design:type", target, key);
console.log(key, "->", t.name); // e.g. "name -> String"
}
class Person {
@track name!: string;
@track age!: number;
}读取设计参数类型
在构造函数或方法上,design:paramtypes 是一个参数类型构造函数数组,也是依赖注入的基础。
function injectable(target: any) {
const params = Reflect.getMetadata("design:paramtypes", target);
console.log(params.map((p: any) => p.name)); // ["Database", "Logger"]
}
@injectable
class Service {
constructor(private db: Database, private log: Logger) {}
}发出类型的局限性
只有简单且能在运行时表示的类型可以保留下来。接口、联合类型和泛型会折叠为 Object,因为它们没有运行时构造函数。设计类型只是近似信息,并不是完整的 TS 类型。
使用反射定义自定义元数据
您还可以使用 Reflect.defineMetadata 定义自己的元数据键,而不依赖设计类型。
import "reflect-metadata";
function required(target: any, key: string) {
Reflect.defineMetadata("required", true, target, key);
}
function isRequired(target: any, key: string) {
return Reflect.getMetadata("required", target, key) === true;
}使用场景
许多成熟的框架(NestJS、TypeORM、类验证器)都依赖这种机制。它们读取 design:type 和 design:paramtypes 来连接依赖并验证值,而无需您重复声明类型。
反射元数据与标准元数据
新的 Symbol.metadata 接口属于语言本身,并不会发出设计类型。反射元数据机制能够提供类型信息,但与实验性装饰器模式绑定。每个项目请选择一种模型。
导入顺序很重要
import "reflect-metadata" 必须在任何带装饰器的类求值之前执行一次,因为它会为全局 Reflect 对象添加元数据函数。请在入口文件的最顶部导入它。
为什么这很重要
发出设计类型可以让框架弥合编译时类型与运行时行为之间的差距,这是实现便捷的依赖注入和验证的关键。了解其局限性(不支持接口和泛型)可以避免得到令人意外的 Object 结果。
快速检查
请测试您对反射元数据的理解。
回顾
启用 experimentalDecorators 和 emitDecoratorMetadata,并提前执行 import "reflect-metadata" 后,编译器会将 design:type 和 design:paramtypes 作为运行时构造函数发出。框架会读取这些信息来执行依赖注入和验证,但接口、联合类型和泛型会降级为 Object。
常见问题解答
「reflect-metadata 与设计类型」课时是免费的吗?
是的 — 「reflect-metadata 与设计类型」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 TypeScript Academy 课程的其余内容,请升级到 CoddyKit PRO。 TypeScript Academy 课程共包含 4 节课。
「reflect-metadata 与设计类型」这节课中我会学到什么?
在运行时获取参数和属性的类型。 你通过在浏览器中直接运行的动手代码来练习 TypeScript Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 TypeScript Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 TypeScript Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 3 节课,共 4 节。
「reflect-metadata 与设计类型」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 TypeScript Academy 课中编写并运行代码吗?
能。每节 TypeScript Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 第 3 阶段装饰器详解
- 装饰器元数据
- reflect-metadata 与设计类型
- 构建装饰器框架