TS 中文文档

# 装饰器

# 介绍

随着 TypeScript 和 ES6 中类的引入，现在存在某些需要附加功能来支持注释或修改类和类成员的场景。装饰器提供了一种为类声明和成员添加注释和元编程语法的方法。装饰器是 JavaScript 的 第 2 阶段提案 ，可作为 TypeScript 的实验性功能使用。

注意 装饰器是一项实验性功能，可能会在未来的版本中发生变化。

要启用对装饰器的实验性支持，您必须在命令行或 tsconfig.json中启用 experimentalDecorators 编译器选项：

命令行：


tsc --target ES5 --experimentalDecorators

tsconfig.json：

{
  "compilerOptions": {
    "target": "ES5",
    "experimentalDecorators": true
  }
}

# 装饰器

装饰器是一种特殊的声明，可以附加到 类声明 、方法、accessor、属性或 参数 。装饰器使用 @expression形式，其中 expression必须评估为一个函数，该函数将在运行时调用，并带有有关装饰声明的信息。

例如，给定装饰器 @sealed，我们可以编写 sealed函数如下：

function sealed(target) {
  // do something with 'target' ...
}

# 装饰器工厂

如果我们想自定义如何将装饰器应用于声明，我们可以编写一个装饰器工厂。装饰器工厂只是一个函数，它返回将由装饰器在运行时调用的表达式。

我们可以用以下方式编写一个装饰器工厂：

function color(value: string) {
  // this is the decorator factory, it sets up
  // the returned decorator function
  return function (target) {
    // this is the decorator
    // do something with 'target' and 'value'...
  };
}

# 装饰器组成

可以将多个装饰器应用于声明，例如在一行中：

function f() {}
function g() {}
@f @g x

在多行上：

function f() {}
function g() {}
@f
@g
x

当多个装饰器应用于单个声明时，它们的评估类似于 数学中的函数组合 。在这个模型中，当组合函数 f 和 g 时，得到的复合 (f ∘ g)(x) 等价于 f(g(x))。

因此，在 TypeScript 中对单个声明评估多个装饰器时执行以下步骤：

  • 每个装饰器的表达式都是从上到下计算的。
  • 然后将结果作为函数从下到上调用。

如果我们使用 装饰器工厂 ，我们可以通过以下示例观察此评估顺序：

function first() {
  console.log("first(): factory evaluated");
  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    console.log("first(): called");
  };
}

function second() {
  console.log("second(): factory evaluated");
  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    console.log("second(): called");
  };
}

class ExampleClass {
  @first()
  @second()
  method() {}
}

这会将这个输出打印到控制台：

first(): factory evaluated
second(): factory evaluated
second(): called
first(): called

# 装饰器评价

应用于类内部各种声明的装饰器如何应用有一个明确定义的顺序：

  • 参数装饰器，后跟方法、访问器或属性装饰器应用于每个实例成员。
  • 参数装饰器，后跟方法、访问器或属性装饰器应用于每个静态成员。
  • 参数装饰器应用于构造函数。
  • 类装饰器应用于类。

# 类装饰器

类装饰器是在类声明之前声明的。类装饰器应用于类的构造函数，可用于观察、修改或替换类定义。类装饰器不能在声明文件或任何其他环境上下文中使用（例如在 declare类上）。

类装饰器的表达式将在运行时作为函数调用，装饰类的构造函数作为其唯一参数。

如果类装饰器返回一个值，它将用提供的构造函数替换类声明。

注意 如果您选择返回一个新的构造函数，您必须注意维护原始原型。在运行时应用装饰器的逻辑不会为您执行此操作。

以下是应用于 BugReport类的类装饰器 (@sealed) 的示例：

function sealed(constructor: Function) {
  Object.seal(constructor);
  Object.seal(constructor.prototype);
}
@sealed
class BugReport {
  type = "report";
  title: string;

  constructor(t: string) {
    this.title = t;
  }
}

我们可以使用以下函数声明来定义 @sealed装饰器：

function sealed(constructor: Function) {
  Object.seal(constructor);
  Object.seal(constructor.prototype);
}

当 @sealed被执行时，它将密封构造函数及其原型，因此将防止在运行时通过访问 BugReport.prototype或通过在 BugReport本身上定义属性来向此类添加或删除任何进一步的功能（请注意，ES2015 类实际上是只是基于原型的构造函数的语法糖）。此装饰器不会阻止类对 BugReport进行子类化。

接下来我们有一个示例，说明如何覆盖构造函数以设置新的默认值。

function reportableClassDecorator<T extends { new (...args: any[]): {} }>(constructor: T) {
  return class extends constructor {
    reportingURL = "http://www...";
  };
}

@reportableClassDecorator
class BugReport {
  type = "report";
  title: string;

  constructor(t: string) {
    this.title = t;
  }
}

const bug = new BugReport("Needs dark mode");
console.log(bug.title); // Prints "Needs dark mode"
console.log(bug.type); // Prints "report"

