2. 程式人生 > >Gradle基礎：9:wrapper的使用

Gradle基礎：9:wrapper的使用

阿新 • • 發佈：2018-11-25

Gradle Wrapper是gradle建議的使用方式，這篇文章將會結合具體的例子來說明一下如何使用。

Gradle Wrapper

Gradle Wrapper實際上就是一個指令碼，使用它可以下載和使用指定版本的gradle，根據需要進行在使用之前進行下載，有效避免本地機器的設定等環境一致性問題。
雖然gradle的安裝已經非常簡單，但是使用gradle wrapper是的開發這能夠以一種更為標準化的方式建立gradle專案。

使用方式

Gradle Wrapper的使用方式主要是按照如下步驟：

  • Step 1: 下載gradle
  • Step 2: 將下載的gradle解壓並存儲至GRADLE_USER_HOME所指定的目錄
  • Step 3: 使用解壓的gradle
    在這裡插入圖片描述

事前準備

使用下面的程式碼示例，內容不再說明，具體說明資訊請參看：

liumiaocn:wrapper liumiao$ ls
build.gradle
liumiaocn:wrapper liumiao$ cat build.gradle 
println "[phase:configuration] build.gradle ..."

task compile {
  group 'compile'
  description 'compile task'
  println "[phase:configuration] compile"
  doFirst {
    println "[phase:execution] compile :doFirst()"
  }
}

tasks.create(name: 'test',dependsOn: compile) {
  group 'test'
  description 'test task'
  println "[phase:configuration] test"
  doLast {
    println "[phase:execution] test:doLast()"
  }
}

tasks.create("packaging") {
  group 'packaging'
  description 'packaging task'
  dependsOn test
  enabled   true
  println "[phase:configuration] packaging"
  doLast {
    println "[phase:execution] packaging:doLast()"
  }
}

class Install extends DefaultTask{
  String installObjectName

  @TaskAction
  void checkObject() {
    println "[phase:execution] install:checkObject   (${installObjectName})"
  }

  @TaskAction
  void installObject() {
    println "[phase:execution] install:installObject (${installObjectName})"
  }
}

task install(type: Install) {
  group 'install'
  description 'install task'
  installObjectName 'test.jar'

  println "[phase:configuration] install"
  doFirst {
    println "[phase:execution] install:doFirst()"
  }
  doLast {
    println "[phase:execution] install:doLast()"
  }
}
install.dependsOn packaging
install.onlyIf { packaging.enabled }
liumiaocn:wrapper liumiao$

gradle wrapper

通過gradle tasks可以確認到在Build Setup tasks中有wrapper這樣一個內建的任務。

liumiaocn:wrapper liumiao$ gradle tasks
...省略
------------------------------------------------------------
All tasks runnable from root project
------------------------------------------------------------

Build Setup tasks
-----------------
init - Initializes a new Gradle build.
wrapper - Generates Gradle wrapper files.
...省略
BUILD SUCCESSFUL in 0s
1 actionable task: 1 executed
liumiaocn:wrapper liumiao$

wrapper的說明是這個任務是用來建立gradle wrapper檔案，接下里我們來看一下具體建立了那些檔案

liumiaocn:wrapper liumiao$ ls
build.gradle
liumiaocn:wrapper liumiao$ gradle wrapper

> Configure project :
[phase:configuration] build.gradle ...
[phase:configuration] compile
[phase:configuration] test
[phase:configuration] packaging
[phase:configuration] install

BUILD SUCCESSFUL in 0s
1 actionable task: 1 executed
liumiaocn:wrapper liumiao$ ls
build.gradle gradle       gradlew      gradlew.bat
liumiaocn:wrapper liumiao$ tree
.
├── build.gradle
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradlew
└── gradlew.bat

2 directories, 5 files
liumiaocn:wrapper liumiao$

檔案說明：

  • gradlew：linux或者Unix下用於執行wrapper命令的Shell指令碼
  • gradlew.bat：Windows下用於執行wrapper命令的批處理指令碼
  • gradle-wrapper.jar：用於下載Gradle的相關程式碼實現
  • gradle-wrapper.properties：wrapper所使用的配置資訊，比如gradle的版本等資訊
  • 預設狀況下的gradle-wrapper.properties的資訊如下
liumiaocn:wrapper liumiao$ cat gradle/wrapper/gradle-wrapper.properties 
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
liumiaocn:wrapper liumiao$

