閱讀(18.7k) 書(shū)簽贊(3) 我要糾錯(cuò)

ECMAScript 6 修飾器（Decorator）

2018-09-20 17:19 更新

類(lèi)的修飾
方法的修飾
為什么修飾器不能用于函數(shù)？
core-decorators.js
使用修飾器實(shí)現(xiàn)自動(dòng)發(fā)布事件
Mixin
Trait
Babel轉(zhuǎn)碼器的支持

類(lèi)的修飾

修飾器（Decorator）是一個(gè)函數(shù)，用來(lái)修改類(lèi)的行為。這是ES7的一個(gè)提案，目前Babel轉(zhuǎn)碼器已經(jīng)支持。

修飾器對(duì)類(lèi)的行為的改變，是代碼編譯時(shí)發(fā)生的，而不是在運(yùn)行時(shí)。這意味著，修飾器能在編譯階段運(yùn)行代碼。

function testable(target) {
  target.isTestable = true;
}

@testable
class MyTestableClass {}

console.log(MyTestableClass.isTestable) // true

上面代碼中，@testable就是一個(gè)修飾器。它修改了MyTestableClass這個(gè)類(lèi)的行為，為它加上了靜態(tài)屬性isTestable。

基本上，修飾器的行為就是下面這樣。

@decorator
class A {}

// 等同于

class A {}
A = decorator(A) || A;

也就是說(shuō)，修飾器本質(zhì)就是編譯時(shí)執(zhí)行的函數(shù)。

修飾器函數(shù)的第一個(gè)參數(shù)，就是所要修飾的目標(biāo)類(lèi)。

function testable(target) {
  // ...
}

上面代碼中，testable函數(shù)的參數(shù)target，就是會(huì)被修飾的類(lèi)。

如果覺(jué)得一個(gè)參數(shù)不夠用，可以在修飾器外面再封裝一層函數(shù)。

function testable(isTestable) {
  return function(target) {
    target.isTestable = isTestable;
  }
}

@testable(true)
class MyTestableClass {}
MyTestableClass.isTestable // true

@testable(false)
class MyClass {}
MyClass.isTestable // false

上面代碼中，修飾器testable可以接受參數(shù)，這就等于可以修改修飾器的行為。

前面的例子是為類(lèi)添加一個(gè)靜態(tài)屬性，如果想添加實(shí)例屬性，可以通過(guò)目標(biāo)類(lèi)的prototype對(duì)象操作。

function testable(target) {
  target.prototype.isTestable = true;
}

@testable
class MyTestableClass {}

let obj = new MyTestableClass();
obj.isTestable // true

上面代碼中，修飾器函數(shù)testable是在目標(biāo)類(lèi)的prototype對(duì)象上添加屬性，因此就可以在實(shí)例上調(diào)用。

下面是另外一個(gè)例子。

// mixins.js
export function mixins(...list) {
  return function (target) {
    Object.assign(target.prototype, ...list)
  }
}

// main.js
import { mixins } from './mixins'

const Foo = {
  foo() { console.log('foo') }
};

@mixins(Foo)
class MyClass {}

let obj = new MyClass();
obj.foo() // 'foo'

上面代碼通過(guò)修飾器mixins，把Foo類(lèi)的方法添加到了MyClass的實(shí)例上面。可以用Object.assign()模擬這個(gè)功能。

const Foo = {
  foo() { console.log('foo') }
};

class MyClass {}

Object.assign(MyClass.prototype, Foo);

let obj = new MyClass();
obj.foo() // 'foo'

方法的修飾

修飾器不僅可以修飾類(lèi)，還可以修飾類(lèi)的屬性。

class Person {
  @readonly
  name() { return `${this.first} ${this.last}` }
}

上面代碼中，修飾器readonly用來(lái)修飾“類(lèi)”的name方法。

此時(shí)，修飾器函數(shù)一共可以接受三個(gè)參數(shù)，第一個(gè)參數(shù)是所要修飾的目標(biāo)對(duì)象，第二個(gè)參數(shù)是所要修飾的屬性名，第三個(gè)參數(shù)是該屬性的描述對(duì)象。

function readonly(target, name, descriptor){
  // descriptor對(duì)象原來(lái)的值如下
  // {
  //   value: specifiedFunction,
  //   enumerable: false,
  //   configurable: true,
  //   writable: true
  // };
  descriptor.writable = false;
  return descriptor;
}

readonly(Person.prototype, 'name', descriptor);
// 類(lèi)似于
Object.defineProperty(Person.prototype, 'name', descriptor);

上面代碼說(shuō)明，修飾器（readonly）會(huì)修改屬性的描述對(duì)象（descriptor），然后被修改的描述對(duì)象再用來(lái)定義屬性。

下面是另一個(gè)例子，修改屬性描述對(duì)象的enumerable屬性，使得該屬性不可遍歷。

