请解释如何使用 Reflect Metadata API 与装饰器结合使用？

推荐答案

// www.javascriptcn.com code example
import 'reflect-metadata';

function logType(target: any, key: string) {
    const type = Reflect.getMetadata('design:type', target, key);
    console.log(`${key} type: ${type.name}`);
}

class Example {
    @logType
    public name: string;
}

本题详细解读

Reflect Metadata API 简介

Reflect Metadata API 是 TypeScript 提供的一个用于在运行时获取和设置元数据的 API。它允许开发者在类、方法、属性等上附加元数据，并在运行时通过反射机制读取这些元数据。

装饰器简介

装饰器是一种特殊类型的声明，它可以附加到类声明、方法、访问器、属性或参数上。装饰器使用 @expression 的形式，其中 expression 必须是一个函数，它会在运行时被调用，被装饰的声明信息作为参数传入。

结合使用 Reflect Metadata API 与装饰器

1. 安装 reflect-metadata 库：首先需要安装 reflect-metadata 库，因为它提供了 Reflect Metadata API 的实现。

   npm install reflect-metadata

2. 启用实验性装饰器和元数据：在 tsconfig.json 中启用实验性装饰器和元数据支持。

   {
     "compilerOptions": {
       "experimentalDecorators": true,
       "emitDecoratorMetadata": true
     }
   }

3. 使用装饰器获取元数据：通过装饰器函数，可以在运行时获取类成员的元数据。例如，获取属性的类型信息。

   // www.javascriptcn.com code example
   import 'reflect-metadata';
   
   function logType(target: any, key: string) {
       const type = Reflect.getMetadata('design:type', target, key);
       console.log(`${key} type: ${type.name}`);
   }
   
   class Example {
       @logType
       public name: string;
   }

   在这个例子中，logType 装饰器会在运行时获取 Example 类中 name 属性的类型，并打印出来。

4. 元数据的其他用途：除了获取类型信息，Reflect Metadata API 还可以用于存储和获取自定义元数据，例如路由信息、验证规则等。

   // www.javascriptcn.com code example
   function route(path: string) {
       return function (target: any, key: string, descriptor: PropertyDescriptor) {
           Reflect.defineMetadata('route', path, target, key);
       };
   }
   
   class Example {
       @route('/home')
       public home() {
           console.log('Home page');
       }
   }
   
   const routePath = Reflect.getMetadata('route', Example.prototype, 'home');
   console.log(routePath); // 输出: /home

   在这个例子中，route 装饰器将路由路径存储在元数据中，并在运行时通过 Reflect.getMetadata 获取。

通过结合使用 Reflect Metadata API 和装饰器，开发者可以在 TypeScript 中实现更强大的元编程能力，从而简化代码并提高可维护性。