使用Gradle Task 構建優雅的Java項目

Gradle是一個非常有名的構建工具，它可以用於構建各種類型的項目，從Java到Android，從前端到後端。如果您是一個Java開發人員，那麼一定會接觸到Gradle。在進行大型Java項目開發時，你可能會面臨這樣的問題：如何管理和自動化構建代碼庫的開發構建？Gradle Task 可以幫助您快速、可靠地解決這個問題，並自動化您的日常Java項目工作。

一、Gradle Task是什麼？

一個Gradle工程中最小的執行單元是Task。task是一個可執行的操作，例如編譯代碼、運行測試、打開應用程序或將代碼發布到服務器上。Gradle Task是Gradle支持的主要元素之一。開發人員可以使用Task來模擬任務的生命周期，以及定義代碼和資源的編譯、構建、測試、打包和部署等多個階段的構建任務。

二、Gradle命令行工具

Gradle支持自己的命令行工具，您可以在構建腳本中定義所有可能的操作和Target，以便您可以使用Gradle命令行調用這些操作和Target。

//一個簡單的Gradle task定義
task hello {
    doLast {
        println 'Hello world!'
    }
}

執行gradle hello 命令會輸出 “Hello world!”

三、Gradle構建腳本

Gradle構建腳本可以通過DSL語言（領域專用語言）書寫，通常是Groovy和Kotlin語言的混合。您可以通過編寫構建腳本來定義項目的組織結構、依賴項和任務。Gradle會根據腳本中的信息自動計算項目的依賴圖，並確定要執行的任務。通俗易懂的說，Gradle構建腳本就是一種代碼，通過它可以定義項目的構建、編譯、測試、打包等任務。

四、通過Gradle Task 執行Java應用程序

Gradle Task可以幫助我們管理各種類型的任務，其中最常見的就是Java的構建和自動化測試。例如，您可以使用Gradle構建Java項目，並在Gradle Task的幫助下運行Java應用程序。

首先，在build.gradle文件中添加如下內容：

apply plugin: 'java'

task run(type: JavaExec) {
    main = 'com.example.Main'
    classpath = sourceSets.main.runtimeClasspath
}

接下來，您可以使用gradle run命令以編程方式啟動應用程序。

五、Gradle Task 集成測試框架

Gradle Task可以用於與單元測試框架、集成測試框架、靜態分析工具和代碼覆蓋率工具集成。

例如，您可以使用Gradle Task來進行與JUnit框架的集成，以運行Java項目的自動化測試，並生成JUnit報告。

apply plugin: 'java'
apply plugin: 'jacoco'

task test(type: Test) {
    testClassesDirs = sourceSets.test.output.classesDirs
    classpath = sourceSets.test.runtimeClasspath
    jacoco {
        append = false 
        destinationFile = file("$buildDir/jacoco/test.exec")
        classDumpDir = file("$buildDir/jacoco/classpathdumps")
    }
}

jacocoTestReport {
    reports {
        html.enabled true
        xml.enabled false
    }
    
    def coverageSourceDirs = [
            'src/main/java'
    ]
    
    sourceDirectories = files(coverageSourceDirs)
    classDirectories = files(sourceSets.main.output.classesDirs)
    executionData = files("$buildDir/jacoco/test.exec")
}

執行gradle test命令可以執行集成測試並生成JUnit報告和JaCoCoTest覆蓋率記錄。這些報告可以在 build/reports目錄中查看。

六、Gradle Task 打包、發布jar包

Gradle Task可以用於打包和發布Java項目，例如JAR包、WAR包甚至是Spring Boot應用程序。您可以使用很多常見的命令，例如打包、簽名、驗證、發布和分發任務，以自動執行部署程序。

apply plugin: 'java'

task jarTask(type: Jar) {
    baseName = 'myApp'
    version = '1.0-SNAPSHOT'
    from {
        configurations.compile.collect {
            it.isDirectory() ? it : zipTree(it)
        }
    }
    with jar
}

task publish(type: PublishToMavenRepository) {
    repositories.mavenDeployer {
        repository(url: "http://myrepo.com/releases")
        pom.groupId = 'com.example'
        pom.artifactId = 'myApp'
        pom.version = '1.0'
    }
}

執行gradle jar 可以創建一個JAR包。執行gradle publish 發布JAR包到指定的maven庫。

七、Gradle Task 處理依賴項

在Java工程中，使用依賴項是必不可少的。Gradle Task提供了許多有用的API可供使用，以定義和處理依賴項。

例如，以下示例演示如何在Gradle構建中添加一個庫依賴項：

repositories {
    mavenCentral()
}
dependencies {
    implementation 'com.google.guava:guava:30.0-jre'
}

Gradle Task通過implementation這個關鍵字定義了這個庫依賴項是作為編程依賴項。Gradle任務通過mavenCentral()定義了庫可用的Maven中心倉庫，這些倉庫存放在相應的URL服務器上，並以JAR文件作為最終的構建輸出。

八、Gradle Task 資源過濾

Gradle Task可以幫助開發人員自動化項目管理過程中的冗長工作。例如，資源過濾操作就可以幫助開發人員規範構建過程中的環境變量、版本號和程序名稱等。

您可以在build.gradle文件中定義資源篩選器，以指定文件或目錄應該從構建輸出中排除，或者指定從構建過程中引用的外部配置文件中最終將要替換的模板變量。

processResources {
    def props = [buildNumber: project.buildNumber]
    expand props
} 

這個簡單的Gradle任務定義了一個處理資源的任務。它可以使用${buildNumber}來替換資源文件中的模板變量。

九、Gradle 多項目構建

Gradle Task可以與多模塊項目配合使用，以達到共享代碼和構建邏輯，同時保持項目結構的清晰性。

例如，您可以通過如下方式來創建一個多項目構建腳本：

//root build.gradle文件
subprojects {
    apply plugin: 'java'

    repositories {
        mavenCentral()
    }

    task run(type: JavaExec) {
        mainClassName = 'com.example.Main'
        classpath = sourceSets.main.runtimeClasspath
    }
}

//app1項目build.gradle文件
dependencies {
    implementation group: 'com.google.guava', name: 'guava', version: '30.0-jre'
}

在這個例子中，我們創建了一個簡單的本地多項目配置，其中包括一個稱為app1的模塊。這個模塊添加了一個依賴項: Guava庫，並使用JavaExec任務運行了一個簡單的類。

十、小結

Gradle Task是一個非常強大而靈活的Java構建自動化工具。在本文中，我們介紹了一些常見的Gradle任務和技巧，包括Gradle命令行工具、構建腳本、執行Java應用程序、集成測試框架、打包發布jar包、處理依賴項、資源過濾和多項目構建。我們希望這些技巧能夠幫助您加速Java項目的開發和管理。