GRADLE_USER_HOME可以通過環境變數的方式設定，預設的GRADLE_USER_HOME為 H O M E / . g r a d l e ， 根 據 這 裡 的 信 息 可 以 看 到 ， 下 載 的 g r a d l e 將 會 解 壓 到 {HOME}/.gradle，根據這裡的資訊可以看到，下載的gradle將會解壓到 {HOME}/.gradle/wrapper/dists

使用場景

當前系統安裝的gradle的版本為4.10.2，但是在當前的project裡面希望使用5.0的gradle，這時gradle wrapper就可以一顯身手了

事前確認

當前gradle的版本為4.10.2

liumiaocn:wrapper liumiao$ gradle -v

------------------------------------------------------------
Gradle 4.10.2
------------------------------------------------------------

Build time:   2018-09-19 18:10:15 UTC
Revision:     b4d8d5d170bb4ba516e88d7fe5647e2323d791dd

Kotlin DSL:   1.0-rc-6
Kotlin:       1.2.61
Groovy:       2.4.15
Ant:          Apache Ant(TM) version 1.9.11 compiled on March 23 2018
JVM:          1.8.0_191 (Oracle Corporation 25.191-b12)
OS:           Mac OS X 10.14 x86_64

liumiaocn:wrapper liumiao$

設定wrapper使用的gradle版本

可以使用命令來修改wrapper所使用的gradle版本資訊

liumiaocn:wrapper liumiao$ gradle wrapper --gradle-version 5.0-rc-5 --distribution-type bin
Starting a Gradle Daemon (subsequent builds will be faster)

> Configure project :
[phase:configuration] build.gradle ...
[phase:configuration] compile
[phase:configuration] test
[phase:configuration] packaging
[phase:configuration] install

BUILD SUCCESSFUL in 3s
1 actionable task: 1 executed
liumiaocn:wrapper liumiao$

可以看到，實際這條命令只是修改了gradle wrapper的配置檔案的下載檔案的資訊

liumiaocn:wrapper liumiao$ cat gradle/wrapper/gradle-wrapper.properties 
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-5.0-rc-5-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
liumiaocn:wrapper liumiao$

當然設定也可以通過gradle-distribution-url選項或者直接修改配置檔案來更快實現，至於具體版本，gradle的安裝檔案包符合：
gradle-版本資訊-bin|all.zip的格式，按照這種格式即可
在這裡插入圖片描述

wrapper使用

只需要設定下載url所指定的gradle版本資訊，wrapper的準備就已經就緒，隨便使用任何一個wrapper的命令，第一次執行都會首先下載gradle並解壓到${HOME}/.gradle/wrapper/dists，在在執行之前我們可以看到目前還沒有任何內容

liumiaocn:wrapper liumiao$ ls
build.gradle gradle       gradlew      gradlew.bat
liumiaocn:wrapper liumiao$ ls ${HOME}/.gradle/wrapper/dists
ls: /Users/liumiao/.gradle/wrapper/dists: No such file or directory
liumiaocn:wrapper liumiao$

gradle wrapper之所以有被叫做wrapper，就是因為封了一層，所以gradle的基本命令在這裡都可以使用，這裡直接使用上文確認gradle版本所用的-v

liumiaocn:wrapper liumiao$ ./gradlew -v
Downloading https://services.gradle.org/distributions/gradle-5.0-rc-5-bin.zip
.................................................................................

Welcome to Gradle 5.0-rc-5!

Here are the highlights of this release:
 - Kotlin DSL 1.0
 - Task timeouts
 - Dependency alignment aka BOM support
 - Interactive `gradle init`

For more details see https://docs.gradle.org/5.0-rc-5/release-notes.html


------------------------------------------------------------
Gradle 5.0-rc-5
------------------------------------------------------------

Build time:   2018-11-22 19:58:45 UTC
Revision:     42e59c2484a49702234030881640aa8d8bfa6d43

Kotlin DSL:   1.0.4
Kotlin:       1.3.10
Groovy:       2.5.4
Ant:          Apache Ant(TM) version 1.9.13 compiled on July 10 2018
JVM:          1.8.0_191 (Oracle Corporation 25.191-b12)
OS:           Mac OS X 10.14 x86_64

liumiaocn:wrapper liumiao$

所以看到第一次執行有Downloading https://services.gradle.org/distributions/gradle-5.0-rc-5-bin.zip的動作，而具體的版本正是之前所設定的，gradle的下載和解壓對我們來說都是透明的，為什麼wrapper能找到這個5.0的版本呢

liumiaocn:wrapper liumiao$ ls ${HOME}/.gradle/wrapper/dists
gradle-5.0-rc-5-bin
liumiaocn:wrapper liumiao$