// Note that the decorator _does not_ change the TypeScript type
// and so the new property `reportingURL` is not known
// to the type system:
bug.reportingURL;

# 方法装饰器

方法装饰器在方法声明之前声明。装饰器应用于方法的属性描述符，可用于观察、修改或替换方法定义。方法装饰器不能用于声明文件、重载或任何其他环境上下文（例如在 declare类中）。

方法装饰器的表达式将在运行时作为函数调用，并带有以下三个参数：

  • 静态成员的类的构造函数，或者实例成员的类的原型。
  • 成员的姓名。
  • 成员的属性描述符。

注意 如果您的脚本目标小于 ES5，则属性描述符将为 undefined。

如果方法装饰器返回一个值，它将用作该方法的属性描述符。

注意 如果您的脚本目标小于 ES5，则忽略返回值。

以下是应用于 Greeter类的方法的方法装饰器 (@enumerable) 的示例：

function enumerable(value: boolean) {
  return function (target: any,propertyKey: string,descriptor: PropertyDescriptor) {
    descriptor.enumerable = value;
  };
}
class Greeter {
  greeting: string;
  constructor(message: string) {
    this.greeting = message;
  }

  @enumerable(false)
  greet() {
    return "Hello, " + this.greeting;
  }
}

我们可以使用以下函数声明来定义 @enumerable装饰器：

function enumerable(value: boolean) {
  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    descriptor.enumerable = value;
  };
}

这里的 @enumerable(false)装饰器是一个 装饰器工厂 。当调用 @enumerable(false)装饰器时，它会修改属性描述符的 enumerable属性。

# 访问器装饰器

访问器装饰器在访问器声明之前声明。访问器装饰器应用于访问器的属性描述符，可用于观察、修改或替换访问器的定义。不能在声明文件或任何其他环境上下文中使用访问器装饰器（例如在 declare类中）。

注意  TypeScript 不允许为单个成员装饰 get和 set访问器。相反，该成员的所有装饰器必须应用于文档顺序中指定的第一个访问器。这是因为装饰器应用于属性描述符，它结合了 get和 set访问器，而不是单独的每个声明。

访问器装饰器的表达式将在运行时作为函数调用，并带有以下三个参数：

  • 静态成员的类的构造函数，或者实例成员的类的原型。
  • 成员的姓名。
  • 成员的属性描述符。

注意 如果您的脚本目标小于 ES5，则属性描述符将为 undefined。

如果访问器装饰器返回一个值，它将用作成员的属性描述符。

注意 如果您的脚本目标小于 ES5，则忽略返回值。

以下是应用于 Point类成员的访问器装饰器 (@configurable) 的示例：

function configurable(value: boolean) {
  return function (
    target: any,
    propertyKey: string,
    descriptor: PropertyDescriptor
  ) {
    descriptor.configurable = value;
  };
}
class Point {
  private _x: number;
  private _y: number;
  constructor(x: number, y: number) {
    this._x = x;
    this._y = y;
  }

  @configurable(false)
  get x() {
    return this._x;
  }

  @configurable(false)
  get y() {
    return this._y;
  }
}

我们可以使用以下函数声明来定义 @configurable装饰器：

function configurable(value: boolean) {
  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    descriptor.configurable = value;
  };
}

# 属性装饰器

属性装饰器是在属性声明之前声明的。不能在声明文件或任何其他环境上下文中使用属性装饰器（例如在 declare类中）。

属性装饰器的表达式将在运行时作为函数调用，并带有以下两个参数：

  • 静态成员的类的构造函数，或者实例成员的类的原型。
  • 成员的姓名。

注意 由于属性装饰器在 TypeScript 中的初始化方式，属性描述符不作为参数提供给属性装饰器。这是因为目前在定义原型成员时没有描述实例属性的机制，也没有办法观察或修改属性的初始值设定项。返回值也被忽略。因此，属性装饰器只能用于观察已为类声明了特定名称的属性。

我们可以使用此信息来记录有关属性的元数据，如下例所示：

class Greeter {
  @format("Hello, %s")
  greeting: string;

  constructor(message: string) {
    this.greeting = message;
  }

  greet() {
    let formatString = getFormat(this, "greeting");
    return formatString.replace("%s", this.greeting);
  }
}

然后我们可以使用以下函数声明来定义 @format装饰器和 getFormat函数：

import "reflect-metadata";

const formatMetadataKey = Symbol("format");

function format(formatString: string) {
  return Reflect.metadata(formatMetadataKey, formatString);
}

function getFormat(target: any, propertyKey: string) {
  return Reflect.getMetadata(formatMetadataKey, target, propertyKey);
}

这里的 @format("Hello, %s")装饰器是一个 装饰器工厂 。调用 @format("Hello, %s")时，它会使用 reflect-metadata库中的 Reflect.metadata函数为属性添加一个元数据条目。调用 getFormat时，它会读取格式的元数据值。

注意 此示例需要 reflect-metadata库。有关 reflect-metadata库的更多信息，请参阅 元数据 。

