如何在IntelliJ项目中通过代码解析Gradle构建文件的用户自定义参数

你当前使用的GradleBuild是Gradle内置的基础模型，仅支持获取构建文件路径、任务列表等通用构建信息，无法直接读取你自定义的扩展参数，可通过以下两种方案实现提取：

方案1：自定义Tooling Model（推荐，类型安全） #

该方案通过Gradle Tooling API的扩展模型能力，直接返回结构化的参数对象，适合长期使用的场景：

• 第一步：定义参数模型接口
  在Gradle项目的buildSrc/src/main/kotlin/目录下创建模型接口，用于跨进程传输参数：

  import java.io.Serializable
  
  interface CustomParamsModel : Serializable {
      val param1: String
      val subParam11: String
      val subParam21: String
      val subParam221: String
  }
  

• 第二步：在build.gradle.kts中注册模型构建器
  把你的自定义参数值映射到模型中：

  import org.gradle.tooling.provider.model.ToolingModelBuilder
  import org.gradle.tooling.provider.model.ToolingModelBuilderRegistry
  import javax.inject.Inject
  
  // 你原有的自定义参数配置
  customParameters {
     param1.set("any value")
     sub_parameters1 {
        sub_parameter1_1.set("foo")
     }
     subParameters2 {
        subParameter21("foo")
        subParameter22 {
           subParameter221.set("foo")
        }
     }
  }
  
  abstract class CustomParamsModelBuilder @Inject constructor(
      private val customParams: CustomParameters // 替换为你自定义扩展的实际类型
  ) : ToolingModelBuilder {
      override fun canBuild(modelName: String): Boolean = modelName == CustomParamsModel::class.java.name
      override fun buildAll(modelName: String, project: Project): Any = object : CustomParamsModel {
          override val param1 = customParams.param1.get()
          override val subParam11 = customParams.sub_parameters1.sub_parameter1_1.get()
          override val subParam21 = customParams.subParameters2.subParameter21.get()
          override val subParam221 = customParams.subParameters2.subParameter22.subParameter221.get()
      }
  }
  
  val registry = project.extensions.getByType(ToolingModelBuilderRegistry::class.java)
  registry.register(CustomParamsModelBuilder(extensions.getByType(CustomParameters::class.java)))
  

• 第三步：IntelliJ侧代码直接获取模型

  val connection: ProjectConnection = GradleConnector.newConnector()
      .forProjectDirectory(File(projectPath))
      .connect()
  
  val customModel = connection.model(CustomParamsModel::class.java).get()
  // 直接读取参数即可
  println(customModel.param1)
  println(customModel.subParam221)
  
  connection.close()
  

方案2：临时快速实现方案 #

如果不想修改项目的Gradle插件配置，可以通过执行自定义Gradle任务输出参数到临时文件，再读取解析：

• IntelliJ侧代码：

  val connection: ProjectConnection = GradleConnector.newConnector()
      .forProjectDirectory(File(projectPath))
      .connect()
  
  val tempOutput = createTempFile(suffix = ".txt")
  connection.newBuild()
      .withArguments("-PoutputPath=${tempOutput.absolutePath}")
      .setTaskNames("extractCustomParams")
      .run()
  
  // 读取输出的参数自行解析
  val paramContent = tempOutput.readText()
  tempOutput.delete()
  connection.close()
  

• build.gradle.kts中追加提取任务：

  tasks.register("extractCustomParams") {
      doLast {
          val outputFile = file(properties["outputPath"] as String)
          val params = mapOf(
              "param1" to customParameters.param1.get(),
              "sub_parameter1_1" to customParameters.sub_parameters1.sub_parameter1_1.get(),
              "subParameter21" to customParameters.subParameters2.subParameter21.get(),
              "subParameter221" to customParameters.subParameters2.subParameter22.subParameter221.get()
          )
          outputFile.writeText(params.toString())
      }
  }
  

注意：你提供的示例中自定义扩展块拼写为cutomParameters，如果是笔误请替换为项目中实际的扩展名称。如果自定义扩展是第三方插件提供的，无法直接引用类型时，可以通过extensions.findByName("customParameters")反射获取属性值。

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