可以看到，wrapper把它下載並解壓到這裡了，當然也可以使用系統已經安裝的gradle，這種方式直接設定GRADLE_USER_HOME即可。而且下載和設定的動作只會發生一次，除非你手動再次將其刪除，現在再次使用gradlew就會清晰的多了

liumiaocn:wrapper liumiao$ ./gradlew -v

------------------------------------------------------------
Gradle 5.0-rc-5
------------------------------------------------------------

Build time:   2018-11-22 19:58:45 UTC
Revision:     42e59c2484a49702234030881640aa8d8bfa6d43

Kotlin DSL:   1.0.4
Kotlin:       1.3.10
Groovy:       2.5.4
Ant:          Apache Ant(TM) version 1.9.13 compiled on July 10 2018
JVM:          1.8.0_191 (Oracle Corporation 25.191-b12)
OS:           Mac OS X 10.14 x86_64

liumiaocn:wrapper liumiao$

接下來就可以想使用gradle一樣使用gradlew了，比如需要執行install的任務

liumiaocn:wrapper liumiao$ ./gradlew install
Starting a Gradle Daemon (subsequent builds will be faster)

> Configure project :
[phase:configuration] build.gradle ...
[phase:configuration] compile
[phase:configuration] test
[phase:configuration] packaging
[phase:configuration] install

> Task :compile
[phase:execution] compile :doFirst()

> Task :test
[phase:execution] test:doLast()

> Task :packaging
[phase:execution] packaging:doLast()

> Task :install
[phase:execution] install:doFirst()
[phase:execution] install:installObject (test.jar)
[phase:execution] install:checkObject   (test.jar)
[phase:execution] install:doLast()

BUILD SUCCESSFUL in 3s
4 actionable tasks: 4 executed
liumiaocn:wrapper liumiao$

可以看到同樣的指令碼在gradle 5中也能正常執行

總結

gradle wrapper對於較為熟悉設定使用者來說，似乎更像一個雞肋的功能，因為gradle本身的設定就非常簡單，但是對於團隊開發來說，這種事情如果能夠坐等透明化和標準化對於專案來說自然是很不錯的一個方式，也是我們在推行DevOps時對於開發環境標準化的一個小的實踐。

參考內容

https://docs.gradle.org/current/userguide/gradle_wrapper.html

相關推薦

Gradle基礎：9:wrapper的使用

Gradle Wrapper是gradle建議的使用方式，這篇文章將會結合具體的例子來說明一下如何使用。 Gradle Wrapper Gradle Wrapper實際上就是一個指令碼，使用它可以下載和使用指定版本的gradle，根據需要進行在使用之前進行下載，有效避免本地機器的

LDAP基礎：9：客戶端工具：使用Apache Directory Studio進行操作

前面的文章介紹了LDAP伺服器的搭建以及通過ldap相關的命令進行操作的方法，對於不習慣*nix或命令列操作的使用者，也無需糾結，有很多不錯的客戶端工具可以實現這個功能，這篇文章介紹一下Apache Directory Studio。 Apache Directory Studio

Gradle基礎：2:Gradle的HelloWorld

這篇文章使用最簡單的HelloWorld例子對Gradle的使用進行概要性的說明。 事前準備 事前安裝和設定好gradle liumiaocn:hello liumiao$ gradle --version --------------------------------

Gradle基礎：3:生命週期管理

Maven中的生命週期的管理使用了COC，以此為中心的pom.xml檔案成為了重中之重，優點是不同專案之間的經驗共享變得更加容易，大家大部分都是可以使用類似的套路，缺點則是靈活性稍微降低以及對於pom.xml細節的學習需要較多時間。Gradle則將這些再次放開，給更多的許可權與開發者，這

Gradle基礎：4:Task的使用方式

Task是Gradle的基礎單元，這篇文章總結和整理一下關於task的常見的使用方式。 常見的屬性和方法 在前面的例子中，我們已經使用task的description屬性進行設定gradle task中的顯示資訊，將task進行分組顯示，同時使用了doFirst和doLast方

Gradle基礎：5:task的依賴與執行條件

在使用maven的時候，compile/test/install的先後順序和依賴關係都十分清晰，而在前面的例子中，可以通過gradle compile和gradle test來進行不同的任務執行，但是實際這些任務之間是有依賴關係的，就像我們在maven裡面執行mvn install之前

Gradle基礎：6:多工程構建

Maven中通過使用module來實現多模組的組合，在Gradle中可以類似通過多project進行聚合來實現，這篇文章主要介紹一下具體的使用方式。 多工程結構 建立如下所示3層結構 每個project下均有如下四個任務： 事前準備 在前文的示例基礎上

