如何让TypeScript参数装饰器@ParseIt适配参数可选性？

TypeScript 5的标准装饰器完全支持根据参数的可选性动态调整解析逻辑，无需拆分两个独立装饰器。核心思路是利用函数的内置属性判断参数是否为可选，再分支处理解析逻辑，结合NestJS框架也能轻松适配。

核心原理 #

函数的length属性会返回必填参数的个数，如果参数的索引大于等于这个数值，说明该参数是可选的（即带有?标记）。在装饰器执行时，我们可以通过这个属性判断当前参数的可选状态，从而切换解析逻辑：

• 必填参数：若传入undefined则直接抛出错误
• 可选参数：允许返回undefined

通用TypeScript实现示例 #

确保tsconfig.json开启以下编译选项：

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true
  }
}

实现@ParseIt装饰器：

import 'reflect-metadata';

// 自定义解析目标类型
type CustomType = { value: string };

function ParseIt(): ParameterDecorator {
  return (target, methodName, paramIndex) => {
    const originalMethod = target[methodName] as Function;
    // 判断当前参数是否为可选：参数索引 >= 函数必填参数个数
    const isOptional = paramIndex >= originalMethod.length;

    // 重写原方法，插入解析逻辑
    target[methodName] = function (...args: unknown[]) {
      const rawArg = args[paramIndex];
      let parsedResult: CustomType | undefined;

      if (rawArg === undefined) {
        if (isOptional) {
          parsedResult = undefined;
        } else {
          throw new Error(`参数 ${paramIndex} 为必填项，不能传入undefined`);
        }
      } else {
        // 替换为实际的参数解析逻辑（示例：将字符串转为CustomType）
        parsedResult = { value: rawArg as string };
      }

      // 替换参数后执行原方法
      args[paramIndex] = parsedResult;
      return originalMethod.apply(this, args);
    };
  };
}

// 测试用例
// 必填参数场景
function requiredFunc(@ParseIt() arg: CustomType) {
  console.log(arg);
}
requiredFunc("test"); // 输出 { value: 'test' }
// requiredFunc(); // 抛出错误：参数0为必填项...

// 可选参数场景
function optionalFunc(@ParseIt() arg?: CustomType) {
  console.log(arg);
}
optionalFunc("test2"); // 输出 { value: 'test2' }
optionalFunc(); // 输出 undefined

NestJS适配方案 #

NestJS的参数装饰器基于createParamDecorator实现，结合请求上下文和函数元数据，可实现更贴合框架的版本：

import { createParamDecorator, ExecutionContext, BadRequestException } from '@nestjs/common';

type CustomType = { value: string };

export const ParseIt = createParamDecorator((_data: unknown, ctx: ExecutionContext) => {
  const request = ctx.switchToHttp().getRequest();
  // 示例：从请求Query中获取原始参数，可根据实际场景替换为Body/Param等
  const rawArg = request.query.arg;

  const handler = ctx.getHandler();
  // 获取当前参数在函数中的索引（这里假设装饰器仅用于单个参数，可根据实际调整）
  const paramIndex = handler.parameters.findIndex(param => 
    param.name === 'arg' // 匹配参数名，或通过元数据更精准匹配
  );
  // 判断参数是否可选
  const isOptional = paramIndex >= handler.length;

  if (rawArg === undefined) {
    if (isOptional) {
      return undefined;
    } else {
      throw new BadRequestException('参数arg为必填项');
    }
  }

  // 实际解析逻辑
  return { value: rawArg };
});

// 控制器中使用
@Controller('demo')
export class DemoController {
  @Get('required')
  getRequired(@ParseIt() arg: CustomType) {
    return arg;
  }

  @Get('optional')
  getOptional(@ParseIt() arg?: CustomType) {
    return arg;
  }
}

注意事项 #

1. 函数的length属性仅统计前置连续的必填参数，如果函数有默认值参数，这些参数也会被视为可选，length会在第一个默认值参数处停止统计，符合TS的参数可选规则。
2. 如果需要更精准的元数据判断，可结合reflect-metadata的design:paramtypes元数据，但length属性已经能覆盖绝大多数场景。
3. NestJS中若需要处理多个参数的装饰器，可通过遍历handler.parameters并结合装饰器的标记来精准定位参数位置。

内容的提问来源于stack exchange，提问作者A Question Asker