class Person {
  @nonenumerable
  get kidCount() { return this.children.length; }
}

function nonenumerable(target, name, descriptor) {
  descriptor.enumerable = false;
  return descriptor;
}

下面的@log修飾器，可以起到輸出日志的作用。

class Math {
  @log
  add(a, b) {
    return a + b;
  }
}

function log(target, name, descriptor) {
  var oldValue = descriptor.value;

  descriptor.value = function() {
    console.log(`Calling "${name}" with`, arguments);
    return oldValue.apply(null, arguments);
  };

  return descriptor;
}

const math = new Math();

// passed parameters should get logged now
math.add(2, 4);

上面代碼中，@log修飾器的作用就是在執(zhí)行原始的操作之前，執(zhí)行一次console.log，從而達(dá)到輸出日志的目的。

修飾器有注釋的作用。

@testable
class Person {
  @readonly
  @nonenumerable
  name() { return `${this.first} ${this.last}` }
}

從上面代碼中，我們一眼就能看出，Person類(lèi)是可測(cè)試的，而name方法是只讀和不可枚舉的。

如果同一個(gè)方法有多個(gè)修飾器，會(huì)像剝洋蔥一樣，先從外到內(nèi)進(jìn)入，然后由內(nèi)向外執(zhí)行。

function dec(id){
    console.log('evaluated', id);
    return (target, property, descriptor) => console.log('executed', id);
}

class Example {
    @dec(1)
    @dec(2)
    method(){}
}
// evaluated 1
// evaluated 2
// executed 2
// executed 1

上面代碼中，外層修飾器@dec(1)先進(jìn)入，但是內(nèi)層修飾器@dec(2)先執(zhí)行。

除了注釋?zhuān)揎椘鬟€能用來(lái)類(lèi)型檢查。所以，對(duì)于類(lèi)來(lái)說(shuō)，這項(xiàng)功能相當(dāng)有用。從長(zhǎng)期來(lái)看，它將是JavaScript代碼靜態(tài)分析的重要工具。

為什么修飾器不能用于函數(shù)？

修飾器只能用于類(lèi)和類(lèi)的方法，不能用于函數(shù)，因?yàn)榇嬖诤瘮?shù)提升。

var counter = 0;

var add = function () {
  counter++;
};

@add
function foo() {
}

上面的代碼，意圖是執(zhí)行后counter等于1，但是實(shí)際上結(jié)果是counter等于0。因?yàn)楹瘮?shù)提升，使得實(shí)際執(zhí)行的代碼是下面這樣。

var counter;
var add;

@add
function foo() {
}

counter = 0;

add = function () {
  counter++;
};

下面是另一個(gè)例子。

var readOnly = require("some-decorator");

@readOnly
function foo() {
}

上面代碼也有問(wèn)題，因?yàn)閷?shí)際執(zhí)行是下面這樣。

var readOnly;

@readOnly
function foo() {
}

readOnly = require("some-decorator");

總之，由于存在函數(shù)提升，使得修飾器不能用于函數(shù)。類(lèi)是不會(huì)提升的，所以就沒(méi)有這方面的問(wèn)題。

core-decorators.js

core-decorators.js是一個(gè)第三方模塊，提供了幾個(gè)常見(jiàn)的修飾器，通過(guò)它可以更好地理解修飾器。

（1）@autobind

autobind修飾器使得方法中的this對(duì)象，綁定原始對(duì)象。

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修飾器使得屬性或方法不可寫(xiě)。

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修飾器檢查子類(lèi)的方法，是否正確覆蓋了父類(lèi)的同名方法，如果不正確會(huì)報(bào)錯(cuò)。

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修飾器在控制臺(tái)顯示一條警告，表示該方法將廢除。

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修飾器抑制decorated修飾器導(dǎo)致的console.warn()調(diào)用。但是，異步代碼發(fā)出的調(diào)用除外。

import { suppressWarnings } from 'core-decorators';

class Person {
  @deprecated
  facepalm() {}

  @suppressWarnings
  facepalmWithoutWarning() {
    this.facepalm();
  }
}

let person = new Person();

person.facepalmWithoutWarning();
// no warning is logged

使用修飾器實(shí)現(xiàn)自動(dòng)發(fā)布事件

我們可以使用修飾器，使得對(duì)象的方法被調(diào)用時(shí)，自動(dòng)發(fā)出一個(gè)事件。

import postal from "postal/lib/postal.lodash";

export default function publish(topic, channel) {
  return function(target, name, descriptor) {
    const fn = descriptor.value;

    descriptor.value = function() {
      let value = fn.apply(this, arguments);
      postal.channel(channel || target.channel || "/").publish(topic, value);
    };
  };
}

