Netflix DGS代码生成器无法解析UserId标量引用问题求助

以下是针对该问题的排查和解决步骤：

1. 匹配Gradle代码生成任务与项目语言 #

你当前配置的是GenerateJavaTask，但项目基于Kotlin开发，需替换为GenerateKotlinTask：

tasks.withType<com.netflix.graphql.dgs.codegen.gradle.GenerateKotlinTask> {
    generateClient = true
    packageName = "com.example.demo.generated"
    typeMapping = mutableMapOf(
        "UserId" to "com.example.demo.UserId"
    )
}

任务类型不匹配会导致代码生成器忽略Kotlin相关配置，直接引发typeMapping失效。

2. 在GraphQL Schema中明确定义标量 #

必须在你的.graphqls文件中添加标量声明：

scalar UserId

# 示例使用场景
type Query {
    getUser(id: UserId!): User
}

缺少该定义时，代码生成器会将UserId视为未识别的普通类型，不会应用typeMapping规则。

3. 验证typeMapping的类路径准确性 #

• 确认com.example.demo.UserId是值类的正确全限定类名，检查包名拼写、大小写是否与实际代码一致。
• 确保UserId类为public访问权限（Kotlin值类默认public，若手动修改修饰符会导致访问问题）。

4. 适配DGS代码生成插件版本 #

不同版本的插件配置语法可能存在差异：

• 若使用5.x及以上版本，需改用typeMappings（复数形式）配置：

  typeMappings = listOf("UserId=com.example.demo.UserId")
  

• 核对当前插件版本的官方文档，确保配置语法符合版本要求。

5. 调整任务依赖顺序 #

确保代码生成任务能访问到UserId类的编译结果：

• 单模块项目中，可让代码生成任务依赖compileKotlin：

  tasks.named("generateKotlin") {
      dependsOn(tasks.compileKotlin)
  }
  

• 多模块项目中，确认代码生成所在模块已正确依赖包含UserId类的模块。

6. 清理缓存并验证生成代码 #

• 查看生成代码的import语句，确认是否包含import com.example.demo.UserId：
  • 若无该import，说明typeMapping未生效，回到步骤1-4重新排查配置。
  • 若有import仍报错，执行./gradlew clean build --refresh-dependencies清理Gradle和IDE缓存后重新构建。

内容的提问来源于stack exchange，提问作者Rory Hart