盡管我們可以僅使用單個組件來創建可工作的應用程序,但有時候更廣泛的做法是將應用程序劃分為多個更小的模塊。
由于這是一個非常普通的案例,因此每個成熟的構建工具都必須支持這項功能,Gradle也不例外。倘若Gradle項目擁有多于一個組件,我們就將其稱之為多項目構建(multi-project build)。
這篇教程描述了如何使用Gradle創建一個多項目構建。
Gradle Build 的需求
我們的示例程序擁有兩個模塊:
core模塊包含一些通用的組件,它們能夠被程序的其他模塊使用。在我們的例子上,只包含一個類:MessageService類返回‘Hello World!’字符串。該模塊只有一個依賴:它包含一個單元測試,使用Junit 4.11。
app模塊包含HelloWorld類,是程序的開端,它從MessageService對象中獲取信息,并將接收到的信息寫入一個日志文件中。該模塊擁有兩個依賴:它需要core模塊,還使用Log4j 1.2.17作為日志庫。
我們的Gradle構建還有其他兩個需求:
我們必須要使用Gradle運行程序。
我們必須要創建一個可運行的二進制發布,而且不能使用所謂的“fat jar”方式。
如果你還不清楚怎樣使用Gradle運行程序,以及創建可運行的二進制發布,在閱讀這篇教程前,你應該先閱讀以下文章。
<NO.4>自從用了Android Studio,Gradle是必須學了...
我們繼續來探討一下如何創建一個多項目構建來滿足我們的需求。
創建一個多項目構建
下一步,我們將創建一個多項目的Gradle構建,包括兩個子項目:app 和 core。初始階段,先要建立Gradle構建的目錄結構。
建立目錄結構
由于core和app模塊都使用Java語言,而且它們都使用Java項目的默認項目布局,我們根據以下步驟建立正確的目錄結構:
建立core模塊的根目錄(core),并建立以下子目錄:
src/main/java目錄包含core模塊的源代碼。
src/test/java目錄包含core模塊的單元測試。
建立app模塊的根目錄(app),并建立以下子目錄:
src/main/java目錄包含app模塊的源代碼。
src/main/resources目錄包含app模塊的資源文件。
現在,我們已經創建了所需的目錄,下一步是配置Gradle構建,先對包含在多項目構建中的項目進行配置。
對包含在多項目構建中的項目進行配置
我們可以通過以下步驟,對包含在多項目構建中的項目進行配置:
在根項目的根目錄下創建settings.gradle文件,一個多項目Gradle構建必須含有這個文件,因為它指明了那些包含在多項目構建中的項目。
確保app和core項目包含在我們的多項目構建中。
我們的settings.gradle文件如下:
include 'app'
include 'core'
配置 core 項目
我們可以通過以下步驟對core項目進行配置:
1. 在core項目的根目錄下創建build.gradle文件。
2. 使用Java插件創建一個Java項目。
3. 確保core項目從Maven2中央倉庫(central Maven2 repository)中獲取依賴。
4. 聲明JUnit依賴(版本4.11),并使用testCompile配置項,該配置項表明:core項目在它的單元測試被編譯前,需要JUnit庫。
core項目的build.gradle文件如下:
apply plugin: 'java'
repositories {
mavenCentral()
}
dependencies {
testCompile 'junit:junit:4.11'
}
我們繼續對app項目進行配置。
配置App項目
在配置app項目之前,我們先來快速瀏覽一下對一些特殊依賴的依賴管理,這些依賴都是同一個多項目構建的一部分,我們將其稱之為”項目依賴“。
如果多項目構建擁有項目A和B,同時,項目B的編譯需要項目A,我們可以通過在項目B的build.gradle文件中添加以下依賴聲明來進行依賴配置。
dependencies {
compile project(':A')
}
現在,我們可以按照以下步驟配置app項目:
在app項目的根目錄下創建build.gradle文件。
用Java插件創建一個Java項目。
確保app項目從Maven2中央倉庫(central Maven2 repository)中獲取依賴。
配置所需的依賴,app項目在編譯時需要兩個依賴:
Log4j (version 1.2.17)
core 模塊
創建二進制發布版本
app項目的build.gradle文件如下:
apply plugin: 'application'
apply plugin: 'java'
repositories {
mavenCentral()
}
dependencies {
compile 'log4j:log4j:1.2.17'
compile project(':core')
}
mainClassName = 'net.petrikainulainen.gradle.client.HelloWorld'
task copyLicense {
outputs.file new File("$buildDir/LICENSE")
doLast {
copy {
from "LICENSE"
into "$buildDir"
}
}
}
applicationDistribution.from(copyLicense) {
into ""
}
我們繼續,下面是移除core和app項目的構建腳本中的重復配置。
移除重復配置
當我們對多項目構建中的子項目進行配置時,我們在core和app項目的構建腳本中添加了重復的配置。
由于兩個項目都是Java項目,因此它們都使用Java插件。
兩個項目都使用Maven2中央倉庫(central Maven2 repository)。
換句話說,兩個構建腳本都包含以下配置:
apply plugin: 'java'
repositories {
mavenCentral()
}
讓我們將這項配置轉移到根項目的build.gradle文件中,在此之前,我們必須先學習一下如何在根項目的build.gradle文件中配置子項目。
如果我們想要在一個稱為core的子項目中添加配置,那么就必須在根項目的build.gradle文件中添加以下片段:
project(':core') {
//Add core specific configuration here
}
換句話說,如果想要將重復的配置轉移到根項目的構建腳本中,就必須將以下配置添加到build.gradle文件中:
project(':app') {
apply plugin: 'java'
repositories {
mavenCentral()
}
}
project(':core') {
apply plugin: 'java'
repositories {
mavenCentral()
}
}
不過這種做法在實質上并沒有改變什么,在構建腳本中依然還存在重復配置,唯一的區別是重復配置現在轉移到了根項目的build.gradle文件中。讓我們來消滅這些重復配置。
如果我們想要在根項目的子項目中添加通用的配置,需要將以下片段添加到根項目的build.gradle文件中:
subprojects {
//Add common configuration here
}
在根項目的build.gradle文件中移除了重復配置后,代碼如下:
subprojects {
apply plugin: 'java'
repositories {
mavenCentral()
}
}
如果我們的配置項是被多項目構建中的所有項目所共享的,那么需要在根項目的build.gradle文件中添加以下片段:
allprojects {
//Add configuration here
}
現在,我們可以從子項目的構建腳本中移除重復配置,子項目新的構建腳本如下:
core/build.gradle文件如下:
dependencies {
testCompile 'junit:junit:4.11'
}
app/build.gradle文件如下:
apply plugin: 'application'
dependencies {
compile 'log4j:log4j:1.2.17'
compile project(':core')
}
mainClassName = 'net.petrikainulainen.gradle.client.HelloWorld'
task copyLicense {
outputs.file new File("$buildDir/LICENSE")
doLast {
copy {
from "LICENSE"
into "$buildDir"
}
}
}
applicationDistribution.from(copyLicense) {
into ""
}
我們剛剛做了什么?
在我們的多項目構建的根目錄下執行命令gradle projects,可以看到如下輸出:
> gradle projects:projects ------------------------------------------------------------Root project------------------------------------------------------------ Root project 'multi-project-build'+--- Project ':app'--- Project ':core' To see a list of the tasks of a project, run gradle:tasks
For example, try running gradle :app:tasks
BUILD SUCCESSFUL
正如我們所看到的,這條命令列出了根項目的子項目(app和core),這意味著我們剛才已經創建了一個多項目Gradle構建,它擁有兩個子項目。
在我們的多項目構建的根目錄下執行命令gradle tasks,可以看到如下輸出(僅列出相關部分):
> gradle tasks
:tasks
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------
Application tasks
-----------------
distTar - Bundles the project as a JVM application with libs and OS specific scripts.
distZip - Bundles the project as a JVM application with libs and OS specific scripts.
installApp -Installs the project as a JVM application along with libs and OS specific scripts
run - Runs this project as a JVM application
正如我們所看到的,我們可以使用Gradle運行程序,并創建一個可運行的二進制發布,它沒有使用所謂的“fat jar”方式。這表明我們已經滿足了本文中要求實現的Gradle構建的所有需求。
我們繼續來看一下,從這篇教程中我們學到了什么。
總結
這篇教程教會了我們三部分內容:
一個多項目構建必須在根項目的根目錄下包含settings.gradle文件,因為它指明了那些包含在多項目構建中的項目。
如果需要在多項目構建的所有項目中加入公用的配置或行為,我們可以將這項配置加入到根項目的build.gradle文件中(使用allprojects)。
如果需要在根項目的子項目中加入公用的配置或行為,我們可以將這項配置加入到根項目的build.gradle文件中(使用subprojects)。
P.S. 你可以從Github上獲取這篇教程的演示程序。
https://github.com/pkainulainen/gradle-examples/tree/master/multi-project-build