1. 引言
在軟件工程中，日誌記錄是監控和調試應用程序的重要工具。鴻蒙操作系統（HarmonyOS）支持自定義裝飾器，這使得開發者可以方便地向類的方法添加日誌記錄功能。本文將介紹兩個用於記錄方法執行的自定義裝飾器：LogMethod 和 logDecorator。
2. 裝飾器基礎
裝飾器是一種特殊類型的聲明，它允許在不修改原始類定義的情況下向類添加屬性或行爲。在TypeScript中，裝飾器被用於類、方法、屬性或參數上，以增強其功能。
3. LogMethod 裝飾器
LogMethod 是一個用於記錄方法執行開始和結束的裝飾器。它接受一個字符串參數 metadata，可用於存儲方法的額外信息。
export function LogMethod(metadata: string): MethodDecorator {
return function (
target: Object,
propertyKey: string,
descriptor: PropertyDescriptor
): PropertyDescriptor {
// 保存原始方法
const originalMethod = descriptor.value;
// 用新函數替換原始方法
descriptor.value = function (...args: any[]) {
// 方法執行前打印日誌
console.log(`Method ${propertyKey} is start with metadata: ${metadata}.`);
// 調用原始方法，並保存返回值
const result = originalMethod.apply(this, args);
// 方法執行後打印日誌
console.log(`Method ${propertyKey} is end.`);
// 返回原始方法的返回值
return result;
};
// 返回修改後的屬性描述符
return descriptor;
};
}
4. logDecorator 裝飾器
logDecorator 是一個記錄方法調用開始、參數和返回結果的裝飾器。它沒有額外的參數，直接對方法進行包裝，以添加日誌功能。
export function logDecorator(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor {
// 保存原始的方法引用
const originalMethod = descriptor.value;
// 修改方法的實現，添加日誌記錄功能
descriptor.value = function (...args: any[]): any {
// 打印方法開始執行的日誌，包括方法名和參數
console.log(`${propertyKey} : start with arguments ${JSON.stringify(args)}`);
// 調用原始方法，並將結果保存
const result = originalMethod.apply(this, args);
// 打印方法返回結果的日誌
console.log(`${propertyKey} : returned ${result}`);
// 返回原始方法的結果
return result;
};
// 返回修改後的屬性描述符
return descriptor;
}
5. 使用場景
這些裝飾器特別適用於以下場景：
- 監控關鍵業務邏輯的方法調用。
- 調試難以復現的缺陷。
- 記錄API請求和響應，以便於分析性能瓶頸。
6. 實際應用
在 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）上。
- 裝飾器執行順序：方法參數裝飾器 -> 方法裝飾器 -> 訪問器裝飾器 -> 類裝飾器。
- 裝飾器是實驗性功能，可能在未來的版本中有所變動。
8. 結論
自定義裝飾器提供了一種靈活而強大的方式來增強類和方法的功能，而無需更改其原始定義。在鴻蒙操作系統中，裝飾器尤其有用，因爲它們可以輕鬆集成到系統開發中。
9. 附錄