[js] decorator
1 类的修饰
修饰器对类的行为的改变,是代码编译时发生的,而不是在运行时。
这意味着,修饰器能在编译阶段运行代码。
修饰器本质就是编译时执行的函数。
修饰器函数的第一个参数,就是所要修饰的目标类。
基本的修饰器
@decorator
class A {}
// 等同于
class A {}
A = decorator(A) || A;
添加静态属性
testable函数的参数target,就是会被修饰的类。
@testable就是一个修饰器。
它修改了MyTestableClass这个类的行为,为它加上了静态属性isTestable。
function testable(target) {
target.isTestable = true;
}
@testable
class MyTestableClass {}
console.log(MyTestableClass.isTestable) // true
添加实例属性
通过目标类的prototype对象操作。
function testable(target) {
target.prototype.isTestable = true;
}
@testable
class MyTestableClass {}
let obj = new MyTestableClass();
obj.isTestable // true
mixins
// 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'
用Object.assign()模拟这个功能。
const Foo = {
foo() { console.log('foo') }
};
class MyClass {}
Object.assign(MyClass.prototype, Foo);
let obj = new MyClass();
obj.foo() // 'foo'
2 方法的修饰
修饰器不仅可以修饰类,还可以修饰类的属性。
修饰类的属性
修饰器readonly用来修饰“类”的name方法。
class Person {
@readonly
name() { return `${this.first} ${this.last}` }
}
修饰器(readonly)会修改属性的描述对象(descriptor),然后被修改的描述对象再用来定义属性。
此时,修饰器函数一共可以接受三个参数,第一个参数是所要修饰的目标对象,第二个参数是所要修饰的属性名,第三个参数是该属性的描述对象。
修饰器(readonly)会修改属性的描述对象(descriptor),然后被修改的描述对象再用来定义属性。
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);
修改enumerable
修改属性描述对象的enumerable属性,使得该属性不可遍历。
class Person {
@nonenumerable
get kidCount() { return this.children.length; }
}
function nonenumerable(target, name, descriptor) {
descriptor.enumerable = false;
return descriptor;
}
输出日志
@log修饰器,可以起到输出日志的作用。
@log修饰器的作用就是在执行原始的操作之前,执行一次console.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);
执行顺序
如果同一个方法有多个修饰器,会像剥洋葱一样,先从外到内进入,然后由内向外执行。
外层修饰器@dec(1)先进入,但是内层修饰器@dec(2)先执行。
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
类型检查?
除了注释,修饰器还能用来类型检查。
所以,对于类来说,这项功能相当有用。从长期来看,它将是JavaScript代码静态分析的重要工具。
为什么修饰器不能用于函数
修饰器只能用于类和类的方法,不能用于函数,因为存在函数提升。
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++;
};
另一个例子
var readOnly = require("some-decorator");
@readOnly
function foo() {
}
//实际执行是下面这样。
var readOnly;
@readOnly
function foo() {
}
readOnly = require("some-decorator");
3 Mixin
在修饰器的基础上,可以实现Mixin模式。
所谓Mixin模式,就是对象继承的一种替代方案,中文译为“混入”(mix in),意为在一个对象之中混入另外一个对象的方法。
Object.assign
对象Foo有一个foo方法,通过Object.assign方法,可以将foo方法“混入”MyClass类,导致MyClass的实例obj对象都具有foo方法。
这就是“混入”模式的一个简单实现。
const Foo = {
foo() { console.log('foo') }
};
class MyClass {}
Object.assign(MyClass.prototype, Foo);
let obj = new MyClass();
obj.foo() // 'foo'
mixins.js
注意这种方法会改写MyClass类的prototype对象
//mixins.js
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"
继承
MyMixin是一个混入类生成器,接受superclass作为参数,然后返回一个继承superclass的子类,该子类包含一个foo方法。
目标类再去继承这个混入类,就达到了“混入”foo方法的目的。
let MyMixin = (superclass) => class extends superclass {
foo() {
console.log('foo from MyMixin');
}
};
//目标类
class MyClass extends MyMixin(MyBaseClass) {
/* ... */
}
let c = new MyClass();
c.foo(); // "foo from MyMixin"
如果需要“混入”多个方法,就生成多个混入类。
可以调用super,可以避免在“混入”过程中覆盖父类的同名方法。
每一次混入发生时,都调用了父类的super.foo方法,导致父类的同名方法没有被覆盖,行为被保留了下来。
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();
}
}
new C().foo()
// foo from C
// foo from Mixin1
// foo from Mixin2
// foo from S