Gradle是一個(gè)開源的構(gòu)建自動(dòng)化工具,專注于靈活性和性能。Gradle構(gòu)建腳本使用Groovy或Kotlin DSL 編寫。
- 高度可定制 - Gradle以一種可以以最基本的方式定制和擴(kuò)展的方式建模。
- 快速 - Gradle通過重用先前執(zhí)行的輸出,僅處理已更改的輸入以及并行執(zhí)行任務(wù)來快速完成任務(wù)。
- 功能強(qiáng)大 - Gradle是Android的官方構(gòu)建工具,并支持許多流行的語言和技術(shù)。
安裝Gradle
您可以在Linux,macOS或Windows上安裝Gradle構(gòu)建工具。
先決條件
Gradle在所有主要操作系統(tǒng)上運(yùn)行,只需運(yùn)行Java Development Kit 8或更高版本。檢查,運(yùn)行java -version。你應(yīng)該看到這樣的東西:
$ java-version
java version "1.8.0_191"
Java(TM) SE Runtime Environment (build 1.8.0_191-b12)
Java HotSpot(TM) 64-Bit Server VM (build 25.191-b12, mixed mode)
Gradle附帶了自己的Groovy庫,因此不需要安裝Groovy。Gradle忽略任何現(xiàn)有的Groovy安裝。
Gradle使用它在路徑中找到的任何JDK?;蛘?,您可以將JAVA_HOME環(huán)境變量設(shè)置為指向所需JDK的安裝目錄。
使用包管理器進(jìn)行安裝
Homebrew
$ brew install gradle
手動(dòng)安裝
1. 下載最新的Gradle版本
2.解壓zip包
將分發(fā)zip文件解壓縮到您選擇的目錄中,例如:
$ mkdir /opt/gradle
$ unzip -d /opt/gradle gradle-5.5.1-bin.zip
$ ls /opt/gradle/gradle-5.5.1
LICENSE NOTICE bin getting-started.html init.d lib media
3.配置系統(tǒng)環(huán)境
要運(yùn)行Gradle,首先添加環(huán)境變量GRADLE_HOME。這應(yīng)該指向Gradle網(wǎng)站上的解壓縮文件。接下來添加*GRADLE_HOME*/bin到您的PATH環(huán)境變量。通常,這足以運(yùn)行Gradle。
配置PATH環(huán)境變量以包含bin解壓縮分發(fā)的目錄,例如:
$ export PATH=$PATH:/opt/gradle/gradle-5.5.1/bin
4.驗(yàn)證安裝
打開控制臺并運(yùn)行gradle -v以運(yùn)行g(shù)radle并顯示版本,例如:
$ gradle -v
------------------------------------------------------------
Gradle 5.5.1
------------------------------------------------------------
(environment specific information)
創(chuàng)建新的Gradle項(xiàng)目
1.初始化一個(gè)項(xiàng)目
首先,讓我們?yōu)樾马?xiàng)目創(chuàng)建一個(gè)新的目錄。
? mkdir basic-demo
? cd basic-demo
現(xiàn)在我們可以使用Gradle的 gradle init 命令來生成一個(gè)簡單的項(xiàng)目。然后查看生成的所有內(nèi)容,以便知道發(fā)生了什么。
? gradle init
Starting a Gradle Daemon (subsequent builds will be faster)
BUILD SUCCESSFUL in 3s
2 actionable tasks: 2 executed
如果你想使用 Kotlin DSL 腳本,可以使用
gradle init --dsl kotlin命令。更多信息可以閱讀 詳細(xì)文檔.
這就是Gradle為您生成的內(nèi)容。
Groovy
.
├── build.gradle
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
└── settings.gradle
Kotlin
.
├── build.gradle.kts
├── gradle
│ └── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
└── settings.gradle.kts
build.gradle 用于配置當(dāng)前項(xiàng)目的Gradle構(gòu)建腳本
gradle-wrapper.jar Gradle Wrapper可執(zhí)行JAR
gradle-wrapper.properties Gradle Wrapper配置屬性
gradlew 基于Unix的系統(tǒng)的Gradle Wrapper腳本
gradlew.bat 適用于Windows的Gradle Wrapper腳本
settings.gradle 用于配置Gradle構(gòu)建的Gradle設(shè)置腳本
2.創(chuàng)建一個(gè)任務(wù)
Gradle提供了用于通過基于Groovy或Kotlin的DSL腳本創(chuàng)建和配置任務(wù)的API。 Project (項(xiàng)目)包括一組任務(wù),每個(gè)任務(wù)執(zhí)行一些基本操作。
Gradle提供了一個(gè)任務(wù)庫,您可以在自己的項(xiàng)目中配置它。例如,有一個(gè)名為Copy的核心任務(wù)類型,它將文件從一個(gè)位置復(fù)制到另一個(gè)位置。復(fù)制任務(wù)非常有用(參閱文檔了解詳細(xì)信息),但是在這里,讓我們再次保持簡單。執(zhí)行以下步驟:
- 創(chuàng)建一個(gè)名為
src的目錄。 - 在
src目錄中添加一個(gè)名為myfile.txt的文件。內(nèi)容可以是任意的(甚至可以是空的),但是為了方便起見,可以添加一行Hello, World!。 - 在你的
build.gradle文件中定義一個(gè)類型為Copy(注意首字母大寫)名稱為copy的任務(wù)來復(fù)制src目錄到一個(gè)名為dest的目錄(你不必去手動(dòng)創(chuàng)建dest目錄,因?yàn)槿蝿?wù)會為你去創(chuàng)建)。
build.gradle width Groovy
task copy(type: Copy, group: "Custom", description: "Copies sources to the dest directory") {
from "src"
into "dest"
}
build.gradle.kts width Kotlin
tasks.create<Copy>("copy") {
description = "Copies sources to the dest directory"
group = "Custom"
from("src")
into("dest")
}
在這里,group 和 description 您可以隨便寫,甚至可以忽略它們
現(xiàn)在來執(zhí)行您新建 copy 任務(wù):
$./gradlew copy
> Task :copy
BUILD SUCCESSFUL in 0s
1 actionable task: 1 executed
們可以檢查一下 dest 目錄中是否存在名為 myfile.txt 的文件并且它的內(nèi)容和 src 目錄中的文件一樣,來驗(yàn)證 copy 任務(wù)是否成功執(zhí)行。
探索和調(diào)試項(xiàng)目
發(fā)現(xiàn)可用的任務(wù)
tasks 命令可以列出了可用的Gradle任務(wù),包括您剛剛添加的自定義任務(wù)。
$ ./gradlew tasks
> Task :tasks
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------
Build Setup tasks
-----------------
init - Initializes a new Gradle build.
wrapper - Generates Gradle wrapper files.
Custom tasks
------------
copy - Copies sources to the dest directory
Help tasks
----------
buildEnvironment - Displays all buildscript dependencies declared in root project 'basic-demo'.
components - Displays the components produced by root project 'basic-demo'. [incubating]
dependencies - Displays all dependencies declared in root project 'basic-demo'.
dependencyInsight - Displays the insight into a specific dependency in root project 'basic-demo'.
dependentComponents - Displays the dependent components of components in root project 'basic-demo'. [incubating]
help - Displays a help message.
model - Displays the configuration model of root project 'basic-demo'. [incubating]
projects - Displays the sub-projects of root project 'basic-demo'.
properties - Displays the properties of root project 'basic-demo'.
tasks - Displays the tasks runnable from root project 'basic-demo'.
To see all tasks and more detail, run gradlew tasks --all
To see more detail about a task, run gradlew help --task <task>
BUILD SUCCESSFUL in 0s
1 actionable task: 1 executed
分析和調(diào)試項(xiàng)目
Gradle還提供了一個(gè)豐富的、基于web的構(gòu)建視圖,叫做 build scan(構(gòu)建掃描)。
嘗試在執(zhí)行任務(wù)時(shí)添加 --scan 來創(chuàng)建構(gòu)建掃描。
$ ./gradlew copy --scan
BUILD SUCCESSFUL in 0s
Publishing a build scan to scans.gradle.com requires accepting the Gradle Terms of Service defined at https://gradle.com/terms-of-service. Do you accept these terms? [yes, no]
yes
Gradle Terms of Service accepted.
Publishing build scan...
https://gradle.com/s/tetv3tbxy3wr4
如果您瀏覽您的 build scan ,您應(yīng)該能夠很容易地找到在哪里執(zhí)行的任務(wù),它們花費(fèi)了多少時(shí)間,應(yīng)用了哪些插件,等等。
發(fā)現(xiàn)可用的屬性
properties 命令告訴您項(xiàng)目的屬性。
$ ./gradlew properties
> Task :properties
------------------------------------------------------------
Root project
------------------------------------------------------------
allprojects: [root project 'basic-demo']
ant: org.gradle.api.internal.project.DefaultAntBuilder@33ad4252
antBuilderFactory: org.gradle.api.internal.project.DefaultAntBuilderFactory@609be032
artifacts: org.gradle.api.internal.artifacts.dsl.DefaultArtifactHandler_Decorated@1b9242eb
asDynamicObject: DynamicObject for root project 'basic-demo'
baseClassLoaderScope: org.gradle.api.internal.initialization.DefaultClassLoaderScope@35dd98fd
buildDir: /Users/huangyoubin/Desktop/basic-demo/build
buildFile: /Users/huangyoubin/Desktop/basic-demo/build.gradle
buildPath: :
buildScriptSource: org.gradle.groovy.scripts.TextResourceScriptSource@6cbbe3c6
buildscript: org.gradle.api.internal.initialization.DefaultScriptHandler@539e0413
childProjects: {}
...
配置構(gòu)建環(huán)境
Gradle提供了多種機(jī)制來配置Gradle本身和特定項(xiàng)目的行為
配置Gradle行為時(shí),您可以使用這些方法,按從最高優(yōu)先級到最低優(yōu)先級的順序列出(前一個(gè)獲勝):
-
Command-line flags例如--build-cache. 它們優(yōu)先于System properties和環(huán)境變量。 -
System properties例如systemProp.http.proxyHost=somehost.org存儲在gradle.properties文件中。 -
Gradle屬性例如org.gradle.caching=true通常存儲在項(xiàng)目根目錄的gradle.properties中 -
環(huán)境變量例如GRADLE_OPTS由執(zhí)行Gradle的環(huán)境提供的
Gradle屬性
Gradle提供了幾個(gè)選項(xiàng),可以輕松配置將用于執(zhí)行構(gòu)建的Java進(jìn)程。
為構(gòu)建設(shè)置一致的環(huán)境需要將這些設(shè)置放入gradle.properties文件。配置按以下順序應(yīng)用(如果在多個(gè)位置配置選項(xiàng),則最后一個(gè)獲勝):
-
gradle.properties在Gradle安裝目錄中。 -
gradle.properties在項(xiàng)目根目錄中。 -
gradle.properties在GRADLE_USER_HOME目錄中。 - 系統(tǒng)屬性,例如在
-Dgradle.user.home命令行上設(shè)置的時(shí)間。
以下屬性可用于配置Gradle構(gòu)建環(huán)境:
-
org.gradle.caching=(true,false)設(shè)置為true時(shí),Gradle將盡可能重用任何先前構(gòu)建的任務(wù)輸出,從而使構(gòu)建速度更快。
-
org.gradle.caching.debug=(true,false)設(shè)置為true時(shí),將在控制臺上記錄各個(gè)輸入屬性哈希值以及每個(gè)任務(wù)的構(gòu)建緩存鍵。
-
org.gradle.configureondemand=(true,false) -
org.gradle.console=(auto,plain,rich,verbose)自定義控制臺輸出著色或詳細(xì)程度。默認(rèn)值取決于Gradle的調(diào)用方式。
-
org.gradle.daemon=(true,false)當(dāng)設(shè)置
true將使用Gradele守護(hù)進(jìn)程來運(yùn)行構(gòu)建。默認(rèn)是true。 -
org.gradle.daemon.idletimeout=(# of idle millis)Gradle守護(hù)程序?qū)⒃谥付ǖ目臻e毫秒數(shù)后自行終止。默認(rèn)為
10800000(3小時(shí))。 -
org.gradle.debug=(true,false)設(shè)置
true為時(shí),Gradle運(yùn)行構(gòu)建將啟用遠(yuǎn)程調(diào)試,偵聽端口5005.請注意,這相當(dāng)于添加-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005到JVM命令行,并將掛起虛擬機(jī),直到連接調(diào)試器。默認(rèn)是false。 -
org.gradle.java.home=(path to JDK home)指定Gradle構(gòu)建過程的Java主目錄??梢詫⒅翟O(shè)置為
jdk或jre的Path,但是,根據(jù)構(gòu)建的功能,使用JDK會更安全。如果未指定設(shè)置,則會從您的環(huán)境(JAVA_HOME或路徑java)派生合理的默認(rèn)值。 -
org.gradle.jvmargs=(JVM arguments)指定用于Gradle守護(hù)程序的JVM參數(shù)
-
org.gradle.logging.level=(quiet,warn,lifecycle,info,debug)當(dāng)設(shè)置為quiet,warn,lifecycle,info或debug時(shí),Gradle將使用此日志級別。值不區(qū)分大小寫。
lifecycle級別是缺省值。 -
org.gradle.parallel=(true,false)開啟并行編譯
-
org.gradle.warning.mode=(all,none,summary)設(shè)置為
all,summary或者none,Gradle將使用不同的警告類型顯示。 -
org.gradle.workers.max=(max # of worker processes)配置后,Gradle最大將使用給定數(shù)量的工作者。默認(rèn)值是CPU處理器數(shù)。
-
org.gradle.priority=(low,normal)指定Gradle守護(hù)程序的調(diào)度優(yōu)先級以及它啟動(dòng)的所有進(jìn)程。默認(rèn)是
normal
配置JVM內(nèi)存
可以通過以下方式調(diào)整Gradle的JVM選項(xiàng):
org.gradle.jvmargs屬性控制虛擬機(jī)上運(yùn)行的配置。它默認(rèn)為-Xmx512m "-XX:MaxMetaspaceSize=256m"
更改構(gòu)建VM的JVM設(shè)置
org.gradle.jvmargs = -Xmx2g -XX:MaxMetaspaceSize = 512m -XX:+ HeapDumpOnOutOfMemoryError -Dfile.encoding = UTF-8
Gradle Daemon
Gradle在Java虛擬機(jī)(JVM)上運(yùn)行,并使用幾個(gè)需要初始化時(shí)間很長的支持庫。因此,有時(shí)開始時(shí)看起來有點(diǎn)慢。這個(gè)問題的解決方案是Gradle 守護(hù)程序:一個(gè)長期存在的后臺進(jìn)程,它比其他情況下更快地執(zhí)行構(gòu)建。我們通過在內(nèi)存中保存有關(guān)項(xiàng)目的數(shù)據(jù)以及利用緩存來避免昂貴的初始化過程。使用守護(hù)程序運(yùn)行Gradle構(gòu)建與沒有守護(hù)程序沒有區(qū)別。只需配置您是否要使用它 - 其他一切都由Gradle透明處理。
為什么Gradle Daemon對性能很重要
守護(hù)進(jìn)程是一個(gè)長期存在的進(jìn)程,因此我們不僅能夠避免每次構(gòu)建的JVM啟動(dòng)成本,而且還能夠在內(nèi)存中緩存有關(guān)項(xiàng)目結(jié)構(gòu),文件,任務(wù)等的信息。
原因很簡單:通過重用以前版本的計(jì)算來提高構(gòu)建速度。但是,好處是顯著的:我們通常會在后續(xù)構(gòu)建中測量構(gòu)建時(shí)間減少15-75%。我們建議您使用--profile了解Gradle Daemon對您可能產(chǎn)生的影響來分析您的構(gòu)建。
默認(rèn)情況下,Gradle守護(hù)程序從Gradle 3.0開始啟用,因此您無需執(zhí)行任何操作即可從中受益。
守護(hù)程序狀態(tài)
獲取正在運(yùn)行的Gradle守護(hù)程序及其狀態(tài)的列表,請使用--status命令
$ gradle --status
PID STATUS INFO
28278 IDLE 5.5.1
Only Daemons for the current Gradle version are displayed.
目前,Gradle只能連接到同一版本的守護(hù)進(jìn)程。這意味著狀態(tài)輸出將僅顯示被調(diào)用的Gradle版本的守護(hù)進(jìn)程,而不顯示任何其他版本。
禁用守護(hù)程序
默認(rèn)情況下啟用Gradle守護(hù)程序,我們建議始終啟用它。有幾種方法可以禁用守護(hù)程序,但最常見的方法是添加該行
org.gradle.daemon=false
到文件?USER_HOME?/.gradle/gradle.properties
停止現(xiàn)有守護(hù)進(jìn)程
守護(hù)進(jìn)程是一個(gè)后臺進(jìn)程。每個(gè)守護(hù)進(jìn)程監(jiān)視其內(nèi)存使用情況與總系統(tǒng)內(nèi)存的比較,并在可用系統(tǒng)內(nèi)存不足時(shí)空閑時(shí)自動(dòng)停止。如果您想出于任何原因顯式停止運(yùn)行Daemon進(jìn)程,只需使用該命令即可gradle --stop。