装饰器

    装饰器（Decorator）是一种与类（class）相关的语法，用来注释或修改类和类方法。许多面向对象的语言都有这项功能，装饰器是一种函数，写成@ + 函数名。它可以放在类和类方法的定义前面。

@frozen class Foo {

  @configurable(false)

  @enumerable(true)

  method() {}

 

  @throttle(500)

  expensiveMethod() {}

}

代码中共使用了四个装饰器，一个用在类本身，另外三个用在类方法。它们不仅增加了代码的可读性，清晰地表达了意图，而且提供一种方便的手段，增加或修改类的功能。

 

类的装饰

装饰器可以用来装饰整个类。

上面代码中，@testable就是一个装饰器。它修改了MyTestableClass这个类的行为，为它加上了静态属性isTestable。testable函数的参数target是MyTestableClass类本身。

基本上，装饰器的行为就是下面这样。装饰器是一个对类进行处理的函数。装饰器函数的第一个参数，就是所要装饰的目标类。

@testable

class MyTestableClass {

  // ...

}

 

function testable(target) {

  target.isTestable = true;

}

 

MyTestableClass.isTestable // true

注意，装饰器对类的行为的改变，是代码编译时发生的，而不是在运行时。这意味着，装饰器能在编译阶段运行代码。也就是说，装饰器本质就是编译时执行的函数。

前面的例子是为类添加一个静态属性，如果想添加实例属性，可以通过目标类的prototype对象操作。

方法的装饰

装饰器不仅可以装饰类，还可以装饰类的属性。装饰器函数readonly一共可以接受三个参数。

装饰器第一个参数是类的原型对象，上例是Person.prototype，装饰器的本意是要“装饰”类的实例，但是这个时候实例还没生成，所以只能去装饰原型（这不同于类的装饰，那种情况时target参数指的是类本身）；第二个参数是所要装饰的属性名，第三个参数是该属性的描述对象。装饰器（readonly）会修改属性的描述对象（descriptor），然后被修改的描述对象再用来定义属性。

下面代码中，装饰器readonly用来装饰“类”的name方法。

class Person {

  @readonly

  name() { return `${this.first} ${this.last}` }

}

function readonly(target, name, descriptor){

  // descriptor对象原来的值如下

  // {

  //   value: specifiedFunction,

  //   enumerable: false,

  //   configurable: true,

  //   writable: true

  // };

  descriptor.writable = false;

  return descriptor;

}

 

readonly(Person.prototype, 'name', descriptor);

// 类似于

Object.defineProperty(Person.prototype, 'name', descriptor);

为什么装饰器不能用于函数？

装饰器只能用于类和类的方法，不能用于函数，因为存在函数提升。由于存在函数提升，使得装饰器不能用于函数。类是不会提升的，所以就没有这方面的问题。另一方面，如果一定要装饰函数，可以采用高阶函数的形式直接执行。

var counter = 0;

 

var add = function () {

  counter++;

};

 

@add

function foo() {

}

上面的代码，目的执行后counter等于 1，但是实际上结果是counter等于 0。因为函数提升，使得实际执行的代码是下面这样。

@add

function foo() {

}

 

var counter;

var add;

 

counter = 0;

 

add = function () {

  counter++;

};

core-decorators.js

core-decorators.js是一个第三方模块，提供了几个常见的装饰器，通过它可以更好地理解装饰器。

（1）@autobind

autobind装饰器使得方法中的this对象，绑定原始对象。

import { autobind } from 'core-decorators';

 

class Person {

  @autobind

  getPerson() {

    return this;

  }

}

let person = new Person();

let getPerson = person.getPerson;

 

getPerson() === person;

// true

（2）@readonly

readonly装饰器使得属性或方法不可写。

import { readonly } from 'core-decorators';

 

class Meal {

  @readonly

  entree = 'steak';

}

 

var dinner = new Meal();

dinner.entree = 'salmon';

// Cannot assign to read only property 'entree' of [object Object]

（3）@override

override装饰器检查子类的方法，是否正确覆盖了父类的同名方法，如果不正确会报错。

import { override } from 'core-decorators';

 

class Parent {

  speak(first, second) {}

}

 

class Child extends Parent {

  @override

  speak() {}

  // SyntaxError: Child#speak() does not properly override Parent#speak(first, second)

}

 

// or

 

class Child extends Parent {

  @override

  speaks() {}

  // SyntaxError: No descriptor matching Child#speaks() was found on the prototype chain.

  //

  //   Did you mean "speak"?

}

（4）@deprecate (别名@deprecated)

deprecate或deprecated装饰器在控制台显示一条警告，表示该方法将废除。

import { deprecate } from 'core-decorators';

 

class Person {

  @deprecate

  facepalm() {}

 

  @deprecate('We stopped facepalming')

  facepalmHard() {}

 

  @deprecate('We stopped facepalming', { url: 'http://knowyourmeme.com/memes/facepalm' })

  facepalmHarder() {}

}

 

let person = new Person();

 

person.facepalm();

// DEPRECATION Person#facepalm: This function will be removed in future versions.

 

person.facepalmHard();

// DEPRECATION Person#facepalmHard: We stopped facepalming

 

person.facepalmHarder();

// DEPRECATION Person#facepalmHarder: We stopped facepalming

//

//     See http://knowyourmeme.com/memes/facepalm for more details.

//

（5）@suppressWarnings

suppressWarnings装饰器抑制deprecated装饰器导致的console.warn()调用。但是，异步代码发出的调用除外。

import { suppressWarnings } from 'core-decorators';

 

class Person {

  @deprecated

  facepalm() {}

 

  @suppressWarnings

  facepalmWithoutWarning() {

    this.facepalm();

  }

}

 

let person = new Person();

 

person.facepalmWithoutWarning();

// no warning is logged

使用装饰器实现自动发布事件

我们可以使用装饰器，使得对象的方法被调用时，自动发出一个事件。

const postal = require("postal/lib/postal.lodash");

 

export default function publish(topic, channel) {

  const channelName = channel || '/';

  const msgChannel = postal.channel(channelName);

  msgChannel.subscribe(topic, v => {

    console.log('频道: ', channelName);

    console.log('事件: ', topic);

    console.log('数据: ', v);

  });

 

  return function(target, name, descriptor) {

    const fn = descriptor.value;

 

    descriptor.value = function() {

      let value = fn.apply(this, arguments);

      msgChannel.publish(topic, value);

    };

  };

}

上面代码定义了一个名为publish的装饰器，它通过改写descriptor.value，使得原方法被调用时，会自动发出一个事件。它使用的事件“发布/订阅”库是Postal.js。

它的用法如下。

// index.js

import publish from './publish';

 

class FooComponent {

  @publish('foo.some.message', 'component')

  someMethod() {

    return { my: 'data' };

  }

  @publish('foo.some.other')

  anotherMethod() {

    // ...

  }

}

 

let foo = new FooComponent();

 

foo.someMethod();

foo.anotherMethod();

以后，只要调用someMethod或者anotherMethod，就会自动发出一个事件。

$ bash-node index.js

频道:  component

事件:  foo.some.message

数据:  { my: 'data' }

 

频道:  /

事件:  foo.some.other

数据:  undefined