Gradle基礎：8:使用plugin進行jar檔案打包

這篇文章主要目的是用來介紹plugin，為了對本身非常枯燥的內容進行說明，這裡特意跟前面的文章一樣，準備了一個更加枯燥的例子（如何使用gradle的java plugin來打出一個jar檔案），在枯燥的的gradle的學習的旅程中新增一絲不那麼煩躁的情緒。 gradle的plugin

Gradle基礎：7:Property使用方式

在前面的文章中使用到了rootProject.name, 以及task中的description等變數進行直接設定，這些就是gradle內建的property，這篇文章將對gradle的property相關的知識進行介紹。 常用的property：內建 gradle有很多內

Gradle基礎：10:使用gradle init進行初始化

很多工具都有建立建立專案骨架的初期化的功能，比如前端框架的angular，使用它的cli可以快速建立一個包含接近30個檔案的骨架能讓你快速的搭建專案。maven在建立pom的時候也可以通過命令列互動的方式進行簡化，而gradle則提供了gradle init來進行建立。 事前準備

Gradle基礎：11:使用Kotlin的Gradle

Gradle預設方式使用groovy作為DSL的支援方式，kotlin也作為支援方式之一，這篇文章將介紹一下如何在Gradle中使用Kotlin DSL。 使用Kotlin的init gradle init也可以直接指定kotlin的方式生成相關的檔案，使用方式如下

Gradle基礎：1: 簡介與安裝

這篇文章主要介紹一下Grale的主要特性以及安裝方式。 什麼是Gradle Gradle是一個開源的自動構建工具，在Apache Ant和Apache Maven的相關概念基礎上發展而來，與Maven最大的區別之一在於引入了基於Groovy的DSL語言而非使用

階梯T-SQL：超越基礎等級9：動態T-SQL代碼

問題 編碼 create 列名 特定 超出 clas 開始 名稱 作者：Gregory Larsen，2016/07/29（第一次發布：2014/07/23） 原文鏈接：http://www.sqlservercentral.com/articles/Stairway+Se

Spring基礎：快速入門spring boot（9）：使用sonarqube來檢查技術債務

作為程式碼質量檢查的流行工具，比如Sonarqube能夠檢查程式碼的“七宗罪”，跟程式碼結合起來能夠更好地提高程式碼的質量，讓我們來看一下，剛剛寫的Springboot2的HelloWorld的程式碼有什麼“罪”。 Sonarqube Sonarqube可以使用docker

JAVA高階基礎（9）---Set的典型實現（二）：TreeSet

TreeSet TreeSet是基於TreeMap實現的。不是執行緒安全的。TreeSet可以使用元素的自然順序進行排序，或者定製排序 注：更多詳細方法請自行在 API 上查詢 排序方式       &nbs

Python基礎（9）：高階函式（map,reduce,filter,sorted）

高階函式 定義：一個函式，可以接收另一個函式作為引數，這種函式稱之為高階函式。 理論基礎：  1：函式可以接收變數 2：函式名是指向函式的變數。 例如：abs，原本指向一個計算絕對值的函式，將他指向123後，abs變數就不再具有計算絕對值的能力。 map/

Docker基礎篇9：Portainer頁面管理工具

     Portainer是一個開源、輕量級Docker管理使用者介面，基於Docker API，可管理Docker主機或Swarm叢集，支援最新版Docker和Swarm模式。 【1、獲取portainer映象】 [[email protected]_wo

彙編基礎練習題9：在資料區定義一個位元組型變數a1，a1中有10個元素，讀取a1中的值並利用2題中的輸出子程式輸出顯示。

彙編基礎練習題9： 在資料區定義一個位元組型變數a1，a1中有10個元素，讀取a1中的值並利用2題中的輸出子程式輸出顯示。 編譯工具：Masm for Windows 整合實驗環境2012.5 （附帶一個工具下載地址https://download.csdn.net/download

夯實Java基礎系列9：深入理解Class類和Object類

目錄 Java中Class類及用法 Class類原理 如何獲得一個Class類物件 使用Class類的物件來生成目標類的例項 Object類 類構造器public Object(); registerNatives()方法; Clone()方法實現淺拷貝 getClass()方法 equals()方法

python基礎：循環語句和判斷語句

python 語句 循環 判斷 小生博客：http://xsboke.blog.51cto.com 小生 Q Q：1770058260 -------謝謝您的參考，如有疑問，歡迎交流一、 python語句塊和縮進縮進是Py