ES7中的装饰器

装饰器

装饰器(Decorator)是ES7的一个语法，是一种与类相关的语法，用来注释或修改类和类的方法。

装饰器是一种函数，写成 @ + 函数名。它可以放在类和类方法的定义前面

@frozen class Foo {
  @configurable(false)
  @enumerable(true)
  method() {}

  @throttle(500)
  expensiveMethod() {}
}

上面一共用了四个装饰器，一个用在类本身，另外三个用在类方法。

装饰器(Decorator) 也并不是一个新的概念，其他语言比如 Java，Python等已经很早就有了，ES7中的装饰器(Decorator)借鉴了其他语言的写法，不过依赖于ES5的Object.defineProperty 方法。

类的装饰

@testable
class MyTestableClass {
  // ...
}

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

MyTestableClass.isTestable // true

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

@decorator
class A {}

// 等同于

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

也就是说，装饰器是一个对类进行处理的函数。装饰器函数的第一个参数，就是所要装饰的目标类。

如果想实现添加多个参数的功能，可以在装饰器外面再封装一层函数。

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

@testable('MyTestableClass')
class MyTestableClass {}
MyTestableClass.name // MyTestableClass

@testable('MyClass')
class MyClass {}
MyClass.isTestable // MyClassf

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

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'

实际开发中，react 与 Redux 库结合使用时，常常需要写成下面这样。

class MyReactComponent extends React.Component {};

export default connect(mapStateToProps, mapDispatchToProps)(MyReactComponent);

有了装饰器，就可以改写上面的代码。

@connect(mapStateToProps, mapDispatchToProps)
export default class MyReactComponent extends React.Component {};

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

方法的装饰

class Person {
  // 用来装饰”类“的 name 方法
  @readonly
  name() { return `${this.first} ${this.last}` }
}

装饰器函数readonly一共可以接受三个参数。

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);

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

装饰器还有注释的作用，比如上面我们可以一眼看出上面 name的方法是只读的。

除了注释，装饰器还能用来类型检查。所以，对于类来说，这项功能相当有用。从长期来看，它将是 JavaScript 代码静态分析的重要工具。在TypeScript里已做为一项实验性特性予以支持。

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

装饰器只能用于类和类的方法，不能用于函数，因为存在函数提升。

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]()是一个第三方模块，提供了几个常见的装饰器。

@autobind：使得方法中的this对象，绑定原始对象
@readonly：使得属性或方法不可写。
@override：检查子类的方法，是否正确覆盖了父类的同名方法，如果不正确会报错。
@deprecate (别名@deprecated)：在控制台显示一条警告，表示该方法将废除。

链接: https://www.fly63.com/article/detial/8152