TypeScript 装饰器：参数装饰器

在 TypeScript 中，装饰器是一种特殊的语法，用于在类声明和类成员上附加元数据。装饰器可以用于类、方法、属性和参数。本文将深入探讨参数装饰器的概念、用法、优缺点以及注意事项，并提供丰富的示例代码。

什么是参数装饰器？

参数装饰器是用于装饰类方法参数的函数。它可以在方法被调用时，修改或记录参数的元数据。参数装饰器的定义如下：

function ParameterDecorator(target: Object, propertyKey: string | symbol, parameterIndex: number) {
    // 装饰器逻辑
}

target：被装饰的类的原型对象。
propertyKey：被装饰的方法名称。
parameterIndex：参数在方法参数列表中的索引。

示例：基本的参数装饰器

下面是一个简单的参数装饰器示例，它记录了被装饰方法的参数信息。

function LogParameter(target: any, propertyKey: string, parameterIndex: number) {
    const existingParameters: number[] = Reflect.getOwnMetadata("log_parameters", target, propertyKey) || [];
    existingParameters.push(parameterIndex);
    Reflect.defineMetadata("log_parameters", existingParameters, target, propertyKey);
}

class User {
    greet(@LogParameter name: string) {
        console.log(`Hello, ${name}!`);
    }
}

const user = new User();
user.greet("Alice");

在这个示例中，LogParameter 装饰器会记录 greet 方法的参数索引。虽然在这个简单的示例中没有实际使用这些元数据，但它展示了如何定义和使用参数装饰器。

参数装饰器的优点

增强代码可读性：通过使用装饰器，可以清晰地看到方法参数的意图和用途，增强了代码的可读性。
元数据收集：参数装饰器可以用于收集方法参数的元数据，这在依赖注入、验证和日志记录等场景中非常有用。
解耦逻辑：装饰器可以将参数处理逻辑与业务逻辑分离，使代码更加模块化和可维护。

参数装饰器的缺点

性能开销：使用装饰器可能会引入额外的性能开销，尤其是在大量使用装饰器的情况下。
调试困难：由于装饰器在编译时应用，调试时可能会导致堆栈跟踪不清晰，增加了调试的复杂性。
学习曲线：对于不熟悉装饰器的开发者，理解和使用装饰器可能需要一定的学习成本。

注意事项

装饰器的执行顺序：参数装饰器在方法执行之前被调用，因此它们不能直接修改参数值。它们只能用于记录或修改元数据。
与其他装饰器的兼容性：在同一方法上使用多个装饰器时，装饰器的执行顺序是从下到上的。需要注意装饰器之间的相互影响。
TypeScript 配置：确保在 tsconfig.json 中启用 experimentalDecorators 选项，以便使用装饰器。

{
  "compilerOptions": {
    "experimentalDecorators": true
  }
}

进阶示例：参数验证

下面是一个更复杂的示例，展示如何使用参数装饰器进行参数验证。

function ValidateString(target: any, propertyKey: string, parameterIndex: number) {
    const existingValidators: number[] = Reflect.getOwnMetadata("validators", target, propertyKey) || [];
    existingValidators.push(parameterIndex);
    Reflect.defineMetadata("validators", existingValidators, target, propertyKey);
}

function validate(target: any, propertyKey: string, descriptor: PropertyDescriptor) {
    const originalMethod = descriptor.value;

    descriptor.value = function (...args: any[]) {
        const validators: number[] = Reflect.getOwnMetadata("validators", target, propertyKey) || [];
        for (const index of validators) {
            if (typeof args[index] !== 'string') {
                throw new Error(`Parameter at index ${index} is not a string.`);
            }
        }
        return originalMethod.apply(this, args);
    };
}

class User {
    @validate
    greet(@ValidateString name: string) {
        console.log(`Hello, ${name}!`);
    }
}

const user = new User();
user.greet("Alice"); // 正常工作
user.greet(123); // 抛出错误: Parameter at index 0 is not a string.

在这个示例中，ValidateString 装饰器用于标记 greet 方法的参数为字符串类型。validate 装饰器在方法执行之前检查参数类型，如果参数不是字符串，则抛出错误。

总结

参数装饰器是 TypeScript 中一个强大的特性，能够帮助开发者在方法参数上附加元数据。通过合理使用参数装饰器，可以增强代码的可读性、可维护性和功能性。然而，开发者在使用时也需要注意性能开销、调试复杂性以及装饰器的执行顺序等问题。希望本文能帮助你更好地理解和使用 TypeScript 的参数装饰器。