修饰器(decorator)是一个函数,用来修改类的行为。这是es7的一个提案,目前babel转码器已经支持。
修饰器对类的行为的改变,是代码编译时发生的,而不是在运行时。这意味着,修饰器能在编译阶段运行代码。
function testable(target) {
target.istestable = true;
}
@testable
class mytestableclass {}
console.log(mytestableclass.istestable) // true
上面代码中,@testable
就是一个修饰器。它修改了mytestableclass
这个类的行为,为它加上了静态属性istestable
。
基本上,修饰器的行为就是下面这样。
@decorator
class a {}
// 等同于
class a {}
a = decorator(a) || a;
也就是说,修饰器本质就是编译时执行的函数。
修饰器函数的第一个参数,就是所要修饰的目标类。
function testable(target) {
// ...
}
上面代码中,testable
函数的参数target
,就是会被修饰的类。
如果觉得一个参数不够用,可以在修饰器外面再封装一层函数。
function testable(istestable) {
return function(target) {
target.istestable = istestable;
}
}
@testable(true)
class mytestableclass {}
mytestableclass.istestable // true
@testable(false)
class myclass {}
myclass.istestable // false
上面代码中,修饰器testable
可以接受参数,这就等于可以修改修饰器的行为。
前面的例子是为类添加一个静态属性,如果想添加实例属性,可以通过目标类的prototype
对象操作。
function testable(target) {
target.prototype.istestable = true;
}
@testable
class mytestableclass {}
let obj = new mytestableclass();
obj.istestable // true
上面代码中,修饰器函数testable
是在目标类的prototype
对象上添加属性,因此就可以在实例上调用。
下面是另外一个例子。
// 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
方法。
此时,修饰器函数一共可以接受三个参数,第一个参数是所要修饰的目标对象,第二个参数是所要修饰的属性名,第三个参数是该属性的描述对象。
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
修饰器的作用就是在执行原始的操作之前,执行一次console.log
,从而达到输出日志的目的。
修饰器有注释的作用。
@testable
class person {
@readonly
@nonenumerable
name() { return `${this.first} ${this.last}` }
}
从上面代码中,我们一眼就能看出,person
类是可测试的,而name
方法是只读和不可枚举的。
如果同一个方法有多个修饰器,会像剥洋葱一样,先从外到内进入,然后由内向外执行。
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)
先进入,但是内层修饰器@dec(2)
先执行。
除了注释,修饰器还能用来类型检查。所以,对于类来说,这项功能相当有用。从长期来看,它将是javascript代码静态分析的重要工具。
修饰器只能用于类和类的方法,不能用于函数,因为存在函数提升。
var counter = 0;
var add = function () {
counter++;
};
@add
function foo() {
}
上面的代码,意图是执行后counter
等于1,但是实际上结果是counter
等于0。因为函数提升,使得实际执行的代码是下面这样。
var counter;
var add;
@add
function foo() {
}
counter = 0;
add = function () {
counter++;
};
下面是另一个例子。
var readonly = require("some-decorator");
@readonly
function foo() {
}
上面代码也有问题,因为实际执行是下面这样。
var readonly;
@readonly
function foo() {
}
readonly = require("some-decorator");
总之,由于存在函数提升,使得修饰器不能用于函数。类是不会提升的,所以就没有这方面的问题。
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
修饰器导致的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
我们可以使用修饰器,使得对象的方法被调用时,自动发出一个事件。
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
,使得原方法被调用时,会自动发出一个事件。它使用的事件“发布/订阅”库是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() {
// ...
}
}
以后,只要调用somemethod
或者anothermethod
,就会自动发出一个事件。
let foo = new foocomponent();
foo.somemethod() // 在"component"频道发布"foo.some.message"事件,附带的数据是{ my: "data" }
foo.anothermethod() // 在"/"频道发布"foo.some.other"事件,不附带数据
在修饰器的基础上,可以实现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
类,导致myclass
的实例obj
对象都具有foo
方法。这就是“混入”模式的一个简单实现。
下面,我们部署一个通用脚本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这个修饰器,实现了在myclass类上面“混入”foo对象的foo
方法。
不过,上面的方法会改写myclass
类的prototype
对象,如果不喜欢这一点,也可以通过类的继承实现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
作为参数,然后返回一个继承superclass
的子类,该子类包含一个foo
方法。
接着,目标类再去继承这个混入类,就达到了“混入”foo
方法的目的。
class myclass extends mymixin(mybaseclass) {
/* ... */
}
let c = new myclass();
c.foo(); // "foo from mymixin"
如果需要“混入”多个方法,就生成多个混入类。
class myclass extends mixin1(mixin2(mybaseclass)) {
/* ... */
}
这种写法的一个好处,是可以调用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();
}
}
上面代码中,每一次混入
发生时,都调用了父类的super.foo
方法,导致父类的同名方法没有被覆盖,行为被保留了下来。
new c().foo()
// foo from c
// foo from mixin1
// foo from mixin2
// foo from s
trait也是一种修饰器,效果与mixin类似,但是提供更多功能,比如防止同名方法的冲突、排除混入某些方法、为混入的方法起别名等等。
下面采用traits-decorator这个第三方模块作为例子。这个模块提供的traits修饰器,不仅可以接受对象,还可以接受es6类作为参数。
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方法,结果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方法,可以结合起来使用。
@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转码器已经支持decorator。
首先,安装babel-core
和babel-plugin-transform-decorators
。由于后者包括在babel-preset-stage-0
之中,所以改为安装babel-preset-stage-0
亦可。
$ npm install babel-core babel-plugin-transform-decorators
然后,设置配置文件.babelrc
。
{
"plugins": ["transform-decorators"]
}
这时,babel就可以对decorator转码了。
脚本中打开的命令如下。
babel.transform("code", {plugins: ["transform-decorators"]})
babel的官方网站提供一个在线转码器,只要勾选experimental,就能支持decorator的在线转码。