decorator 装饰器 @

装饰器是一种函数，写成 @ + 函数名，用来装饰类和类方法，添加或修改相应的功能。

@frozen                 // 用在类本身的装饰器
class Foo {
  @configurable(false)  // 用在类方法的装饰器
  @enumerable(true)     // 用在类方法的装饰器
  method() {}

  @throttle(500)        // 用在类方法的装饰器
  expensiveMethod() {}
}

一、类的装饰

1、基本用法

装饰器可以用来装饰整个类。

@testable
class MyTestableClass {
  // ...
}

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

MyTestableClass.isTestable // true

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

基本上，装饰器的行为就是下面这样。

@decorator
class A {}

// 等同于

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

可以看到，装饰器是一个对类进行处理的函数。装饰器函数的第一个参数，就是要装饰的目标类。

2、装饰器传参

如果一个参数不够用，可以在装饰器外再封装一层函数。

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

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

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

上面的装饰器 testable 可以接受参数，这就等于可以修改装饰器的行为。

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

3、装饰器添加实例属性

上面的装饰器 testable 为类添加一个静态属性，如果想添加实例属性，可以通过目标类的 prototype 对象操作。

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

@testable
class MyTestableClass {}

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

上面装饰器 testable 在目标类的 prototype 对象上添加属性，因此就可以在实例上调用。

4、react-redux 中 connect

React 与 Redux 库结合使用时，常常需要写成下面这样：

class MyReactComponent extends React.Component {}

export default connect(mapStateToProps, mapDispatchToProps)(MyReactComponent)

有了装饰器，就可以优化上面的代码：

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

二、类方法的装饰

1、基本用法

装饰器不仅可以装饰类，还可以装饰类的属性。

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

上面装饰器 readonly 用来装饰类的 name 方法。

2、装饰器的参数

装饰器函数 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)

可以看到，装饰器（readonly）会修改属性的描述对象（descriptor），然后被修改的描述对象再用来定义属性。

下面是另一个例子，修改属性描述对象的 enumerable 属性，使得该属性不可遍历。

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

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

3、输出日志装饰器

下面的 @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(this, 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 方法是只读和不可枚举的。

下面是使用 Decorator 写法的组件，看上去一目了然：

@Component({
  tag: 'my-component',
  styleUrl: 'my-component.scss'
})
export class MyComponent {
  @Prop() first: string;
  @Prop() last: string;
  @State() isVisible: boolean = true;

  render() {
    return (
      <p>Hello, my name is {this.first} {this.last}</p>
    );
  }
}

4、装饰器执行顺序

如果同一个方法有多个装饰器，会像剥洋葱一样，先从外到内进入，然后由内向外执行：

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，但实际上结果是 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");

总之，由于函数声明提升，使得装饰器不能用于函数。

如果一定要装饰函数，可以采用高阶函数的形式直接执行。

function doSomething(name) {
  console.log('Hello, ' + name)
}

function loggingDecorator(wrapped) {
  return function () {
    console.log('Starting')
    const result = wrapped.apply(this, arguments)
    console.log('Finished')
    return result
  }
}

const wrapped = loggingDecorator(doSomething)