typescript - typescript 中的装饰器返回函数的时间

Question

用例:我想知道一个函数在 typescript 中执行需要多少时间。我想为此目的使用装饰器。我希望装饰器应该返回时间以便(我可以进一步使用它)，而不仅仅是打印它。
例如:

export function createTimestamps(message: string) {
  return function (target: any, name: string, descriptor: PropertyDescriptor) {
    const method = descriptor.value;
    descriptor.value = async function () {
      const startTime = new Date(Date.now());
      console.log(
        `${message} started at: ${startTime.toLocaleString("en-GB")}`
      );
      await method.apply(this);
      const endTime = new Date(Date.now());
      console.log(
        `${message} completed at: ${endTime.toLocaleString("en-GB")}`
      );
      console.log(
        `${message} took ${
          endTime.getTime() - startTime.getTime()
        }ms to complete.`
      );
    };
  };
}

如果我将上面的函数用作装饰器，那么我希望装饰器返回“endTime.getTime() - startTime.getTime()”，以便我可以进一步使用它。

@creaTimestamp
async newfunc():string{
 return "typescript";
}

现在当我调用上面的函数时等待 newfunc()。我能否同时获取执行时间值及其返回的字符串？

此外，我有许多函数我想避免在每个函数的顶部添加装饰器，因此在调用它们时我想确保装饰器运行并返回计时。如果存在这样的图书馆，有人可以指点我吗？

有人可以分享一下对上述场景的一些见解吗，我对装饰器还很陌生。谢谢!

Answer 1

返回附加数据无法使用 typescript 装饰器。

主要问题是a typescript decorator cannot change the return type的一个功能。并且一个函数只能返回一个值。

那么，为什么这很重要？

例如:

class Foo {
  async newfunc(): string {
    return "typescript";
  }
}

const lang = await new Foo().newFunc()
console.log(`${lang} is a cool language`)

在此示例中，lang 是一个string，您的程序期望它是一个string。如果你随后将装饰器放在这个函数上，并且你希望返回一个字符串以及时间信息，你必须返回如下内容:

{ result: returnValueOfFunctionHere, elapsed: elapsedMsHere }

但这不再是字符串。现在您必须深入了解 result 属性才能获取该字符串。这意味着您已经通过应用装饰器更改了函数的返回类型。目前不允许这样做。

这就是示例将信息记录到控制台而不是返回它的原因。

---

但正如@Papooch 建议的那样，您可以通过reflect-metadata 将耗时存储在元数据 中。您可以将其存储在被测量函数的唯一元数据键上。

reflect-metadata 是一个很有用的包，可以处理类似的事情。在 how to use it here 上阅读更多内容.

import 'reflect-metadata'

// Create a key to store the metadata under. This should be a symbol.
const lastCallElapsedKey = Symbol('lastCallElapsedKey')

function createTimestamps(message: string) {
  return function (target: any, name: string, descriptor: PropertyDescriptor) {
    const method = descriptor.value;

    descriptor.value = async function () {
      const startTime = new Date(Date.now());      
      const result = await method.apply(this);
      const endTime = new Date(Date.now());
      const elpased = endTime.getTime() - startTime.getTime()

      // Write the elpased time to the new function's metadata.
      Reflect.defineMetadata(lastCallElapsedKey, elpased, descriptor.value)
      
      return result
    };
  };
}

// Get the elapsed time from the metadata.
function getElapsed(fn: (...args: unknown[]) => unknown): number | undefined {
    return Reflect.getMetadata(lastCallElapsedKey, fn)
}

class Foo {
    // Emulate an async call
    @createTimestamps("test")
    async newfunc(): Promise<string> {
        return new Promise(resolve => {
            setTimeout(() => resolve('typescript'), 250)
        })
    }
}

async function test() {
    const foo = new Foo()
    console.log(await foo.newfunc())
    console.log(getElapsed(foo.newfunc)) // 250
}
test()

Playground