如何实现打字稿装饰器？

Question

TypeScript 1.5现在有装饰器。

有人可以提供一个简单的例子来展示实现装饰器的正确方法并描述可能的有效装饰器签名中的参数的含义吗？

declare type ClassDecorator = <TFunction extends Function>(target: TFunction) => TFunction | void;
declare type PropertyDecorator = (target: Object, propertyKey: string | symbol) => void;
declare type MethodDecorator = <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T> | void;
declare type ParameterDecorator = (target: Function, propertyKey: string | symbol, parameterIndex: number) => void;

此外，在实现装饰器时是否应牢记任何最佳实践注意事项？

Answer 1

我最终玩弄了装饰器，并决定在任何文档出现之前为任何想要利用它的人记录我的想法。 如果您发现任何错误，请随时编辑。

一般要点

• 装饰器在声明类时调用——而不是在实例化对象时调用。
• 可以在同一个类/属性/方法/参数上定义多个装饰器。
• 构造函数上不允许使用装饰器。

一个有效的装饰器应该是：

1. 可分配给装饰器类型之一（ ClassDecorator | PropertyDecorator | MethodDecorator | ParameterDecorator ）。
2. 返回一个可分配给装饰值的值（在类装饰器和方法装饰器的情况下）。

参考

---

方法/正式访问器装饰器

实现参数：

• target ：类的原型（ Object ）。
• propertyKey ：方法的名称（ string | symbol ）。
• descriptor : A TypedPropertyDescriptor — 如果您不熟悉描述符的键，我建议您阅读有关Object.defineProperty 文档（这是第三个参数）。

示例 - 不带参数

用：

class MyClass {
    @log
    myMethod(arg: string) { 
        return "Message -- " + arg;
    }
}

执行：

function log(target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) {
    const originalMethod = descriptor.value; // save a reference to the original method

    // NOTE: Do not use arrow syntax here. Use a function expression in 
    // order to use the correct value of `this` in this method (see notes below)
    descriptor.value = function(...args: any[]) {
        // pre
        console.log("The method args are: " + JSON.stringify(args));
        // run and store result
        const result = originalMethod.apply(this, args);
        // post
        console.log("The return value is: " + result);
        // return the result of the original method (or modify it before returning)
        return result;
    };

    return descriptor;
}

输入：

new MyClass().myMethod("testing");

输出：

方法参数是：[“测试”]

返回值为：Message——测试

笔记：

• 设置描述符的值时不要使用箭头语法。 如果您这样做，则this上下文将不是实例的上下文。
• 修改原始描述符比通过返回新描述符覆盖当前描述符更好。 这允许您使用多个装饰器来编辑描述符，而不会覆盖其他装饰器所做的工作。 这样做允许您同时使用@enumerable(false)和@log类的东西（例如： Bad vs Good ）
• 有用： TypedPropertyDescriptor的类型参数可用于限制装饰器可以放置的方法签名（ 方法示例）或访问器签名（访问器示例）。

示例 - 带参数（装饰工厂）

使用参数时，您必须声明一个带有装饰器参数的函数，然后返回一个带有不带参数示例签名的函数。

class MyClass {
    @enumerable(false)
    get prop() {
        return true;
    }
}

function enumerable(isEnumerable: boolean) {
    return (target: Object, propertyKey: string, descriptor: TypedPropertyDescriptor<any>) => {
        descriptor.enumerable = isEnumerable;
        return descriptor;
    };
}

---

静态方法装饰器

类似于方法装饰器，但有一些不同：

• 它的target参数是构造函数本身而不是原型。
• 描述符是在构造函数上定义的，而不是在原型上定义的。

---

类装饰器

@isTestable
class MyClass {}

实现参数：

• target ：装饰器声明的类（ TFunction extends Function ）。

使用示例：使用元数据 api 存储类的信息。

---

物业装饰师

class MyClass {
    @serialize
    name: string;
}

实现参数：

• target ：类的原型（ Object ）。
• propertyKey ： propertyKey的名称（ string | symbol ）。

使用示例：创建@serialize("serializedName")装饰器并将属性名称添加到要序列化的属性列表中。

---

参数装饰器

class MyClass {
    myMethod(@myDecorator myParameter: string) {}
}

实现参数：

• target ：类的原型（ Function似乎Function不再起作用。你现在应该在这里使用any或Object以便在任何类中使用装饰器。或者指定你想要限制它的类类型到）
• propertyKey ：方法的名称（ string | symbol ）。
• parameterIndex ：函数参数列表中parameterIndex的索引（ number ）。

简单的例子

详细示例

• Memoize 装饰器- 方法、获取/设置访问器装饰器示例

Answer 2

我在其他答案中没有看到的一件重要事情：

装饰厂

如果我们想自定义装饰器如何应用于声明，我们可以编写一个装饰器工厂。 装饰器工厂只是一个返回表达式的函数，该表达式将在运行时被装饰器调用。

// This is a factory, returns one of ClassDecorator,
// PropertyDecorator, MethodDecorator, ParameterDecorator
function Entity(discriminator: string):  {
    return function(target) {
        // this is the decorator, in this case ClassDecorator.
    }
}

@Entity("cust")
export class MyCustomer { ... }

查看 TypeScript 手册装饰器章节。

Answer 3

class Foo {
  @consoleLogger 
  Boo(name:string) { return "Hello, " + name }
}

• 目标：上述情况下类的原型是“Foo”
• propertyKey：被调用方法的名称，在上面的例子中是“Boo”
• 描述符：对象的描述 => 包含 value 属性，而 value 属性又是函数本身： function(name) { return 'Hello' + name; }

