使用 Kotlin DSL 和 buildSrc 优化 Gradle 任务管理

// build.gradle.kts (projet racine)
plugins {
    base // Appliqué au projet racine
}

allprojects {
    group = "com.example"
    version = "1.0.0"

    repositories {
        mavenCentral()
    }

    tasks.withType<org.gradle.api.tasks.testing.Test> {
        useJUnitPlatform() // Configuration commune des tests pour tous les projets
    }
}

subprojects {
    apply(plugin = "java")
    apply(plugin = "org.jetbrains.kotlin.jvm")

    dependencies {
        implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
    }

}

----
----
init {
    group = "verification"
    description = "Opens a test report in Firefox."
    dependsOn("check") // Assure que les rapports sont générés
}

@get:Input
abstract var reportPath: String

@TaskAction
fun openReport() {
    val separator = File.separator
    val reportFile = project.layout.projectDirectory.asFile.toPath()
        .resolve(reportPath.replace("/", separator))
        .toAbsolutePath()
        .toFile()

    if (!reportFile.exists()) {
        logger.warn("Report file does not exist: $reportFile. Ensure 'check' ran.")
        return
    }

    project.exec {
        commandLine("firefox", "--new-tab", reportFile.absolutePath)
    }
    logger.lifecycle("Opened test report: ${reportFile.absolutePath}")
}
----

## }

\=== 具体实现

这些类继承自抽象任务，并定义了报告的特定路径。

## [source,kotlin]

包 com.yourpackage

抽象类 ReportUnitTestsTask : OpenTestReportTask() init { 在 Firefox 中打开单元测试报告。 reportPath = "build/reports/tests/test/index.html } }

package com.yourpackage

abstract class ReportFunctionalTestsTask : OpenTestReportTask() { init { description = "在Firefox中打开功能测试报告。" reportPath = "build/reports/tests/functionalTest/index.html" } }

\=== 任务记录

在`build.gradle.kts`您的根项目 :

## [source,kotlin]

tasks.register\<com.yourpackage.ReportUnitTestsTask\>("reportTests") {} tasks.register\<com.yourpackage.ReportFunctionalTestsTask\>("reportFunctionalTests") {}

报告任务UML图 (PlantUML代码)

复制下面的代码，然后粘贴到支持 PlantUML 的工具。

## [source,plantuml]

@startuml skinparam handwritten true skinparam 单色 true

�抽象类 DefaultTask { }

abstract class Exec { \+ commandLine(args: String...) \+ exec() }

abstract class OpenTestReportTask extends DefaultTask { \+ group: String = "verification + 描述: 字符串 \+ dependsOn("check") + 抽象 报告路径: 字符串 + openReport() : void }

抽象类 AbstractJbakeExecTask 继承自 Exec { \+ group: String = "验证 \+ 描述: 字符串 \+ dependsOn("check") \+ abstract reportRelativePath: String \+ exec() : 无返回值 }

类 ReportUnitTestsTask 继承自 OpenTestReportTask { \+ reportPath: String = "build/reports/tests/test/index.html }

class ReportFunctionalTestsTask extends OpenTestReportTask { \+ reportPath: String = "build/reports/tests/functionalTest/index.html }

类 ReportJbakeTestsTask 继承 AbstractJbakeExecTask { \+ reportRelativePath: String = "build/reports/tests/test/index.html }

类 ReportJbakeFunctionalTestsTask 继承 AbstractJbakeExecTask { \+ reportRelativePath: 字符串 = "build/reports/tests/functionalTest/index.html }

OpenTestReportTask \<-- ReportUnitTestsTask OpenTestReportTask \<-- ReportFunctionalTestsTask

AbstractJbakeExecTask &#60;-- ReportJbakeTestsTask AbstractJbakeExecTask \<-- ReportJbakeFunctionalTestsTask

默认任务 \<|-- 打开测试报告任务 Exec \<|-- AbstractJbakeExecTask 默认任务 <|-- 执行

## @enduml

\== 抽象任务`AbstractJbakeExecTask`(继承`Exec`)

如果您的任务主要是执行带有变量参数的外部命令，请直接继承**�执行**更直接。

## [source,kotlin]

包 com.yourpackage

import org.gradle.api.tasks.Exec import org.gradle.api.tasks.Input import java.io.File

抽象类 AbstractJbakeExecTask : Exec() {

----

init { group = "verification" description = "Opens a Jbake project report in Firefox." dependsOn("check") }

@get:Input abstract var reportRelativePath: String

override fun exec() { val separator = File.separator val reportFile = project.layout.projectDirectory.asFile.toPath() .resolve(reportRelativePath.replace("/", separator)) .toAbsolutePath() .toFile()

if (!reportFile.exists()) { logger.warn("Report file does not exist: $reportFile. Ensure 'check' ran.") return }

commandLine("firefox", "--new-tab", reportFile.absolutePath) logger.lifecycle("Attempting to open report: ${reportFile.absolutePath}") super.exec() // Appelle la méthode exec() de la super-classe Exec }

## }

\=== 具体实现用于`Exec`

## [source,kotlin]

package com.yourpackage

抽象类 ReportJbakeTestsTask : AbstractJbakeExecTask() 初始化 { 在 Firefox 中打开 Jbake 单元测试报告。 reportRelativePath = "build/reports/tests/test/index.html } }

package com.yourpackage

## abstract class ReportJbakeFunctionalTestsTask : AbstractJbakeExecTask() { init { description = "在 Firefox 中打开功能测试报告。" reportRelativePath = "build/reports/tests/functionalTest/index.html" } }

\== 任务可见性`buildSrc`

您定义的任务和类在**buildSrc**是：

***可见且可用**由您的主构建中的所有项目（根项目和子项目）。因此，您可以使用`com.yourpackage.ReportUnitTestsTask`在`allprojects { ... }`. ***不可执行的**直接作为 buildSrc 任务（例如,`gradle :buildSrc:reportTests`如果任务没有被具体地记录在`buildSrc/build.gradle.kts`)。`buildSrc`这是一个编译模块，而不是用于这些主构建任务的可执行应用模块。

\=== 为测试运行报告`buildSrc`他自己

Si `buildSrc`它有自己的测试并生成报告，您可以直接在其中记录报告任务`buildSrc/build.gradle.kts`:

## [source,kotlin]

插件 { `kotlin-jvm` }

仓库 { mavenCentral() }

tasks.withType<Test>{ useJUnitPlatform() reports.html.outputLocation.set(layout.buildDirectory.dir("reports/tests")) }

import com.yourpackage.ReportJbakeTestsTask // 导入您的任务类

tasks.register<ReportJbakeTestsTask>("reportBuildSrcTests") { // 路径已经在类中定义，它将指向 buildSrc 的报告。 }

然后您可以执行 :`./gradlew :buildSrc:test`随后`./gradlew :buildSrc:reportBuildSrcTests`.

通过采用这些实践，您将构建出不仅功能强大，而且模块化程度极高、易于维护且易于理解的 Gradle Kotlin DSL 构建系统。