Gradle Java 插件

Java 插件是構建 JVM 專案的基礎，它為專案增加了很多能力，例如編譯，測驗，打包，發布等等，

很多插件都是基于 Java 插件實作的，例如 Android 插件，

用法

使用 id 應用插件

plugins {
    id 'java'
}

Source sets 源集

Java 插件引入了源集的概念，它在邏輯上表示一組用于編譯執行的源檔案，這些源檔案可能包括源代碼檔案和資源檔案，

一個源集有一個相關聯的編譯類路徑和運行時類路徑，

Java 插件就是通過源集的概念來管理源代碼目錄的，

源集的一個用途是，把源檔案進行邏輯上的分組，以描述它們的目的，
例如，你可能會使用一個源集來定義一個集成測驗套件，或者你可能會使用單獨的源集來定義你的專案的 API 和實作類，

Java 插件提供了兩個標準源集

• main 包含了專案的源代碼，被用于編譯和生成 JAR 檔案
• test 包含單元測驗源代碼，它們將被編譯并使用 JUnit 或 TestNG 來執行，

源集提供了很多屬性，我這里就列出幾個重要的屬性：

跟多的源集屬性可以查看下面的檔案

sourceSets DSL

sourceSets API

定義一個新的源集

源集的位置也很重要，不要在 dependencies 下面，否則對源集的依賴就將不起作用

sourceSets {
    other
}

訪問源集

sourceSets 是 Java 插件為 Project 增加的一個屬性，可以直接使用，

task outSourceSet {
    doLast {
        //遍歷
        sourceSets.all {
            println "$name -> "
        }
        println "-----分割線----"
        //單個的
        println "${sourceSets.main.name} -> "
        println "${sourceSets['main'].name} -> "

        //一些屬性
        println " java.srcDirs -->${sourceSets.main.java.srcDirs}"
        println " resource.srcDirs -->${sourceSets.main.resources.srcDirs}"
    }
}

為源集添加依賴

dependencies {
    // This dependency is used by the application.
    implementation 'com.google.guava:guava:27.1-jre'

    // Use JUnit test framework
    testImplementation 'junit:junit:4.12'
    //為 other 源集添加依賴
    otherImplementation 'com.google.code.gson:gson:2.8.5'
}

將源集打成一個 JAR 包

創建一個 otherJar 任務，將源集的輸出作為任務的檔案來源，

執行這個任務即可生成 JAR 包，

/**
 * 為 other 源集打個 jar 包
 * 默認輸出目錄是 build/libs
 * 默認名字是 [archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]
 */
task otherJar(type:Jar){
    archiveBaseName = sourceSets.other.name
    archiveVersion = '0.1.0'
    destinationDirectory = file("${project.projectDir}/jar")
    from sourceSets.other.output
}

為源集生成 doc

創建一個任務將源集的所有 Java 檔案作為源檔案，

執行這個任務即可生成 doc 檔案，

task otherDoc(type:Javadoc){
    destinationDir = file("${project.projectDir}/doc")
    source sourceSets.other.allJava
    title sourceSets.other.name
}

專案結構

Java 插件的默認目錄結構如下所示, 無論這些檔案夾中有沒有內容, Java 插件都會編譯里面的內容, 并處理沒有的內容，

這個目錄結構也是 Java 世界標準的專案目錄，

更改默認目錄

這里以更改 main 源集的源代碼和資源目錄為例

sourceSets {
    main {
        java {
            srcDirs = ['src/java']
        }
        resources {
            srcDirs = ['src/resources']
        }
    }
}

增加的任務

Java 插件為 Project 增加了很多實用的任務，如下：

• compileJava 型別是 JavaCompile

  依賴于：所有參與編譯類路徑的任務，包括 jar 任務和通過專案依賴性在類路徑上的專案中的任務，

  功能：使用 JDK 編譯器編譯生產 Java 源檔案，

• processResources Copy

  功能：復制生產資源到資源目錄

• classes

  依賴：compileJava , processResources

  這是個整合的任務，只是依賴于其他任務，其他插件可能會附加別的編譯任務到這里，

• compileTestJava JavaCompile

  依賴：classes, 以及有助于測驗編譯類路徑的所有任務

  功能：使用 JDK 編譯器編譯測驗 Java 源代碼和資源檔案

• processTestResources Copy

  功能：復制測驗資源到測驗資源目錄

