如何通过Kotlin KSP生成Android资源XML文件

核心实现逻辑 #

不需要把注解解析、资源生成逻辑迁移到build.gradle，KSP作为通用Kotlin符号处理工具本身不绑定Android平台，所以没有提供直接获取Android资源输出目录的API，通过Gradle传参打通KSP和AGP的资源目录配置即可，所有业务逻辑全部留在KSP处理器内实现即可。

具体操作步骤 #

• 第一步：模块级build.gradle配置，打通目录传递和资源注册
  在对应Android模块的build.gradle中添加如下配置，仅做参数传递和源集注册，不写任何注解解析、资源内容生成逻辑：

  android {
      // 省略原有buildConfig、compileSdk等配置
      applicationVariants.all { variant ->
          // 匹配对应构建变体的KSP任务
          def kspVariantTask = tasks.named("ksp${variant.name.capitalize()}")
          kspVariantTask.configure {
              // 向KSP处理器传递资源生成目标路径，路径遵循AGP生成资源的规范：build/generated/res/[生成器标识]/[变体路径]
              it.arg(
                  "kspResOutputDir",
                  "${layout.buildDirectory.get().asFile.absolutePath}/generated/res/your_annotation_generator/${variant.dirName}"
              )
          }
          // 将生成目录注册为AGP认可的资源源目录，该目录下的资源会自动参与编译、R类生成、APK打包
          variant.registerResGeneratingTask(kspVariantTask.get(), file(kspVariantTask.get().arguments.kspResOutputDir))
      }
  }
  

  如果是Library模块，把applicationVariants换成libraryVariants即可。

• 第二步：KSP处理器接收路径参数，直接生成资源文件
  在你的SymbolProcessorProvider实现中读取Gradle传入的路径，传入自定义Processor使用：

  class CustomAnnotationProcessorProvider : SymbolProcessorProvider {
      override fun create(environment: SymbolProcessorEnvironment): SymbolProcessor {
          // 读取Gradle传入的资源输出目录，不存在则创建
          val resOutputDir = File(
              environment.options["kspResOutputDir"]
                  ?: throw IllegalStateException("未配置KSP资源输出目录参数")
          ).apply { mkdirs() }
          return CustomAnnotationProcessor(environment.codeGenerator, resOutputDir)
      }
  }
  

  后续在Processor的处理逻辑中，解析完注解拿到数据后，直接按照Android资源目录规范在resOutputDir下创建对应子目录写入XML即可：比如生成字符串资源就建values子目录写入generated_strings.xml，生成布局资源就建layout子目录写入对应布局XML，和你手动写res目录下的文件规则完全一致。

避坑说明 #

• 资源路径必须按构建变体拆分，不要所有变体共用一个输出目录，否则会出现多渠道、debug/release构建时资源覆盖、重复冲突问题
• 生成的资源文件建议加统一前缀（比如generated_开头），避免和业务现有资源重名导致编译失败
• 不要硬编码build目录路径，不同AGP版本、构建配置下build目录位置可能变动，必须通过Gradle传参获取路径保证兼容性
• 资源文件不属于Kotlin/Java源码，不需要通过KSP的CodeGenerator创建，直接用标准文件API写入即可，Gradle会自动识别目录下的文件变动处理增量编译

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