# 参数装饰器

参数装饰器在参数声明之前声明。参数装饰器应用于类构造函数或方法声明的函数。参数装饰器不能在声明文件、重载或任何其他环境上下文中使用（例如在 declare类中）。

参数装饰器的表达式将在运行时作为函数调用，并带有以下三个参数：

  • 静态成员的类的构造函数，或者实例成员的类的原型。
  • 成员的姓名。
  • 函数参数列表中参数的序号索引。

注意 参数装饰器只能用于观察已在方法上声明的参数。

参数装饰器的返回值被忽略。

以下是应用于 BugReport类成员的参数的参数装饰器 (@required) 的示例：

function validate(target: any, propertyName: string, descriptor: TypedPropertyDescriptor<any>) {}
function required(target: Object, propertyKey: string | symbol, parameterIndex: number) {}
class BugReport {
  type = "report";
  title: string;

  constructor(t: string) {
    this.title = t;
  }

  @validate
  print(@required verbose: boolean) {
    if (verbose) {
      return `type: ${this.type}\ntitle: ${this.title}`;
    } else {
     return this.title; 
    }
  }
}

然后我们可以使用以下函数声明来定义 @required和 @validate装饰器：

import "reflect-metadata";
const requiredMetadataKey = Symbol("required");

function required(target: Object, propertyKey: string | symbol, parameterIndex: number) {
  let existingRequiredParameters: number[] = Reflect.getOwnMetadata(requiredMetadataKey, target, propertyKey) || [];
  existingRequiredParameters.push(parameterIndex);
  Reflect.defineMetadata( requiredMetadataKey, existingRequiredParameters, target, propertyKey);
}

function validate(target: any, propertyName: string, descriptor: TypedPropertyDescriptor<Function>) {
  let method = descriptor.value!;

  descriptor.value = function () {
    let requiredParameters: number[] = Reflect.getOwnMetadata(requiredMetadataKey, target, propertyName);
    if (requiredParameters) {
      for (let parameterIndex of requiredParameters) {
        if (parameterIndex >= arguments.length || arguments[parameterIndex] === undefined) {
          throw new Error("Missing required argument.");
        }
      }
    }
    return method.apply(this, arguments);
  };
}

@required装饰器添加了一个元数据条目，该条目将参数标记为必需。然后 @validate装饰器将现有的 greet方法包装在一个函数中，该函数在调用原始方法之前验证参数。

注意 此示例需要 reflect-metadata库。有关 reflect-metadata库的更多信息，请参阅 元数据 。

# 元数据

一些示例使用为 实验性元数据 API 添加 polyfill 的 reflect-metadata库。这个库还不是 ECMAScript (JavaScript) 标准的一部分。然而，一旦装饰器被正式采用为 ECMAScript 标准的一部分，这些扩展将被提议采用。

你可以通过 npm 安装这个库：

npm i reflect-metadata --save

TypeScript 包括为具有装饰器的声明发出某些类型的元数据的实验性支持。要启用此实验性支持，您必须在命令行或 tsconfig.json中设置 emitDecoratorMetadata 编译器选项：

命令行：


tsc --target ES5 --experimentalDecorators --emitDecoratorMetadata

tsconfig.json：

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

启用后，只要导入了 reflect-metadata库，就会在运行时公开额外的设计时类型信息。

我们可以在以下示例中看到这一点：

import "reflect-metadata";

class Point {
  constructor(public x: number, public y: number) {}
}

class Line {
  private _start: Point;
  private _end: Point;

  @validate
  set start(value: Point) {
    this._start = value;
  }

  get start() {
    return this._start;
  }

  @validate
  set end(value: Point) {
    this._end = value;
  }

  get end() {
    return this._end;
  }
}

function validate<T>(target: any, propertyKey: string, descriptor: TypedPropertyDescriptor<T>) {
  let set = descriptor.set!;

  descriptor.set = function (value: T) {
    let type = Reflect.getMetadata("design:type", target, propertyKey);

    if (!(value instanceof type)) {
      throw new TypeError(`Invalid type, got ${typeof value} not ${type.name}.`);
    }

    set.call(this, value);
  };
}

const line = new Line()
line.start = new Point(0, 0)

// line.end = {}

// Fails at runtime with:
// > Invalid type, got object not Point

TypeScript 编译器将使用 @Reflect.metadata装饰器注入设计时类型信息。你可以认为它等同于以下 TypeScript：

class Line {
  private _start: Point;
  private _end: Point;

  @validate
  @Reflect.metadata("design:type", Point)
  set start(value: Point) {
    this._start = value;
  }
  get start() {
    return this._start;
  }

  @validate
  @Reflect.metadata("design:type", Point)
  set end(value: Point) {
    this._end = value;
  }
  get end() {
    return this._end;
  }
}

注意 装饰器元数据是一项实验性功能，可能会在未来版本中引入重大更改。

Last Updated: 5/25/2023, 2:35:11 PM

← 声明合并 →