• testClasses

  依賴：compileTestJava , processTestResources

  這是個整合任務，只是依賴其他任務，其他擴展插件可能會將測驗編譯任務附加到這里，

• jar Jar

  依賴：classes

  功能：根據主源集的類和資源，組裝生產 JAR 檔案，

• javadoc JavaDoc

  依賴：classes

  功能：生成 API 檔案，

• test Test

  依賴：testClasses 以及生成測驗運行時類路徑的所有任務

  功能：使用 JUnit 或者 TestNG 運行單元測驗

• uploadArchives Upload

  依賴：jar 以及生辰附加在 archives{} 配置里的構件的任何其他任務，

  功能：上傳 archives{} 配置里的構件包含生成的 JAR 檔案到配置的倉庫，

• clean Delete

  功能：洗掉專案構建目錄

• clean[TaskName] Delete

  功能：洗掉由指定任務生成的檔案，例如 cleanJar 將洗掉由 jar 任務產生的檔案，

源集任務

你增加的每一個源集，Java 插件都會為它增加下面列出的任務：

• compilesourceSetJava JavaCompile

  依賴：所有有助于源集編譯類路徑的任務，

  功能：使用 JDK 編譯器編譯給定源集的 Java 源檔案

• processsourceSetResources Copy

  功能：復制給定源集的資源到資源目錄

• sourceSetClasses Task

  依賴：compilesourceSetJava , processsourceSetResources

  功能：準備給定的源集的類和資源以進行打包和執行，一些擴展插件可能會為給定源集附加編譯任務到這里

生命周期任務

Java 插件將它的一些任務附加到基礎插件(Java插件自動應用)定義的生命周期任務上，

它還添加了一些其他的生命周期任務:

• assemble

  依賴：jar, 以及創建附加到歸檔配置的工件的所有其他任務，

  匯總專案中所有歸檔的聚合任務， 這個任務是基礎插件（Base）里定義的，

• check

  依賴：test

  匯總專案中的驗證任務，例如運行測驗，一些插件會增加自己的驗證任務到這里，這個任務是基礎插件（Base) 里定義的，

• build

  依賴：check, assemble

  聚合執行專案完整構建的任務，這個任務是基礎插件（Base) 里定義的，

• buildNeeded

  依賴：build ,以及在testRuntimeClasspath配置中依賴的所有專案中的buildNeeded任務，

  執行專案本身及其依賴的所有專案的完整構建，

• buildDependents

  依賴：build, 以及在 testRuntimeClasspath 配置中依賴此專案的所有專案的 buildDependents 任務

  執行專案本身以及依賴于它的所有專案的完整構建，

• buildConfigName -任務規則

  依賴：生成附加到命名- ConfigName -配置的工件的所有任務

  為指定的配置組裝工件，這個規則是在基礎插件增加的，

• uploadConfigName -任務規則，型別：Upload

  依賴：生成附加到命名- ConfigName -配置的工件的所有任務

  在指定的配置里組裝和上傳構件，這個規則是在基礎插件增加的，

下面的圖展示了這些任務的關系

依賴管理

Java 插件增加了很多依賴配置到專案中，JavaCompile 和 test 任務就可以使用這些配置將依賴檔案添加到類路徑并使用他們，

下面兩張圖是 main 和 test 源集的配置依賴關系

• 灰色字體：已廢棄的
• 黑色字體綠色背景：可以根據配置宣告依賴項，
• 灰藍背景： 該配置用于被任務使用，而不是用于宣告依賴項，
• 淺藍色背景：任務

除了以上的配置，Java 插件為了每個源集還添加了以下配置，這些配置只針對給定源集

增加的屬性

Java 插件為專案增加了很多新的屬性，可以在腳本中直接使用這些屬性，

下面是一些我認為比較重要的屬性：

更多的屬性可以查看檔案 Convention properties

學習資料：

• https://wiki.jikexueyuan.com/project/gradle/java-package.html
• http://benweizhu.github.io/blog/2015/01/31/deep-into-gradle-in-action-2/
• https://docs.gradle.org/current/userguide/java_plugin.html
• https://docs.gradle.org/current/userguide/building_java_projects.html

標籤：Android

上一篇：自定義View入門-繪制基礎(1)

下一篇：Could not find any version that matches com.android.support:appcompat-v7:29.+