高效開發(fā)Gradle架構(gòu)設(shè)計圖解/掌握項目工程自動化技巧
Gradle是一個強大的自動化構(gòu)建工具,它通過靈活的構(gòu)建腳本和豐富的插件生態(tài)系統(tǒng),為Java和其他語言的項目提供了現(xiàn)代化的構(gòu)建解決方案。無論您是構(gòu)建簡單的應(yīng)用還是復(fù)雜的多模塊項目,Gradle都能以其高效的性能和卓越的可擴展性滿足您的需求。本文將引導(dǎo)您深入了解Gradle的核心概念、最佳實踐和高級技巧,幫助您充分利用這一強大的工具。
1、Gradle 介紹
Gradle是一個開源的構(gòu)建自動化工具,它足夠靈活,可以構(gòu)建幾乎任何類型的軟件。以下是Gradle的一些核心特點和功能:
- 靈活性:Gradle使用Groovy或Kotlin編寫構(gòu)建腳本,提供了高度的靈活性和可定制性。
- 依賴管理:Gradle提供了強大的依賴管理功能,支持從多種來源(如Maven中央倉庫、本地JAR文件和遠程倉庫)獲取依賴,并能自動解析和下載依賴。
- 多項目構(gòu)建:Gradle支持多項目構(gòu)建,能夠輕松處理由多個子項目組成的復(fù)雜項目結(jié)構(gòu)。
- 增量構(gòu)建:Gradle具備優(yōu)秀的增量構(gòu)建能力,只重新構(gòu)建發(fā)生更改的部分,從而顯著減少構(gòu)建時間。
- 可擴展性:通過編寫自定義插件和任務(wù),可以將Gradle擴展到滿足特定項目的需求,并且有豐富的第三方插件庫可供選擇。
- 與現(xiàn)有工具的兼容性:盡管Gradle有自己的構(gòu)建腳本格式,但它仍然與Maven和Ant等傳統(tǒng)的構(gòu)建工具兼容。
- 性能:Gradle通過增量構(gòu)建和構(gòu)建緩存等特性,優(yōu)化了構(gòu)建性能。
- IDE支持:主流的IDE都支持導(dǎo)入Gradle構(gòu)建并且通過圖形化界面的方式與Gradle進行交互。
- 聲明式構(gòu)建:Gradle汲取了Maven的長處,以Java項目為例,只要將合適的文件放在合適的地方,應(yīng)用合適的插件就可以簡單地執(zhí)行構(gòu)建。
- 跨平臺:作為一個基于JVM的工具,Gradle可以輕易地實現(xiàn)跨平臺構(gòu)建。
Gradle的設(shè)計哲學(xué)是提供一種靈活且強大的構(gòu)建系統(tǒng),它結(jié)合了Ant的靈活性和Maven的依賴管理能力,同時提供了更簡潔和強大的構(gòu)建腳本編寫方式。這些特性使得Gradle成為現(xiàn)代軟件開發(fā)中一個非常受歡迎的構(gòu)建工具。
2、Gradle 設(shè)計思路
Gradle的設(shè)計起源于對更高效、靈活的構(gòu)建工具的需求。以下是Gradle設(shè)計的幾個關(guān)鍵點:
- 對Ant和Maven的繼承與發(fā)展:
Gradle是基于Apache Ant和Apache Maven的概念開發(fā)的項目自動化構(gòu)建工具。它繼承了Maven的依賴管理和項目結(jié)構(gòu)約定,同時吸收了Ant的靈活性。
- 對XML配置的改進:
在早期的構(gòu)建工具如Ant和Maven中,項目配置通常使用XML文件,這使得配置變得繁瑣且難以維護。Gradle采用基于Groovy的特定領(lǐng)域語言(DSL)來聲明項目設(shè)置,拋棄了基于XML的配置,使得構(gòu)建腳本更加簡潔、易讀。
- 靈活性和可擴展性的需求:
隨著項目復(fù)雜度的增加,開發(fā)者需要一個更加靈活和可擴展的構(gòu)建工具。Gradle的設(shè)計初衷是提供一個靈活、可擴展的構(gòu)建工具,能夠適應(yīng)各種復(fù)雜的項目需求。
- 性能優(yōu)化:
Gradle引入了增量構(gòu)建和構(gòu)建緩存等特性,優(yōu)化了構(gòu)建性能,使得構(gòu)建過程更加快速。
- 多語言項目的支持:
Gradle不僅支持Java項目,還廣泛支持其他語言的項目,如Groovy、Kotlin、Scala等,這使得它在多語言項目中非常受歡迎。
- 社區(qū)的推動:
Gradle是一個開源項目,遵循Apache License 2.0協(xié)議。它的優(yōu)良特性吸引了很多開發(fā)者并形成了活躍的Gradle社區(qū),許多開源軟件開發(fā)者為Gradle的核心代碼做出了貢獻。
- 與現(xiàn)有工具的兼容性:
盡管Gradle有自己的構(gòu)建腳本格式,但它仍然與Maven和Ant等傳統(tǒng)的構(gòu)建工具兼容,可以解析Maven的pom.xml文件,并使用Maven倉庫中的依賴項。
3、Gradle 工程結(jié)構(gòu)
一個典型的Gradle工程結(jié)構(gòu)如下:
my-gradle-project/
├──.gradle
│└──<gradle執(zhí)行信息>
├──.idea
│└──<項目的配置信息,包括版本控制信息>
├──build
│├──classes
│├──resources
│└──<項目輸出路徑,包括編譯后的.class文件和資源文件>
├──src
│├──main
││├──java
││├──resources
││└──<程序源碼和資源文件>
│└──test
│├──java
│└──resources
│└──<測試源碼和資源文件>
├──build.gradle
│└──<當(dāng)前module的Gradle配置文件>
└──settings.gradle
└──<針對module的全局配置,包含所有module的配置>
主要目錄和文件的作用:
- .gradle:存放Gradle的執(zhí)行信息。
- .idea:存放項目的配置信息,包括版本控制信息等,這個文件夾是自動生成的。
- build:項目輸出路徑,包括編譯后的 .class文件( classes文件夾下),資源文件( resources文件夾下)。
- src:項目源碼,包含程序源碼和測試源碼。
- build.gradle:當(dāng)前module的Gradle配置文件,定義項目的構(gòu)建配置和依賴管理。
- settings.gradle:針對module的全局配置,它的作用域所包含的所有module是通過 settings.gradle來配置。
4、Gradle 對比maven 的優(yōu)勢
- 構(gòu)建速度:
Gradle在純凈構(gòu)建時比Maven快2-10倍,在增量構(gòu)建時快約7-85倍。當(dāng)Gradle任務(wù)輸出被緩存時,速度提升可達13倍。
在所有場景下,Gradle至少比Maven快2倍。子項目越多,Gradle的速度優(yōu)勢越明顯。
- 靈活性和配置:
Gradle使用基于Groovy或Kotlin的DSL編寫的 build.gradle文件,相較于Maven的XML配置文件,Gradle的配置更加簡潔、直觀。
Gradle的靈活性允許高度定制化的構(gòu)建腳本,適合構(gòu)建復(fù)雜度較高的項目。
- 依賴管理:
Gradle的依賴管理在處理復(fù)雜的依賴場景時更加靈活,能更好地處理傳遞依賴的版本沖突問題。
- 插件生態(tài):
Gradle的插件生態(tài)在逐漸完善,提供了許多針對不同場景的插件,尤其是在移動開發(fā)領(lǐng)域。
- 構(gòu)建緩存:
Gradle支持構(gòu)建緩存,這在分支之間切換時非常有用,因為先前構(gòu)建的輸出被保留并且不必重新創(chuàng)建,顯著提升了性能。
- 增量構(gòu)建:
Gradle實現(xiàn)了增量構(gòu)建機制,僅重新構(gòu)建被更改的部分,而Maven則需要重新編譯整個項目。
- 守護進程機制:
Gradle通過守護進程機制避免了每次構(gòu)建都初始化需要的組件和服務(wù),同時緩存項目結(jié)構(gòu)、文件、任務(wù)和其他信息,從而提升運行速度。
- 易于擴展:
Gradle可以方便地編寫自定義任務(wù)和插件,提供了豐富的API和插件機制。
- 集成與兼容性:
Gradle與許多現(xiàn)代IDE(如IntelliJ IDEA、Android Studio等)緊密集成,提供了良好的開發(fā)體驗,并且支持與其他構(gòu)建工具(如Ant、Maven等)的集成。
這些優(yōu)勢使得Gradle在處理大型項目、需要高度定制化構(gòu)建邏輯、以及追求構(gòu)建速度和效率的場景中,成為比Maven更受歡迎的選擇。
5、Gradle的內(nèi)部結(jié)構(gòu)
圖片
Gradle架構(gòu)組件解釋:
- 核心自動化平臺:
core-runtime模塊:提供運行時環(huán)境,包括Gradle客戶端、守護進程和工作進程。
core-configuration模塊:允許構(gòu)建結(jié)構(gòu)和工作(如任務(wù))的指定,包括項目模型和DSL。
core-execution模塊:高效執(zhí)行工作,包括調(diào)度、執(zhí)行、緩存等。
- 軟件開發(fā)平臺:
建立在核心自動化平臺之上,為軟件開發(fā)自動化提供支持,包括編譯、測試、文檔化軟件以及通過發(fā)布和依賴管理共享軟件。
- JVM平臺:
建立在核心和軟件平臺之上,為JVM上運行的軟件開發(fā)提供支持,包括Java、Kotlin或其他JVM語言實現(xiàn)的軟件。
- 擴展性平臺:
建立在核心、軟件和JVM平臺之上,為擴展Gradle提供支持,包括實現(xiàn)和應(yīng)用插件。
- 本地平臺:
建立在核心和軟件平臺之上,為原生軟件開發(fā)提供支持。
- 企業(yè)模塊:
提供企業(yè)級的功能和模塊。
6、Gradle框架設(shè)計
圖片
Gradle架構(gòu)組件解釋:
- 構(gòu)建系統(tǒng):Gradle的整體構(gòu)建系統(tǒng)。
- 核心自動化:Gradle的核心功能,包括構(gòu)建配置、依賴管理、插件應(yīng)用和任務(wù)執(zhí)行。
- 構(gòu)建配置:負(fù)責(zé)項目的構(gòu)建配置。
- 依賴管理:處理項目的依賴關(guān)系。
- 插件應(yīng)用:允許通過插件擴展Gradle的功能。
- 任務(wù)執(zhí)行:執(zhí)行定義好的構(gòu)建任務(wù)。
- 多項目管理:支持多模塊和多項目的構(gòu)建。
- 子項目構(gòu)建:能夠獨立構(gòu)建每個子項目。
- 構(gòu)建緩存:通過構(gòu)建緩存提高構(gòu)建速度。
- 并行執(zhí)行:支持任務(wù)的并行執(zhí)行,進一步提升構(gòu)建速度。
- 與Maven兼容:能夠?qū)隡aven項目,保持與Maven的兼容性。
7、Gradle執(zhí)行流程圖
圖片
Gradle執(zhí)行流程解釋:
- 初始化階段(Initialization) :
在這個階段,Gradle執(zhí)行 settings.gradle文件,確定參與構(gòu)建的項目集,并為每個項目創(chuàng)建一個 Project實例。
- 配置階段(Configuration) :
這個階段,Gradle加載并評估所有項目的 build.gradle文件,配置 Project對象,并生成任務(wù)圖。
- 執(zhí)行階段(Execution) :
在執(zhí)行階段,Gradle根據(jù)任務(wù)依賴關(guān)系執(zhí)行選定的任務(wù)。
詳細(xì)流程:
- A[開始構(gòu)建] :觸發(fā)Gradle構(gòu)建的開始。
- B[初始化階段] :包括執(zhí)行 settings.gradle腳本和創(chuàng)建項目層次結(jié)構(gòu)。
B1(settings.gradle) : settings.gradle文件執(zhí)行,確定構(gòu)建的項目。
B2[項目層次結(jié)構(gòu)] :為每個項目創(chuàng)建 Project實例。
- C[配置階段] :包括加載 build.gradle文件和任務(wù)圖的生成。
C1(build.gradle) : build.gradle文件執(zhí)行,配置項目。
C2[依賴關(guān)系解析] :解析任務(wù)依賴關(guān)系。
- D[執(zhí)行階段] :根據(jù)依賴關(guān)系執(zhí)行任務(wù)。
D1[任務(wù)執(zhí)行] :按依賴順序執(zhí)行任務(wù)。
D2[任務(wù)完成] :所有任務(wù)執(zhí)行完畢。
- E[構(gòu)建完成] :構(gòu)建過程結(jié)束。
這個流程圖簡潔地展示了Gradle構(gòu)建的三個階段及其關(guān)鍵活動,幫助理解Gradle如何管理和執(zhí)行構(gòu)建任務(wù)。
8、settingns.gradle 相關(guān)組件和模塊
圖片
settings.gradle 配置相關(guān)組件和模塊解釋:
- settings.gradle:Gradle多項目構(gòu)建的配置文件。
子項目 Include:使用 include方法包含子項目,定義項目結(jié)構(gòu)。
根項目屬性 Root Project:設(shè)置根項目的屬性,如 rootProject.name。
子項目屬性 Subprojects:對所有子項目應(yīng)用通用配置,如版本控制和插件應(yīng)用。
遠程倉庫 Repositories:配置項目依賴和插件的遠程倉庫,如 mavenCentral()。
版本管理 Version Management:管理項目依賴的版本,使用版本目錄。
Gradle屬性 Gradle Properties:設(shè)置Gradle屬性,如 org.gradle.parallel。
構(gòu)建源代碼 buildSrc:配置 buildSrc目錄,用于存放共享的構(gòu)建邏輯和插件。
組合構(gòu)建 Composite Builds:如果使用組合構(gòu)建,在此配置,允許將多個獨立構(gòu)建組合成一個邏輯構(gòu)建。
對 settings.gradle配置中涉及的相關(guān)組件和模塊的詳細(xì)說明,以及它們在Gradle構(gòu)建中的作用:
8.1. 子項目 Include
說明:在 settings.gradle文件中, include語句用于包含子項目,這些子項目成為根項目的一部分,構(gòu)成多項目構(gòu)建的骨架。 作用:允許您在一個統(tǒng)一的構(gòu)建中管理多個項目,使得項目結(jié)構(gòu)更加清晰,便于維護。
include'api','web','shared'
8.2. 根項目屬性 Root Project
說明:在 settings.gradle中,您可以為根項目設(shè)置名稱和其他屬性,這些屬性在整個構(gòu)建中是唯一的。 作用:定義根項目的基本信息,如項目名稱,這對于構(gòu)建的組織結(jié)構(gòu)至關(guān)重要。
rootProject.name='my-root-project'
8.3. 子項目屬性 Subprojects
說明: subprojects塊允許您對所有子項目應(yīng)用通用配置,如插件應(yīng)用、版本控制和源兼容性設(shè)置。 作用:提供了一種方便的方式來為所有子項目配置通用的構(gòu)建邏輯,確保構(gòu)建的一致性。
subprojects{
apply plugin:'java'
version='1.0-SNAPSHOT'
sourceCompatibility=1.8
}
8.4. 遠程倉庫 Repositories
說明:在 settings.gradle中配置遠程倉庫,這些倉庫用于依賴管理和插件下載。 作用:確保所有項目都能從指定的倉庫中檢索依賴和插件,這對于構(gòu)建的可重復(fù)性和一致性至關(guān)重要。
repositories{
mavenCentral()
jcenter()
maven{url'https://repo.example.com/maven-releases'}
}
8.5. 版本管理 Version Management
說明:使用版本目錄(Version Catalogs)來管理項目依賴的版本,這有助于保持依賴版本的一致性。 作用:簡化版本號的管理,使得更新和維護依賴版本變得更加容易。
dependencyResolutionManagement{
versionCatalogs{
libraries{
version('paging','3.1.1')
version('glide','4.14.2')
}
}
}
8.6. Gradle屬性 Gradle Properties
說明:在 settings.gradle中設(shè)置Gradle屬性,這些屬性可以影響Gradle的構(gòu)建行為。 作用:提供了一種方式來控制Gradle的特定行為,如并行執(zhí)行任務(wù)。
gradle.properties['org.gradle.parallel']='true'
8.7. 構(gòu)建源代碼 buildSrc
說明: buildSrc目錄用于存放共享的構(gòu)建邏輯,如自定義Gradle插件和任務(wù)。 作用:允許在多個項目之間共享構(gòu)建邏輯,減少代碼重復(fù),提高構(gòu)建的可維護性。
// buildSrc目錄下的構(gòu)建邏輯
8.8. 組合構(gòu)建 Composite Builds
說明:組合構(gòu)建允許將多個獨立的構(gòu)建組合成一個邏輯構(gòu)建,這在需要重用構(gòu)建邏輯或共享配置時非常有用。 作用:提供了一種靈活的方式來組織和管理大型項目,使得項目結(jié)構(gòu)更加清晰,便于維護。
includeBuild'path/to/other/build'
8.9、詳細(xì)的 settings.gradle配置示例
// settings.gradle
// 定義根項目的名稱
rootProject.name='my-multi-project'
// 包含子項目,這些子項目將作為根項目的子模塊
include(
'projectA',// 第一個子項目
'projectB',// 第二個子項目
'commonLib'// 一個共享庫項目
)
// 定義項目間依賴時使用的版本
dependencyResolutionManagement{
versionCatalogs{
libraries{
lib'org.springframework.boot:spring-boot-starter-web','2.5.2'
lib'com.fasterxml.jackson.core:jackson-databind','2.12.3'
}
}
}
// 配置遠程倉庫,所有子項目將從這些倉庫中檢索依賴和插件
repositories{
// 配置 Maven Central 倉庫
mavenCentral()
// 配置 JCenter 倉庫
jcenter()
// 配置一個自定義的遠程 Maven 倉庫
maven{url'https://repo.example.com/maven-releases'}
}
// 配置插件倉庫,用于檢索 Gradle 插件
pluginManagement{
repositories{
gradlePluginPortal()// 配置 Gradle 插件門戶
mavenCentral()
}
}
// 配置構(gòu)建源代碼目錄 buildSrc,用于存放共享的構(gòu)建邏輯和插件
buildSrc{
// 定義 buildSrc 目錄中的依賴
dependencies{
classpath'org.gradle:gradle-tooling-api:5.6.4'
classpath'com.google.gradle:osdetector-gradle-plugin:1.6.2'
}
}
// 如果使用組合構(gòu)建,包含其他獨立的構(gòu)建
compositeBuild{
// 包含一個本地的組合構(gòu)建
includeBuild'../other-build'
// 包含一個遠程的組合構(gòu)建
includeBuild'https://github.com/username/other-build.git'
}
// 在 settings.gradle 中也可以配置一些 Gradle 屬性
gradle{
// 設(shè)置 Gradle 是否并行執(zhí)行任務(wù)
parallel=true
// 設(shè)置 Gradle 用戶的主目錄
gradleUserHome=file('/path/to/gradle/user/home')
}
// 日志配置,用于控制構(gòu)建過程中的日志輸出
logging{
console=ConsoleLogger.Level.INFO// 設(shè)置控制臺日志級別為 INFO
debug=false// 設(shè)置是否輸出調(diào)試日志
}
9、build.gradle相關(guān)組件或模塊關(guān)系畫
圖片
build.gradle 文件是 Gradle 構(gòu)建系統(tǒng)的核心,它用于定義項目的構(gòu)建邏輯和配置。每個 Gradle 項目都有一個或多個 build.gradle 文件,它們描述了如何構(gòu)建項目。以下是 build.gradle 文件的一些主要作用和功能:
- 插件應(yīng)用:
build.gradle 文件中可以使用 apply plugin 語句來應(yīng)用插件,這些插件可以提供額外的構(gòu)建功能和任務(wù)。
- 依賴配置:
在 build.gradle 文件中,你可以定義項目所需的依賴項,這些依賴可以是庫、框架或其他模塊。
- 任務(wù)定義:
可以定義自定義的構(gòu)建任務(wù)(tasks),這些任務(wù)可以執(zhí)行編譯、測試、打包、部署等操作。
- 構(gòu)建邏輯:
描述項目的構(gòu)建邏輯,包括任務(wù)之間的依賴關(guān)系和執(zhí)行順序。
- 源代碼和資源配置:
- 配置源代碼目錄和資源文件,指定哪些文件應(yīng)該被包含在構(gòu)建中。
- 構(gòu)建版本管理:
定義項目的版本號,以及如何根據(jù)版本號生成輸出的構(gòu)建文件。
- 編譯選項:
設(shè)置編譯選項,如源代碼兼容性、優(yōu)化級別、編碼等。
- 測試配置:
配置測試框架和測試選項,如測試任務(wù)、測試報告的生成等。
- 打包和發(fā)布:
定義打包(如 JAR、WAR)和發(fā)布配置,包括歸檔內(nèi)容和發(fā)布到倉庫的設(shè)置。
- 多項目構(gòu)建:
在多項目構(gòu)建中, build.gradle 文件可以定義項目層次結(jié)構(gòu)和子項目之間的依賴關(guān)系。
- 自定義構(gòu)建行為:
通過 Groovy 或 Kotlin 腳本,可以編寫自定義的構(gòu)建邏輯和插件。
- 環(huán)境配置:
根據(jù)不同的環(huán)境(開發(fā)、測試、生產(chǎn))配置不同的構(gòu)建選項。
- 報告和文檔生成:
配置生成代碼覆蓋率報告、JavaDoc、用戶文檔等。
- 質(zhì)量控制:
集成代碼質(zhì)量檢查工具,如 Checkstyle、PMD、FindBugs 等。
build.gradle 文件是 Gradle 構(gòu)建的腳本文件,它使用 Groovy 語言(或 Kotlin DSL)編寫,提供了極大的靈活性和強大的功能,使得構(gòu)建過程可以根據(jù)項目的特定需求進行定制。
9.1 插件應(yīng)用
Gradle插件設(shè)計架構(gòu)
Gradle插件的設(shè)計架構(gòu)可以分為以下幾個關(guān)鍵層次:
- 底層Gradle框架:
提供基礎(chǔ)服務(wù),如任務(wù)依賴、有向無環(huán)圖的構(gòu)建等。
- Google編譯工具團隊的Android Gradle plugin框架:
在Gradle框架的基礎(chǔ)上,創(chuàng)建與Android項目打包相關(guān)的任務(wù)和artifacts。
- 開發(fā)者自定義Plugin:
在Android Gradle plugin提供的任務(wù)基礎(chǔ)上插入自定義任務(wù)或增加Transform進行編譯時代碼注入。
Gradle插件的構(gòu)建過程
Gradle插件的構(gòu)建過程主要包括以下幾個步驟:
- 插件源代碼編譯:
將插件的源代碼編譯成字節(jié)碼。
- 插件JAR包打包:
將插件的字節(jié)碼和資源文件打包成一個JAR包。
- 插件元數(shù)據(jù)生成:
生成插件的元數(shù)據(jù),包括插件的名稱、版本、作者等信息。
- 插件發(fā)布:
將插件發(fā)布到插件倉庫中,供其他用戶下載和使用。
Gradle插件的執(zhí)行過程
當(dāng)Gradle執(zhí)行項目時,它會加載項目中所依賴的所有插件,并按照插件的依賴關(guān)系順序加載。插件加載完成后,Gradle執(zhí)行插件的 apply方法,該方法是插件的入口方法,負(fù)責(zé)將插件功能應(yīng)用到項目中。在 apply方法中,插件可以添加任務(wù)、擴展項目配置、注冊構(gòu)建監(jiān)聽器等。
Gradle插件架構(gòu)圖
圖片
Gradle插件設(shè)計架構(gòu)圖說明:
- Gradle框架:
作用:提供構(gòu)建系統(tǒng)的基礎(chǔ)架構(gòu)和API,包括任務(wù)調(diào)度和依賴管理。
- 任務(wù)依賴管理:
作用:管理任務(wù)之間的依賴關(guān)系,確保任務(wù)按照正確的順序執(zhí)行。
- 構(gòu)建執(zhí)行:
作用:執(zhí)行構(gòu)建任務(wù),如編譯、測試和打包。
- Android Gradle Plugin:
作用:在Gradle框架的基礎(chǔ)上,為Android項目提供特定的構(gòu)建任務(wù)和artifacts。
- 自定義Plugin:
作用:開發(fā)者根據(jù)項目需求自定義的插件,可以擴展Android Gradle plugin的功能或插入自定義任務(wù)。
9.2 插件應(yīng)用案例
Gradle 插件是一組預(yù)定義的任務(wù)和配置,可以擴展構(gòu)建的功能。通過應(yīng)用插件,可以無需編寫復(fù)雜的任務(wù)代碼就能實現(xiàn)標(biāo)準(zhǔn)的功能。
plugins{
id'java'
id'com.android.application'version'7.0.0'
}