上面代碼定義了一個(gè)名為publish的修飾器，它通過(guò)改寫(xiě)descriptor.value，使得原方法被調(diào)用時(shí)，會(huì)自動(dòng)發(fā)出一個(gè)事件。它使用的事件“發(fā)布/訂閱”庫(kù)是Postal.js。

它的用法如下。

import publish from "path/to/decorators/publish";

class FooComponent {
  @publish("foo.some.message", "component")
  someMethod() {
    return {
      my: "data"
    };
  }
  @publish("foo.some.other")
  anotherMethod() {
    // ...
  }
}

以后，只要調(diào)用someMethod或者anotherMethod，就會(huì)自動(dòng)發(fā)出一個(gè)事件。

let foo = new FooComponent();

foo.someMethod() // 在"component"頻道發(fā)布"foo.some.message"事件，附帶的數(shù)據(jù)是{ my: "data" }
foo.anotherMethod() // 在"/"頻道發(fā)布"foo.some.other"事件，不附帶數(shù)據(jù)

Mixin

在修飾器的基礎(chǔ)上，可以實(shí)現(xiàn)Mixin模式。所謂Mixin模式，就是對(duì)象繼承的一種替代方案，中文譯為“混入”（mix in），意為在一個(gè)對(duì)象之中混入另外一個(gè)對(duì)象的方法。

請(qǐng)看下面的例子。

const Foo = {
  foo() { console.log('foo') }
};

class MyClass {}

Object.assign(MyClass.prototype, Foo);

let obj = new MyClass();
obj.foo() // 'foo'

上面代碼之中，對(duì)象Foo有一個(gè)foo方法，通過(guò)Object.assign方法，可以將foo方法“混入”MyClass類(lèi)，導(dǎo)致MyClass的實(shí)例obj對(duì)象都具有foo方法。這就是“混入”模式的一個(gè)簡(jiǎn)單實(shí)現(xiàn)。

下面，我們部署一個(gè)通用腳本mixins.js，將mixin寫(xiě)成一個(gè)修飾器。

export function mixins(...list) {
  return function (target) {
    Object.assign(target.prototype, ...list);
  };
}

然后，就可以使用上面這個(gè)修飾器，為類(lèi)“混入”各種方法。

import { mixins } from './mixins';

const Foo = {
  foo() { console.log('foo') }
};

@mixins(Foo)
class MyClass {}

let obj = new MyClass();
obj.foo() // "foo"

通過(guò)mixins這個(gè)修飾器，實(shí)現(xiàn)了在MyClass類(lèi)上面“混入”Foo對(duì)象的foo方法。

不過(guò)，上面的方法會(huì)改寫(xiě)MyClass類(lèi)的prototype對(duì)象，如果不喜歡這一點(diǎn)，也可以通過(guò)類(lèi)的繼承實(shí)現(xiàn)mixin。

class MyClass extends MyBaseClass {
  /* ... */
}

上面代碼中，MyClass繼承了MyBaseClass。如果我們想在MyClass里面“混入”一個(gè)foo方法，一個(gè)辦法是在MyClass和MyBaseClass之間插入一個(gè)混入類(lèi)，這個(gè)類(lèi)具有foo方法，并且繼承了MyBaseClass的所有方法，然后MyClass再繼承這個(gè)類(lèi)。

let MyMixin = (superclass) => class extends superclass {
  foo() {
    console.log('foo from MyMixin');
  }
};

上面代碼中，MyMixin是一個(gè)混入類(lèi)生成器，接受superclass作為參數(shù)，然后返回一個(gè)繼承superclass的子類(lèi)，該子類(lèi)包含一個(gè)foo方法。

接著，目標(biāo)類(lèi)再去繼承這個(gè)混入類(lèi)，就達(dá)到了“混入”foo方法的目的。

class MyClass extends MyMixin(MyBaseClass) {
  /* ... */
}

let c = new MyClass();
c.foo(); // "foo from MyMixin"

如果需要“混入”多個(gè)方法，就生成多個(gè)混入類(lèi)。

class MyClass extends Mixin1(Mixin2(MyBaseClass)) {
  /* ... */
}

這種寫(xiě)法的一個(gè)好處，是可以調(diào)用super，因此可以避免在“混入”過(guò)程中覆蓋父類(lèi)的同名方法。

let Mixin1 = (superclass) => class extends superclass {
  foo() {
    console.log('foo from Mixin1');
    if (super.foo) super.foo();
  }
};

let Mixin2 = (superclass) => class extends superclass {
  foo() {
    console.log('foo from Mixin2');
    if (super.foo) super.foo();
  }
};

class S {
  foo() {
    console.log('foo from S');
  }
}

class C extends Mixin1(Mixin2(S)) {
  foo() {
    console.log('foo from C');
    super.foo();
  }
}

