可动态获取实例化对象的Typescript装饰器

可动态获取实例化对象的Typescript装饰器

1. 何为装饰器

Decorator is a special kind of declaration that can be attached to a class declarationmethodaccessorproperty, or parameter. Decorators use the form @expression, where expression must evaluate to a function that will be called at runtime with information about the decorated declaration.

— 摘选自官方文档

装饰器是一种特殊类型的声明,它能够被附加到类声明方法, 访问符属性参数上。 装饰器使用 @expression这种形式,expression求值后必须为一个函数,它会在运行时被调用,被装饰的声明信息做为参数传入。

2. 调用时机

参考官网的示例,编写以下代码:

// @experimentalDecorators
function decorator() {
  console.log("decorator(): factory evaluated");
  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    console.log("decorator(): called");
  };
}

class ExampleClass {
  @decorator()
  method() {
    console.log('method call');
  }

  constructor() {
    console.log('instance call');
  }
}

const ins = new ExampleClass();

ins.method();

在运行的时候发现,装饰器在类实例化前已经完成数据绑定操作,这时候在装饰器内部是没有办法拿到绑定对象的实例的,target对应的是ExampleClass的定义,而不是实例化后的对象。这时候在装饰器内部调用实例上的方法会报错。

[LOG]: "decorator(): factory evaluated" 
[LOG]: "decorator(): called" 
[LOG]: "instance call" 
[LOG]: "method call"  

3. 应对方案

Typescript/Javascript为实例化对象提供了一种访问器属性:getter/setter。只有在类实例化后,调用具体方法名才会执行。那对于装饰器来说,如果返回一个带有getter/setter的方法,那是否也可以把执行时机延后,等到拿到类实例化对象后再执行?

举个例子,假如当前类中有一个 preTask 函数需要在method函数前面执行,需要怎么做?我们稍微改造一下装饰器的实现,这时候装饰器返回的是一个带有getter的对象,getter在调用的时候,由于使用的是function声明,这时候this指向ExampleClass实例化后的对象,继而实现调用实例上的方法。

// @experimentalDecorators
function decorator() {
  console.log("decorator(): factory evaluated");
  return function (target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    const fn = descriptor.value;
    return {
      configurable: true,
      get() {
        console.log("decorator(): called");
        const boundFn = ((...args: any) => {
          (this as any).preTask();
          fn.bind(this)(...args);
        }).bind(this);
        return boundFn;
      }
    }
  };
}

class ExampleClass {
  @decorator()
  method() {
    console.log('method call');
  }

  preTask() {
    console.log('preTask call');
  }

  constructor() {
    console.log('instance call');
  }
}

const ins = new ExampleClass();

ins.method();

执行结果如下:

[LOG]: "decorator(): factory evaluated" 
[LOG]: "instance call" 
[LOG]: "decorator(): called" 
[LOG]: "preTask call" 
[LOG]: "method call" 

可以发现装饰器的运行时机被延后到类实例化后,从而能够调用类实例化对象上的方法。

4. 参考

[1] https://github.com/andreypopp/autobind-decorator/blob/master/src/index.js