Typescript装饰器与元数据的应用

TypeScript 装饰器（Decorators）和元数据（Metadata）是 TypeScript 中两个强大的功能，它们允许开发者在编译时或运行时动态地修改类、方法、属性等的行为。下面将分别介绍装饰器和元数据的应用。

装饰器（Decorators）

装饰器是一种特殊类型的声明，它可以附加到类声明、方法、属性或参数上。装饰器本身是一个函数，该函数接受目标对象、属性名或描述符作为参数，并返回一个新的描述符，该描述符将被用于定义属性或方法。

应用示例

1. 类装饰器：用于修改类的行为。

function log(target: Function) {
  console.log(`Class ${target.name} has been defined.`);
}

@log
class MyClass {
  constructor() {
    console.log('MyClass instance created.');
  }
}

2. 方法装饰器：用于修改方法的行为。

function deprecated(target: any, key: string, descriptor: PropertyDescriptor) {
  console.warn(`Method ${key} is deprecated.`);
  return descriptor;
}

class MyClass {
  @deprecated
  myMethod() {
    console.log('This method is deprecated.');
  }
}

3. 属性装饰器：用于修改属性的行为。

function readonly(target: any, key: string) {
  Object.defineProperty(target, key, {
    writable: false,
    enumerable: true,
    configurable: true
  });
}

class MyClass {
  @readonly
  myProperty: string;

  constructor(value: string) {
    this.myProperty = value;
  }
}

4. 参数装饰器：用于修改函数参数的行为。

function validate(target: any, key: string, descriptor: PropertyDescriptor) {
  const originalMethod = descriptor.value;

  descriptor.value = function (...args: any[]) {
    if (args.length < 1) {
      throw new Error('Missing required argument.');
    }
    return originalMethod.apply(this, args);
  };

  return descriptor;
}

class MyClass {
  @validate
  myMethod(param: string) {
    console.log(`Received parameter: ${param}`);
  }
}

元数据（Metadata）

元数据是描述程序结构和行为的额外信息，它可以被 TypeScript 编译器或其他工具使用。TypeScript 支持通过装饰器将元数据附加到类、方法、属性等上。

应用示例

1. 使用 reflect-metadata 库：首先，需要安装 reflect-metadata 库，并在项目中引入它。

npm install reflect-metadata

然后，在 tsconfig.json 中启用元数据支持：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

接下来，定义一个元数据键和一个元数据值：

const MY_METADATA_KEY = 'myMetadataKey';
const MY_METADATA_VALUE = 'myMetadataValue';

使用装饰器将元数据附加到类上：

function setMetadata(metadataKey: string, metadataValue: string) {
  return function (target: any) {
    Reflect.defineMetadata(metadataKey, metadataValue, target);
  };
}

@setMetadata(MY_METADATA_KEY, MY_METADATA_VALUE)
class MyClass {
  // ...
}

最后，从类中检索元数据：

const metadata = Reflect.getMetadata(MY_METADATA_KEY, MyClass);
console.log(`Metadata value for ${MY_METADATA_KEY}: ${metadata}`);

这样，你就可以在 TypeScript 中使用装饰器和元数据来动态地修改类、方法、属性等的行为，从而提高代码的可维护性和可扩展性。