類的修飾
修飾器（Decorator）是一個函數(shù)太防，用來修改類的行為。這是ES7的一個提案捆等，目前Babel轉(zhuǎn)碼器已經(jīng)支持。
修飾器對類的行為的改變续室，是代碼編譯時發(fā)生的栋烤，而不是在運行時。這意味著挺狰，修飾器能在編譯階段運行代碼明郭。
function testable(target) {
target.isTestable = true;
}
@testable
class MyTestableClass {}
console.log(MyTestableClass.isTestable) // true
上面代碼中，@testable就是一個修飾器丰泊。它修改了MyTestableClass這個類的行為薯定，為它加上了靜態(tài)屬性isTestable。
基本上瞳购，修飾器的行為就是下面這樣话侄。
@decorator
class A {}
// 等同于
class A {}
A = decorator(A) || A;
也就是說，修飾器本質(zhì)就是編譯時執(zhí)行的函數(shù)学赛。
修飾器函數(shù)的第一個參數(shù)年堆，就是所要修飾的目標(biāo)類。
function testable(target) {
// ...
}
上面代碼中盏浇，testable函數(shù)的參數(shù)target变丧，就是會被修飾的類。
如果覺得一個參數(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ù)滴劲，這就等于可以修改修飾器的行為攻晒。
前面的例子是為類添加一個靜態(tài)屬性，如果想添加實例屬性哑芹，可以通過目標(biāo)類的prototype對象操作炎辨。
function testable(target) {
target.prototype.isTestable = true;
}
@testable
class MyTestableClass {}
let obj = new MyTestableClass();
obj.isTestable // true
上面代碼中，修飾器函數(shù)testable是在目標(biāo)類的prototype對象上添加屬性聪姿，因此就可以在實例上調(diào)用碴萧。
下面是另外一個例子乙嘀。
// 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'
上面代碼通過修飾器mixins，把Foo類的方法添加到了MyClass的實例上面破喻』⑿唬可以用Object.assign()模擬這個功能。
const Foo = {
foo() { console.log('foo') }
};
class MyClass {}
Object.assign(MyClass.prototype, Foo);
let obj = new MyClass();
obj.foo() // 'foo'
方法的修飾
修飾器不僅可以修飾類曹质，還可以修飾類的屬性婴噩。
class Person {
@readonly
name() { return `${this.first} ${this.last}` }
}
上面代碼中，修飾器readonly用來修飾“類”的name方法羽德。
此時几莽，修飾器函數(shù)一共可以接受三個參數(shù)，第一個參數(shù)是所要修飾的目標(biāo)對象宅静，第二個參數(shù)是所要修飾的屬性名章蚣，第三個參數(shù)是該屬性的描述對象。
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);
上面代碼說明姨夹，修飾器（readonly）會修改屬性的描述對象（descriptor）纤垂，然后被修改的描述對象再用來定義屬性。
下面是另一個例子磷账，修改屬性描述對象的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類是可測試的矛辕，而name方法是只讀和不可枚舉的。
如果同一個方法有多個修飾器付魔，會像剝洋蔥一樣聊品，先從外到內(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í)行妻坝。
除了注釋伸眶，修飾器還能用來類型檢查惊窖。所以，對于類來說厘贼，這項功能相當(dāng)有用界酒。從長期來看，它將是JavaScript代碼靜態(tài)分析的重要工具嘴秸。
為什么修飾器不能用于函數(shù)毁欣？
修飾器只能用于類和類的方法，不能用于函數(shù)岳掐，因為存在函數(shù)提升凭疮。
var counter = 0;
var add = function () {
counter++;
};
@add
function foo() {
}
上面的代碼，意圖是執(zhí)行后counter等于1串述，但是實際上結(jié)果是counter等于0哭尝。因為函數(shù)提升，使得實際執(zhí)行的代碼是下面這樣剖煌。
var counter;
var add;
@add
function foo() {
}
counter = 0;
add = function () {
counter++;
};
下面是另一個例子材鹦。
var readOnly = require("some-decorator");
@readOnly
function foo() {
}
上面代碼也有問題，因為實際執(zhí)行是下面這樣耕姊。
var readOnly;
@readOnly
function foo() {
}
readOnly = require("some-decorator");
總之桶唐，由于存在函數(shù)提升，使得修飾器不能用于函數(shù)茉兰。類是不會提升的尤泽，所以就沒有這方面的問題。
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修飾器抑制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
使用修飾器實現(xiàn)自動發(fā)布事件
我們可以使用修飾器，使得對象的方法被調(diào)用時，自動發(fā)出一個事件壕曼。
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);
};
};
}
上面代碼定義了一個名為publish的修飾器杠袱，它通過改寫descriptor.value，使得原方法被調(diào)用時窝稿，會自動發(fā)出一個事件楣富。它使用的事件“發(fā)布/訂閱”庫是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，就會自動發(fā)出一個事件踪少。
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ǔ)上援奢，可以實現(xiàn)Mixin模式兼犯。所謂Mixin模式，就是對象繼承的一種替代方案集漾，中文譯為“混入”（mix in）切黔，意為在一個對象之中混入另外一個對象的方法。
請看下面的例子具篇。
const Foo = {
foo() { console.log('foo') }
};
class MyClass {}
Object.assign(MyClass.prototype, Foo);
let obj = new MyClass();
obj.foo() // 'foo'
上面代碼之中纬霞，對象Foo有一個foo方法，通過Object.assign方法驱显，可以將foo方法“混入”MyClass類诗芜，導(dǎo)致MyClass的實例obj對象都具有foo方法。這就是“混入”模式的一個簡單實現(xiàn)埃疫。
下面伏恐，我們部署一個通用腳本mixins.js，將mixin寫成一個修飾器栓霜。
export function mixins(...list) {
return function (target) {
Object.assign(target.prototype, ...list);
};
}
然后翠桦，就可以使用上面這個修飾器，為類“混入”各種方法叙淌。
import { mixins } from './mixins';
const Foo = {
foo() { console.log('foo') }
};
@mixins(Foo)
class MyClass {}
let obj = new MyClass();
obj.foo() // "foo"
通過mixins這個修飾器秤掌，實現(xiàn)了在MyClass類上面“混入”Foo對象的foo方法。
不過鹰霍，上面的方法會改寫MyClass類的prototype對象，如果不喜歡這一點茵乱，也可以通過類的繼承實現(xiàn)mixin茂洒。
class MyClass extends MyBaseClass {
/* ... */
}
上面代碼中，MyClass繼承了MyBaseClass瓶竭。如果我們想在MyClass里面“混入”一個foo方法督勺，一個辦法是在MyClass和MyBaseClass之間插入一個混入類渠羞，這個類具有foo方法，并且繼承了MyBaseClass的所有方法智哀，然后MyClass再繼承這個類次询。
let MyMixin = (superclass) => class extends superclass {
foo() {
console.log('foo from MyMixin');
}
};
上面代碼中，MyMixin是一個混入類生成器瓷叫，接受superclass作為參數(shù)屯吊，然后返回一個繼承superclass的子類，該子類包含一個foo方法摹菠。
接著盒卸，目標(biāo)類再去繼承這個混入類，就達(dá)到了“混入”foo方法的目的次氨。
class MyClass extends MyMixin(MyBaseClass) {
/* ... */
}
let c = new MyClass();
c.foo(); // "foo from MyMixin"
如果需要“混入”多個方法蔽介，就生成多個混入類。
class MyClass extends Mixin1(Mixin2(MyBaseClass)) {
/* ... */
}
這種寫法的一個好處煮寡，是可以調(diào)用super虹蓄，因此可以避免在“混入”過程中覆蓋父類的同名方法。
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ā)生時武花，都調(diào)用了父類的super.foo方法，導(dǎo)致父類的同名方法沒有被覆蓋杈帐，行為被保留了下來体箕。
new C().foo()
// foo from C
// foo from Mixin1
// foo from Mixin2
// foo from S
Trait
Trait也是一種修飾器，效果與Mixin類似挑童，但是提供更多功能累铅，比如防止同名方法的沖突、排除混入某些方法站叼、為混入的方法起別名等等娃兽。
下面采用traits-decorator這個第三方模塊作為例子。這個模塊提供的traits修飾器尽楔，不僅可以接受對象投储，還可以接受ES6類作為參數(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
上面代碼中阔馋，通過traits修飾器玛荞，在MyClass類上面“混入”了TFoo類的foo方法和TBar對象的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 { }
// 報錯
// throw new Error('Method named: ' + methodName + ' is defined twice.');
// ^
// Error: Method named: foo is defined twice.
上面代碼中勋眯，TFoo和TBar都有foo方法，結(jié)果traits修飾器報錯。
一種解決方法是排除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
上面代碼使用綁定運算符（::）在TBar上排除foo方法塞蹭，混入時就不會報錯了。
另一種方法是為TBar的foo方法起一個別名讶坯。
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
上面代碼為TBar的foo方法起了別名aliasFoo番电，于是MyClass也可以混入TBar的foo方法了。
alias和excludes方法辆琅，可以結(jié)合起來使用漱办。
@traits(TExample::excludes('foo','bar')::alias({baz:'exampleBaz'}))
class MyClass {}
上面代碼排除了TExample的foo方法和bar方法，為baz方法起了別名exampleBaz涎跨。
as方法則為上面的代碼提供了另一種寫法洼冻。
@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"]
}
這時畜挥，Babel就可以對Decorator轉(zhuǎn)碼了。
腳本中打開的命令如下婴谱。
babel.transform("code", {plugins: ["transform-decorators"]})
Babel的官方網(wǎng)站提供一個在線轉(zhuǎn)碼器蟹但，只要勾選Experimental，就能支持Decorator的在線轉(zhuǎn)碼谭羔。
Decorator(修飾器)--轉(zhuǎn)自：阮一峰《ECMAScript 6 入門》