您可以实现将每次调用记录到控制台的内容：

function consoleLogger(target: Function, key:string, value:any) 
{
  return value: (...args: any[]) => 
  {
     var a = args.map(a => JSON.stringify(a)).join();
     var result = value.value.apply(this, args);
     var r = JSON.stringify(result);

     console.log('called method' + key + ' with args ' + a + ' returned result ' + r);

     return result;
  }     
}

Answer 4

TS 装饰器：

TS 装饰器允许在类上添加额外的功能。 在创建该类的任何实例之前，该类在声明时由装饰器更改。

句法：

装饰@metadata @符号声明，例如@metadata 。 TS 现在将搜索相应的元数据函数，并自动为它提供 sevaral 参数，这些参数因具体装饰的内容而异（例如，类或类属性获得不同的参数）

这些参数在装饰器函数中提供：

• 类的原型对象
• 属性键或方法名称
• PropertyDescriptor 对象，看起来像这样{writable: true, enumerable: false, configurable: true, value: ƒ}

根据装饰器的类型，将这些参数的 1-3 传递给装饰器函数。

装饰器的类型：

以下装饰器可以应用于类，TS 将按以下顺序评估它们（以下总和来自 TS 文档）：

1. 每个实例成员都应用参数装饰器，然后是方法、访问器或属性装饰器。
2. 每个静态成员都应用参数装饰器，然后是方法、访问器或属性装饰器。
3. 参数装饰器应用于构造函数。
4. 类装饰器应用于类

更好地理解它们的最好方法是通过示例。 请注意，这些示例确实需要对 TS 语言和PropertyDescriptor等概念有深入的了解。

方法装饰器：

function overwrite(
    target: myClass,
    propertyKey: string,
    descriptor: PropertyDescriptor
) {
    console.log('I get logged when the class is declared!')

    // desciptor.value refers to the actual function fo the class
    // we are changing it to another function which straight up 
    // overrides the other function
    descriptor.value = function () {
        return 'newValue method overwritten'
    }
}

function enhance(
    target: myClass,
    propertyKey: string,
    descriptor: PropertyDescriptor
) {
    const oldFunc = descriptor.value;

    // desciptor.value refers to the actual function fo the class
    // we are changing it to another function which calls the old
    // function and does some extra stuff
    descriptor.value = function (...args: any[]) {
        console.log('log before');
        const returnValue = oldFunc.apply(this, args)
        console.log('log after');

        return returnValue;
    }
}


class myClass {

    // here is the decorator applied
    @overwrite
    foo() {
        return 'oldValue';
    }

    // here is the decorator applied
    @enhance
    bar() {
        return 'oldValueBar';
    }

}

const instance =new myClass()

console.log(instance.foo())
console.log(instance.bar())

// The following gets logged in this order:

//I get logged when the class is declared!
// newValue method overwritten
// log before
// log after
// oldValueBar

属性装饰器：

function metaData(
    target: myClass,
    propertyKey: string,
    // A Property Descriptor is not provided as an argument to a property decorator due to 
    // how property decorators are initialized in TypeScript.
) {

    console.log('Execute your custom code here')
    console.log(propertyKey)

}

class myClass {

    @metaData
    foo = 5

}


// The following gets logged in this order:

// Execute your custom code here
// foo

类装饰器（来自 TS 文档）：

function seal(
    constructor: Function,
) {

    // Object.seal() does the following:
    // Prevents the modification of attributes of 
    // existing properties, and prevents the addition 
    // of new properties
    Object.seal(constructor);
    Object.seal(constructor.prototype);

}

@seal
class myClass {

    bar?: any;
    
    foo = 5

}
 
myClass.prototype.bar = 10;

// The following error will be thrown:

// Uncaught TypeError: Cannot add property bar,
// object is not extensible
 

装饰器和装饰器工厂：

装饰器可以通过装饰器函数或装饰器工厂函数来声明。 语法上有区别，最好通过一个例子来解释：

// Returns a decorator function, we can return any function
// based on argument if we want
function decoratorFactory(arg: string) {
    return function decorator(
    target: myClass,
    propertyKey: string,
) {
    console.log(`Log arg ${arg} in decorator factory`);
}
}

// Define a decorator function directly
function decorator(
    target: myClass,
    propertyKey: string,
) {
    console.log('Standard argument');
}

class myClass {

    // Note the parentheses and optional arguments 
    // in the decorator factory
    @decoratorFactory('myArgument')
    foo = 'foo';

    // No parentheses or arguments
    @decorator
    bar = 'bar';

}


// The following gets logged in this order:

// Log arg myArgument in decorator factory
// Standard argument

Answer 5

您还可以在打字稿中decorate/enhance原始构造函数的新功能（我使用了 3.9.7）。 下面的代码片段包装了原始构造函数以添加 name 属性的前缀。 当类被instantiated而不是在declared类时会发生这种情况！

 //Decorator function
 function Prefixer(prefix: string) { 
    return function<T extends { new (...args: any[]): {name: string} }>(
      originalCtor: T
    ) {
      return class extends originalCtor {
        constructor(..._: any[]) {
          super();
          this.name = `${prefix}.${this.name.toUpperCase()}`;        
          console.log(this.name);       
        }
      };
    };
  }

当类被instantiated ，新的构造函数逻辑与原始 ctor 逻辑一起运行 -

  @Prefixer('Mr')
  class Person {
    name = 'MBB';
  
    constructor() {
      console.log('original ctr logic here!');
    }
  }
  
  const pers = new Person();
  
  console.log(pers); //Mr.MBB