使用TypeScript开发微信小程序（10）——装饰器（Decorator）
Posted GuyoungStudio
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了使用TypeScript开发微信小程序（10）——装饰器（Decorator）相关的知识，希望对你有一定的参考价值。
随着 TypeScript 和 ES6 里引入了类，在一些场景下需要额外的特性来支持标注或修改类及其成员。 装饰器（Decorators）可以在类的声明及成员上通过元编程语法添加标注提供了一种方式。 javascript 里的装饰器目前处在建议征集的第一阶段，但在TypeScript里已做为一项实验性特性予以支持。
装饰器
装饰器是一种特殊类型的声明，它能够被附加到类声明，方法， 访问符，属性或参数上。 装饰器使用 @expression 这种形式，expression 求值后必须为一个函数，它会在运行时被调用，被装饰的声明信息做为参数传入。
例如，有一个 @sealed 装饰器，定义 sealed 函数：
function sealed(target) { // do something with "target" ...
}若要启用实验性的装饰器特性，你须在命令行或 tsconfig.json 里启用 experimentalDecorators 编译器选项。
命令行:
tsc --target ES5 --experimentalDecoratorstsconfig.json
{
"compilerOptions": { "target": "ES5", "experimentalDecorators": true } }装饰器工厂
装饰器工厂就是一个简单的函数，它返回一个表达式，以供装饰器在运行时调用。
function color(value: string) { // 这是一个装饰器工厂
return function (target) { // 这是装饰器
// do something with "target" and "value"...
}
}装饰器组合
多个装饰器可以同时应用到一个声明上。
书写在同一行上：
@f @g x书写在多行上：
@f
@g
x当多个装饰器应用于一个声明上，它们求值方式与复合函数相似。在这个模型下，当复合f和g时，复合的结果(f ∘ g)(x)等同于f(g(x))。
同样的，在TypeScript里，当多个装饰器应用在一个声明上时会进行如下步骤的操作：
- 由上至下依次对装饰器表达式求值。
求值的结果会被当作函数，由下至上依次调用。
function f() { console.log("f(): evaluated"); return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) { console.log("f(): called"); } } function g() { console.log("g(): evaluated"); return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) { console.log("g(): called"); } } class C { @f() @g() method() { } }
在控制台里会打印出如下结果：
f(): evaluated
g(): evaluated
g(): called
f(): called装饰器求值
类中不同声明上的装饰器将按以下规定的顺序应用：
- 参数装饰器，然后依次是方法装饰器，访问符装饰器，或属性装饰器应用到每个实例成员。
- 参数装饰器，然后依次是方法装饰器，访问符装饰器，或属性装饰器应用到每个静态成员。
- 参数装饰器应用到构造函数。
- 类装饰器应用到类。
类装饰器
类装饰器在类声明之前被声明（紧靠着类声明）。 类装饰器应用于类构造函数，可以用来监视，修改或替换类定义。 类装饰器不能用在声明文件中( .d.ts)，也不能用在任何外部上下文中（比如 declare 的类）。
类装饰器表达式会在运行时当作函数被调用，类的构造函数作为其唯一的参数。
如果类装饰器返回一个值，它会使用提供的构造函数来替换类的声明。如果要返回一个新的构造函数，必须注意处理好原来的原型链。 在运行时的装饰器调用逻辑中不会做这些。
function sealed(constructor: Function) { Object.seal(constructor); Object.seal(constructor.prototype);
}
@sealed class Greeter {
greeting: string;
constructor(message: string) { this.greeting = message;
}
greet() { return "Hello, " + this.greeting;
}
}以上代码，当 @sealed 被执行的时候，它将密封此类的构造函数和原型。
方法装饰器
方法装饰器声明在一个方法的声明之前（紧靠着方法声明）。 它会被应用到方法的属性描述符上，可以用来监视，修改或者替换方法定义。 方法装饰器不能用在声明文件( .d.ts)，重载或者任何外部上下文（比如declare的类）中。
方法装饰器表达式会在运行时当作函数被调用，传入下列3个参数：
- 对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。
- 成员的名字。
- 成员的属性描述符。
如果代码输出目标版本小于 ES5，属性描述符将会是 undefined。
如果方法装饰器返回一个值，它会被用作方法的属性描述符。如果代码输出目标版本小于 ES5 返回值会被忽略。
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(false) 是一个装饰器工厂。 当装饰器 @enumerable(false) 被调用时，它会修改属性描述符的 enumerable 属性。
访问器装饰器
访问器装饰器声明在一个访问器的声明之前（紧靠着访问器声明）。 访问器装饰器应用于访问器的 属性描述符并且可以用来监视，修改或替换一个访问器的定义。 访问器装饰器不能用在声明文件中（.d.ts），或者任何外部上下文（比如 declare 的类）里。
TypeScript 不允许同时装饰一个成员的 get 和 set 访问器。取而代之的是，一个成员的所有装饰的必须应用在文档顺序的第一个访问器上。这是因为，在装饰器应用于一个属性描述符时，它联合了 get 和 set 访问器，而不是分开声明的。
访问器装饰器表达式会在运行时当作函数被调用，传入下列3个参数：
- 对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。
- 成员的名字。
- 成员的属性描述符。
如果代码输出目标版本小于 ES5，Property Descriptor 将会是 undefined。
如果访问器装饰器返回一个值，它会被用作方法的属性描述符。如果代码输出目标版本小于 ES5 返回值会被忽略。
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; }
}属性装饰器
属性装饰器声明在一个属性声明之前（紧靠着属性声明）。 属性装饰器不能用在声明文件中（.d.ts），或者任何外部上下文（比如 declare的类）里。
属性装饰器表达式会在运行时当作函数被调用，传入下列2个参数：
- 对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。
- 成员的名字。
属性描述符不会做为参数传入属性装饰器，这与TypeScript是如何初始化属性装饰器的有关。 因为目前没有办法在定义一个原型对象的成员时描述一个实例属性，并且没办法监视或修改一个属性的初始化方法。 因此，属性描述符只能用来监视类中是否声明了某个名字的属性。
如果属性装饰器返回一个值，它会被用作方法的属性描述符。如果代码输出目标版本小于 ES5，返回值会被忽略。
如果访问符装饰器返回一个值，它会被用作方法的属性描述符。
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);
} class PropGreeter {
@format("Hello, %s")
greeting: string;
constructor(message: string) { this.greeting = message;
}
greet() { let formatString = getFormat(this, "greeting"); return formatString.replace("%s", this.greeting);
}
}以上代码，这个 @format(“Hello, %s”) 装饰器是个装饰器工厂。 当 @format(“Hello, %s”) 被调用时，它添加一条这个属性的元数据，通过reflect-metadata 库里的 Reflect.metadata 函数。 当 getFormat 被调用时，它读取格式的元数据。
参数装饰器
参数装饰器声明在一个参数声明之前（紧靠着参数声明）。 参数装饰器应用于类构造函数或方法声明。 参数装饰器不能用在声明文件（.d.ts），重载或其它外部上下文（比如 declare的类）里。
参数装饰器表达式会在运行时当作函数被调用，传入下列3个参数：
- 对于静态成员来说是类的构造函数，对于实例成员是类的原型对象。
- 成员的名字。
- 参数在函数参数列表中的索引。
参数装饰器只能用来监视一个方法的参数是否被传入。参数装饰器的返回值会被忽略。
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);
}
} class ParaGreeter {
greeting: string;
constructor(message: string) { this.greeting = message;
}
@validate
greet( @required name: string) { return "Hello " + name + ", " + this.greeting;
}
}以上代码，@required装饰器添加了元数据实体把参数标记为必需的。 @validate装饰器把greet方法包裹在一个函数里在调用原先的函数前验证函数参数。
reflect-metadata
使用 reflect-metadata 库来支持实验性的 metadata API。 这个库还不是 ECMAScript 标准的一部分。 然而，当装饰器被 ECMAScript 官方标准采纳后，这些扩展也将被推荐给 ECMAScript 以采纳。
通过 npm 安装 reflect-metadata 库：
npm install reflect-metadata --saveTypeScript 支持为带有装饰器的声明生成元数据，需要在命令行或 tsconfig.json 里启用 emitDecoratorMetadata 编译器选项。
命令行:
tsc --target ES5 --experimentalDecorators --emitDecoratorMetadatatsconfig.json
{
"compilerOptions": { "target": "ES5", "experimentalDecorators": true, "emitDecoratorMetadata": true } }当启用后，只要reflect-metadata库被引入了，设计阶段添加的类型信息可以在运行时使用。
参考资料
- TypeScript官网
- TypeScript中文网
- TypeScript 中的 Decorator & 元数据反射：从小白到专家（部分 I）
- TypeScript 中的 Decorator & 元数据反射：从小白到专家（部分 IV）
其他
- 完整代码：https://github.com/guyoung/GyWxappCases/tree/master/TypeScript
- 微信小程序Canvas增强组件WeZRender：https://github.com/guyoung/WeZRender
以上是关于使用TypeScript开发微信小程序（10）——装饰器（Decorator）的主要内容，如果未能解决你的问题，请参考以下文章
使用TypeScript开发微信小程序——基础：数据类型（Type）