Gradle Kotlin项目注解处理器生效问题及资源代码生成替代方案咨询

嘿，这个问题我之前在做Kotlin Gradle项目时刚好碰到过，给你分享两个方向的解决方案～

其实注解处理器的核心场景是处理源码中的注解，监听资源变化并生成代码的需求，用Gradle自定义增量任务会更合适——Gradle本身就有完善的增量构建机制，能精准追踪资源目录的变化，完全匹配你的需求。

具体实现步骤：

• 第一步：创建自定义Gradle任务，定义输入输出
  在build.gradle.kts中编写任务类，用@InputDirectory标记资源目录（作为任务输入），@OutputDirectory标记代码生成目录（作为任务输出），Gradle会自动对比输入输出的变化，决定是否重新运行任务：

  import org.gradle.api.DefaultTask
  import org.gradle.api.file.DirectoryProperty
  import org.gradle.api.tasks.InputDirectory
  import org.gradle.api.tasks.OutputDirectory
  import org.gradle.api.tasks.TaskAction
  
  abstract class GenerateResourceCodeTask : DefaultTask() {
      // 输入：resources目录
      @InputDirectory
      val resourcesDir: DirectoryProperty = project.objects.directoryProperty()
          .convention(project.layout.projectDirectory.dir("src/main/resources"))
  
      // 输出：生成代码的目录
      @OutputDirectory
      val outputDir: DirectoryProperty = project.objects.directoryProperty()
          .convention(project.layout.buildDirectory.dir("generated/source/resourceCode/main"))
  
      @TaskAction
      fun generate() {
          // 1. 遍历resources目录下的所有文件
          val resourceFiles = resourcesDir.get().asFile.walkTopDown()
              .filter { it.isFile }
              .toList()
  
          // 2. 用KPoet生成代码（类似Android R.java的简洁版本）
          val resourceClass = com.squareup.kotlinpoet.TypeSpec.objectBuilder("Resource")
              .apply {
                  resourceFiles.forEach { file ->
                      // 把文件名转成合法的常量名（比如icon.png -> ICON）
                      val constantName = file.nameWithoutExtension.replace("-", "_").uppercase()
                      // 添加常量，值为资源相对路径
                      addProperty(
                          com.squareup.kotlinpoet.PropertySpec.builder(constantName, String::class)
                              .initializer("%S", file.path.substringAfter("resources/"))
                              .build()
                      )
                  }
              }
              .build()
  
          val fileSpec = com.squareup.kotlinpoet.FileSpec.builder("com.your.package", "Resource")
              .addType(resourceClass)
              .build()
  
          // 3. 把生成的代码写入输出目录
          fileSpec.writeTo(outputDir.get().asFile)
      }
  }
  

• 第二步：注册任务并关联到编译流程
  把自定义任务挂到编译Kotlin代码的前置环节，同时把生成的代码目录加入源码集，让编译器能识别：

  // 注册任务
  val generateResourceCode = tasks.register<GenerateResourceCodeTask>("generateResourceCode")
  
  // 让编译Kotlin依赖该任务，确保代码生成在编译前完成
  tasks.compileKotlin {
      dependsOn(generateResourceCode)
      // 添加生成代码目录到源码集
      sourceSets.main.get().java.srcDir(generateResourceCode.get().outputDir)
  }
  

这个方案的优势：

• 完全贴合资源变化触发的需求，Gradle自动追踪resources目录的新增/修改/删除操作
• 增量构建效率更高，只有资源变化时才会重新生成代码
• 逻辑更清晰，不需要依赖注解标记来触发代码生成

如果必须保留注解处理器的方案，核心是让Gradle知道注解处理器的输入包含resources目录，这样当资源变化时，注解处理器任务会自动重新运行。

分两种情况配置：

如果你用Kapt（Kotlin官方注解处理器工具） #

在build.gradle.kts中添加：

kapt {
    // 把resources目录添加为注解处理器的输入源
    inputs.dir(file("src/main/resources"))
    // 可选：开启增量注解处理，提升构建速度
    incremental = true
}

如果你用Java注解处理器（annotationProcessor） #

在build.gradle.kts中添加：

annotationProcessor {
    inputs.dir(file("src/main/resources"))
    incremental = true
}

额外注意点：

• 确保你的注解处理器支持增量处理（实现IncrementalAnnotationProcessor接口），这样Gradle可以只处理变化的部分，而不是全量重新运行
• 只要Gradle触发了注解处理器任务，不管main()方法有没有变化，处理器都会重新扫描所有带注解的元素，从而重新生成代码

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