上面代碼中，每一次混入發(fā)生時(shí)，都調(diào)用了父類(lèi)的super.foo方法，導(dǎo)致父類(lèi)的同名方法沒(méi)有被覆蓋，行為被保留了下來(lái)。

new C().foo()
// foo from C
// foo from Mixin1
// foo from Mixin2
// foo from S

Trait

Trait也是一種修飾器，效果與Mixin類(lèi)似，但是提供更多功能，比如防止同名方法的沖突、排除混入某些方法、為混入的方法起別名等等。

下面采用traits-decorator這個(gè)第三方模塊作為例子。這個(gè)模塊提供的traits修飾器，不僅可以接受對(duì)象，還可以接受ES6類(lèi)作為參數(shù)。

import { traits } from 'traits-decorator';

class TFoo {
  foo() { console.log('foo') }
}

const TBar = {
  bar() { console.log('bar') }
};

@traits(TFoo, TBar)
class MyClass { }

let obj = new MyClass();
obj.foo() // foo
obj.bar() // bar

上面代碼中，通過(guò)traits修飾器，在MyClass類(lèi)上面“混入”了TFoo類(lèi)的foo方法和TBar對(duì)象的bar方法。

Trait不允許“混入”同名方法。

import { traits } from 'traits-decorator';

class TFoo {
  foo() { console.log('foo') }
}

const TBar = {
  bar() { console.log('bar') },
  foo() { console.log('foo') }
};

@traits(TFoo, TBar)
class MyClass { }
// 報(bào)錯(cuò)
// throw new Error('Method named: ' + methodName + ' is defined twice.');
//        ^
// Error: Method named: foo is defined twice.

上面代碼中，TFoo和TBar都有foo方法，結(jié)果traits修飾器報(bào)錯(cuò)。

一種解決方法是排除TBar的foo方法。

import { traits, excludes } from 'traits-decorator';

class TFoo {
  foo() { console.log('foo') }
}

const TBar = {
  bar() { console.log('bar') },
  foo() { console.log('foo') }
};

@traits(TFoo, TBar::excludes('foo'))
class MyClass { }

let obj = new MyClass();
obj.foo() // foo
obj.bar() // bar

上面代碼使用綁定運(yùn)算符（::）在TBar上排除foo方法，混入時(shí)就不會(huì)報(bào)錯(cuò)了。

另一種方法是為T(mén)Bar的foo方法起一個(gè)別名。

import { traits, alias } from 'traits-decorator';

class TFoo {
  foo() { console.log('foo') }
}

const TBar = {
  bar() { console.log('bar') },
  foo() { console.log('foo') }
};

@traits(TFoo, TBar::alias({foo: 'aliasFoo'}))
class MyClass { }

let obj = new MyClass();
obj.foo() // foo
obj.aliasFoo() // foo
obj.bar() // bar

上面代碼為T(mén)Bar的foo方法起了別名aliasFoo，于是MyClass也可以混入TBar的foo方法了。

alias和excludes方法，可以結(jié)合起來(lái)使用。

@traits(TExample::excludes('foo','bar')::alias({baz:'exampleBaz'}))
class MyClass {}

上面代碼排除了TExample的foo方法和bar方法，為baz方法起了別名exampleBaz。

as方法則為上面的代碼提供了另一種寫(xiě)法。

@traits(TExample::as({excludes:['foo', 'bar'], alias: {baz: 'exampleBaz'}}))
class MyClass {}

Babel轉(zhuǎn)碼器的支持

目前，Babel轉(zhuǎn)碼器已經(jīng)支持Decorator。

首先，安裝babel-core和babel-plugin-transform-decorators。由于后者包括在babel-preset-stage-0之中，所以改為安裝babel-preset-stage-0亦可。

$ npm install babel-core babel-plugin-transform-decorators

然后，設(shè)置配置文件.babelrc。

{
  "plugins": ["transform-decorators"]
}

這時(shí)，Babel就可以對(duì)Decorator轉(zhuǎn)碼了。

腳本中打開(kāi)的命令如下。

babel.transform("code", {plugins: ["transform-decorators"]})

Babel的官方網(wǎng)站提供一個(gè)在線轉(zhuǎn)碼器，只要勾選Experimental，就能支持Decorator的在線轉(zhuǎn)碼。

以上內(nèi)容是否對(duì)您有幫助：

← ECMAScript 6 Class

ECMAScript 6 Module →

寫(xiě)筆記

我要補(bǔ)充

ECMAScript 6 修飾器（Decorator）

類(lèi)的修飾

方法的修飾

為什么修飾器不能用于函數(shù)？

core-decorators.js

使用修飾器實(shí)現(xiàn)自動(dòng)發(fā)布事件

Mixin

Trait

Babel轉(zhuǎn)碼器的支持

推薦文章

推薦教程

推薦課程

為什么修飾器不能用于函數(shù)？