第44章 方法装饰器

案例44:方法装饰器——拦截与增强方法执行

题目:使用TypeScript方法装饰器实现一个日志增强器,在方法执行前后自动打印调用信息与耗时,并支持通过参数控制是否启用日志。

🧠 设计思路

方法装饰器接收三个参数(目标原型、方法名、属性描述符)。我们通过替换descriptor.value,包装原方法:调用前记录时间并输出日志,调用后计算耗时。为避免改变原有方法行为,包装函数需保留this绑定并透传参数。

核心代码

// 方法装饰器工厂
function LogMethod(prefix: string = "LOG") {
  return function (
    target: any,
    propertyKey: string,
    descriptor: PropertyDescriptor
  ) {
    const original = descriptor.value;
    descriptor.value = function (...args: any[]) {
      console.log(`[${prefix}] 调用 ${propertyKey},参数:`, args);
      const start = Date.now();
      const result = original.apply(this, args);
      const cost = Date.now() - start;
      console.log(`[${prefix}] ${propertyKey} 执行完毕,耗时 ${cost}ms,返回值:`, result);
      return result;
    };
    return descriptor;
  };
}

// 使用装饰器
class Calculator {
  @LogMethod("计算器")
  add(a: number, b: number): number {
    return a + b;
  }

  @LogMethod("计算器")
  multiply(a: number, b: number): number {
    return a * b;
  }
}

const calc = new Calculator();
calc.add(3, 5);
calc.multiply(4, 7);

▶️ 运行与验证

运行命令:npx ts-node decorator_log.ts(或先tsc编译后用node执行)。

预期输出:

[计算器] 调用 add,参数: [ 3, 5 ]
[计算器] add 执行完毕,耗时 0ms,返回值: 8
[计算器] 调用 multiply,参数: [ 4, 7 ]
[计算器] multiply 执行完毕,耗时 0ms,返回值: 28

📘 测试建议

可修改装饰器工厂参数prefix,或添加enabled开关:当enabled=false时直接返回原方法,不进行任何包装,用于生产环境关闭调试日志。

⚠️ 注意事项

1. 装饰器目前只能用于类成员,且目标为ECMAScript标准语法时需确保tsconfig.json中启用"experimentalDecorators": true。
2. 包装函数必须用普通function而非箭头函数,否则this指向会丢失。

成功要点

成功拦截方法调用,通过依赖注入式装饰器实现了横切关注点(日志/性能监控),代码复用性强,且不侵入原业务逻辑。