Nestjs+Graphql中Mutation的@Args参数如何正确定义ID类型

问题复现 #

使用NestJS构建GraphQL API时，需在@Args装饰器修饰的Mutation入参中声明GraphQL ID类型，三次实现尝试均出现异常：

• 尝试1：直接引入@nestjs/graphql导出的ID作为TypeScript类型标注
  示例代码：

  import { Resolver, Mutation, Query, Args, Context, ID } from "@nestjs/graphql";
  
  @Mutation(() => SuccessInfo, { name: "addSubCategory" })
  addSub(
          @Args("id") id: ID
      ) {
      console.log(id);
  }
  

  触发两类TypeScript编译报错：

  'ID' refers to a value, but is being used as a type here. Did you mean 'typeof ID'?
  Parameter 'id' of public method from exported class has or is using private name 'ID'

• 尝试2：将TypeScript类型标注修改为typeof ID
  示例代码：

  import { Resolver, Mutation, Query, Args, Context, ID } from "@nestjs/graphql";
  
  @Mutation(() => SuccessInfo, { name: "addSubCategory" })
  addSub(
          @Args("id") id: typeof ID
      ) {
      console.log(id);
  }
  

  TypeScript编译报错消失，但服务启动阶段抛出运行时错误：

  Undefined type error. Make sure you are providing an explicit type for the "addSub"

• 尝试3：将参数TypeScript类型标注为String
  示例代码：

  import { Resolver, Mutation, Query, Args, Context, ID } from "@nestjs/graphql";
  
  @Mutation(() => SuccessInfo, { name: "addSubCategory" })
  addSub(
          @Args("id") id: String
      ) {
      console.log(id);
  }
  

  服务可正常启动运行，但生成的GraphQL Schema中该参数类型为String，不符合业务要求使用ID类型的需求。

错误原因 #

NestJS GraphQL的类型校验与Schema生成依赖两套独立的类型体系：

• TypeScript类型标注：仅用于编译阶段的类型校验，不参与运行时Schema生成
• 装饰器传入的类型配置：是NestJS在运行时生成GraphQL Schema的核心依据
  之前的实现仅修改了TypeScript层面的类型标注，未在@Args装饰器中显式声明GraphQL维度的运行时类型，因此会触发编译或运行时错误。

正确实现方式 #

在@Args装饰器的配置项中传入type: () => ID显式声明GraphQL运行时类型，TypeScript层面的类型标注直接使用string即可（GraphQL ID类型序列化后本质为字符串值），示例代码：

import { Resolver, Mutation, Query, Args, Context, ID } from "@nestjs/graphql";

@Mutation(() => SuccessInfo, { name: "addSubCategory" })
addSub(
        @Args("id", { type: () => ID }) id: string
    ) {
    console.log(id);
}

上述写法可保证最终生成的GraphQL Schema中该参数类型为ID，同时无编译、运行时错误。如果需要配置参数为非必填，可在配置项中追加nullable: true，必填参数可显式设置nullable: false。

内容的提问来源于stack exchange，提问作者Samia Sammi