1. 引言
在軟件工程中，日志記錄是監(jiān)控和調(diào)試應(yīng)用程序的重要工具。鴻蒙操作系統(tǒng)（HarmonyOS）支持自定義裝飾器，這使得開發(fā)者可以方便地向類的方法添加日志記錄功能。本文將介紹兩個用于記錄方法執(zhí)行的自定義裝飾器：LogMethod 和 logDecorator。

2. 裝飾器基礎(chǔ)
裝飾器是一種特殊類型的聲明，它允許在不修改原始類定義的情況下向類添加屬性或行為。在TypeScript中，裝飾器被用于類、方法、屬性或參數(shù)上，以增強其功能。

3. LogMethod 裝飾器
LogMethod 是一個用于記錄方法執(zhí)行開始和結(jié)束的裝飾器。它接受一個字符串參數(shù) metadata，可用于存儲方法的額外信息。

export function LogMethod(metadata: string): MethodDecorator {
  return function (
      target: Object,
      propertyKey: string,
      descriptor: PropertyDescriptor
  ): PropertyDescriptor {
    // 保存原始方法
    const originalMethod = descriptor.value;

    // 用新函數(shù)替換原始方法
    descriptor.value = function (...args: any[]) {
      // 方法執(zhí)行前打印日志
      console.log(`Method ${propertyKey} is start with metadata: ${metadata}.`);

      // 調(diào)用原始方法，并保存返回值
      const result = originalMethod.apply(this, args);

      // 方法執(zhí)行后打印日志
      console.log(`Method ${propertyKey} is end.`);

      // 返回原始方法的返回值
      return result;
    };

    // 返回修改后的屬性描述符
    return descriptor;
  };
}

4. logDecorator 裝飾器
logDecorator 是一個記錄方法調(diào)用開始、參數(shù)和返回結(jié)果的裝飾器。它沒有額外的參數(shù)，直接對方法進(jìn)行包裝，以添加日志功能。

export function logDecorator(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor {
  // 保存原始的方法引用
  const originalMethod = descriptor.value;

  // 修改方法的實現(xiàn)，添加日志記錄功能
  descriptor.value = function (...args: any[]): any {
    // 打印方法開始執(zhí)行的日志，包括方法名和參數(shù)
    console.log(`${propertyKey} : start with arguments ${JSON.stringify(args)}`);

    // 調(diào)用原始方法，并將結(jié)果保存
    const result = originalMethod.apply(this, args);

    // 打印方法返回結(jié)果的日志
    console.log(`${propertyKey} : returned ${result}`);

    // 返回原始方法的結(jié)果
    return result;
  };

  // 返回修改后的屬性描述符
  return descriptor;
}

5. 使用場景
這些裝飾器特別適用于以下場景：

• 監(jiān)控關(guān)鍵業(yè)務(wù)邏輯的方法調(diào)用。
• 調(diào)試難以復(fù)現(xiàn)的缺陷。
• 記錄API請求和響應(yīng)，以便于分析性能瓶頸。

6. 實際應(yīng)用
在 add 和 subtract 方法，我們可以這樣使用裝飾器：

  @LogMethod("math operation")
  add(a: number, b: number): number {
    return a + b;
  }

  @logDecorator
  subtract(a: number, b: number): number {
    return a - b;
  }

7. 注意事項

• 裝飾器不能添加到訪問器（get/setter）上。
• 裝飾器執(zhí)行順序：方法參數(shù)裝飾器 -> 方法裝飾器 -> 訪問器裝飾器 -> 類裝飾器。
• 裝飾器是實驗性功能，可能在未來的版本中有所變動。

8. 結(jié)論
自定義裝飾器提供了一種靈活而強大的方式來增強類和方法的功能，而無需更改其原始定義。在鴻蒙操作系統(tǒng)中，裝飾器尤其有用，因為它們可以輕松集成到系統(tǒng)開發(fā)中。

9. 附錄

• TypeScript 官方文檔關(guān)于裝飾器
• 鴻蒙操作系統(tǒng)開發(fā)文檔