咨询如何为共享Gradle插件添加可配置动态参数

针对你从Groovy迁移到KTS后遇到的apply(from)兼容问题，以及想要封装可动态配置的SonarQube插件需求，下面是具体实现方案和最佳实践：

一、优先用自定义扩展实现动态配置，而非直接依赖gradle.properties #

gradle.properties确实能实现配置共享，但它是无类型的字符串配置，缺乏校验和默认值支持，维护起来不如Gradle官方推荐的**自定义扩展（Extension）**灵活。自定义扩展能提供类型安全、默认值、甚至配置校验，更符合Gradle插件的设计规范。

二、实现可配置的SonarQube封装插件 #

1. 在buildSrc中创建插件（单仓库多项目场景首选） #

如果是单仓库多项目，直接把插件放在buildSrc目录下，Gradle会自动识别并编译，无需额外配置。

首先在buildSrc/src/main/kotlin下创建插件类和扩展类：

定义扩展类（用于接收项目的动态配置）

import org.gradle.api.model.ObjectFactory
import javax.inject.Inject

// 自定义扩展，让项目可以配置sonar的动态属性
open class SonarExtension @Inject constructor(objects: ObjectFactory) {
    // 动态配置项，留空让项目自己设置
    val projectKey = objects.property(String::class.java)
    val projectName = objects.property(String::class.java)
    
    // 固定配置可以在这里设默认值，也可以在插件里直接写死
    val hostUrl = objects.property(String::class.java).convention("https://sonar.somewhere.com")
    val jsonReportPath = objects.property(String::class.java).convention("./build/reports/dependency-check-report.json")
    val htmlReportPath = objects.property(String::class.java).convention("./build/reports/dependency-check-report.html")
}

编写插件类（自动应用SonarQube并绑定配置）

import org.gradle.api.Plugin
import org.gradle.api.Project
import org.sonarqube.gradle.SonarQubeExtension

class SharedSonarPlugin : Plugin<Project> {
    override fun apply(project: Project) {
        // 1. 自动应用SonarQube插件
        project.plugins.apply("org.sonarqube")
        
        // 2. 创建自定义扩展，让项目可以配置动态属性
        val sonarExt = project.extensions.create("sharedSonar", SonarExtension::class.java)
        
        // 3. 配置SonarQube的properties，将扩展的配置映射过去
        project.extensions.configure(SonarQubeExtension::class.java) { sonar ->
            sonar.properties { props ->
                // 绑定动态配置项
                props.property("sonar.projectKey", sonarExt.projectKey)
                props.property("sonar.projectName", sonarExt.projectName)
                
                // 固定配置项
                props.property("sonar.host.url", sonarExt.hostUrl)
                props.property("sonar.dependencyCheck.jsonReportPath", sonarExt.jsonReportPath)
                props.property("sonar.dependencyCheck.htmlReportPath", sonarExt.htmlReportPath)
            }
        }
    }
}

注册插件（在buildSrc的resources目录下添加配置）

在buildSrc/src/main/resources/META-INF/gradle-plugins目录下创建文件com.yourcompany.shared-sonar.properties，内容为：

implementation-class=SharedSonarPlugin

2. 在项目中应用插件并配置动态属性 #

在项目的build.gradle.kts中：

plugins {
    id("com.yourcompany.shared-sonar")
}

// 配置自定义扩展的动态属性
sharedSonar {
    projectKey.set("your-project-key")
    projectName.set("Your Project Display Name")
    // 如果需要覆盖默认的hostUrl，也可以在这里设置
    // hostUrl.set("https://custom-sonar.com")
}

三、跨项目共享构建代码的正确方式 #

• 单仓库多项目：用buildSrc存放自定义插件，简单直接，无需发布，Gradle自动管理编译。
• 多仓库共享：把插件发布到私有Maven仓库（比如Nexus、Artifactory），然后各个项目通过plugins块引用，这种方式适合多个独立仓库共用一套构建规范。

四、关于gradle.properties的使用场景 #

如果你的配置非常简单，不需要类型校验和默认值，用gradle.properties也可以，但不推荐作为主要配置方式。如果要用，插件中可以这样读取：

// 在插件类中读取gradle.properties的属性
val projectKey = project.findProperty("sonar.projectKey") as? String 
    ?: error("请在gradle.properties中设置sonar.projectKey")

但这种方式缺乏类型安全，也无法在编写配置时获得IDE提示，远不如自定义扩展好用。

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