2. 程式人生 > >Gradle學習(十四)——任務詳解

Gradle學習(十四)——任務詳解

阿新 • • 發佈：2019-01-27

之前的文章已經將了一下任務的基礎知識，包括建立簡單的任務，以及任務的依賴，本文將進一步的講解一些任務的詳細知識

任務結果

當Gradle執行任務時，就會因為不同的結果給這些任務打上不同的標籤，這些標籤表示任務是否有動作需要執行，任務是否應該執行了動作，任務是否執行了這些動作，這些動作是否發生了變化。

結果標籤 結果描述 產生結果的前提
沒有標籤或者EXECUTED 任務執行了動作 1.任務有動作，Gradle也確定該動作必須被執行
2.任務沒有動作但是有依賴，這些依賴都要被執行
UP-TO-DATE 任務輸出沒有改變 1.當任務有輸入輸出但是沒有變化
2當任務有action，但是任務告訴Gradle輸出沒有變化
3.當任務沒有動作，而是有依賴，但是所有的依賴都是UP-TO-DATE，SKIP或者從快取取出的
4.任務沒有動作也沒有依賴
FROM-CACHE 任務輸出可以在之前的執行快取中被找到 任務在構建緩衝中可以找到相應的輸出
SKIPPED 任務沒有執行動作 1.在命令列顯示指定了被跳過
2.任務的onlyIf判斷返回false
NO-SOURCE 任務不需要執行動作 任務有輸入輸出，但是沒有sources，比如JavaCompile任務的source就是.java檔案

定義任務

之前的章節我們已經學會如何使用keyword方式定義任務,還有一些別的方式來定義任務，因為keyword方式不支援表示式。

task(hello) {
    doLast {
        println 'hello'
 

    }
}

task(copy, type: Copy) {
    from file('src')
    into buildDir
}

你也可以通過string來定義任務

task('hello') {
    doLast {
        println 'hello'
    }
}

task('copy', type: Copy) {
    from file('src')
    into buildDir
}

還可以通過tasks來建立任務

tasks.create('hello') {
    doLast {
        println 'hello'
 

    }
}

tasks.create(name: 'copy', type: Copy) {
    from file('src')
    into buildDir
}

檢索任務

你有時候需要檢索在構建檔案中定義的任務，比如對任務進行配置或者新增依賴，有很多種方式可以檢索。

首先，所有的任務對project物件來說就是可用屬性，你可以像使用屬性一樣來檢索這些任務。

task hello
println hello.name
println project.hello.name

也可以通過tasks集合來檢索

task hello
println tasks.hello.name
println tasks['hello'].name

也可以通過tasks.getByPath()來訪問任意工程的任務，可以使用任務名，相對路徑，絕對路徑來呼叫getByPath()方法。

task hello
project(':projectA') {
    task hello
}
println tasks.getByPath('hello').path
println tasks.getByPath(':hello').path
println tasks.getByPath('projectA:hello').path
println tasks.getByPath(':projectA:hello').path

然後執行hello任務：

:hello
:hello
:projectA:hello
:projectA:hello

配置任務

我們從一個copy任務的示例來看如何配置Gradle的任務

task myCopy(type:Copy)

這是一個沒有任何預設行為的copy任務，我們有各種各樣的方法可以配置它。

myCopy.from 'resource'
myCopy.into 'build'
myCopy.include '**/*.txt', '**/*.xml', '**/*.properties'

首先就是最普通的方式，像配置java或者groovy物件那樣呼叫方法進行配置，myCopy需要重複好多次，可讀性並不好。
還有一種方法可以不用重複myCopy，看起來可讀性更好些：

myCopy {
    from 'resource'
    into 'build'
    include '**/*.txt', '**/*.xml', '**/*.properties'
}

這種方式其實是呼叫了tasks.getByName(String var1, Closure var2)方法，你看到的是它的縮寫，這個方法完成了使用Closure對任務進行了配置。

你也可以在定義的時候就進行配置：

task myCopy(type:Copy) {
    from 'resource'
    into 'build'
    include '**/*.txt', '**/*.xml', '**/*.properties'
}

給任務新增依賴

有各種各樣的方式可以給任務新增依賴。常用的是通過任務名進行新增依賴，不僅可以在相同專案中可以通過任務名新增依賴，也可以新增其他專案的任務作為依賴。新增其他專案的任務作為依賴時，必須要把其他工程的專案名作為字首，下面是個跨專案依賴的例子：

project(':projectA') {
    task taskX(dependsOn:':projectB:taskY') {
        doLast {
            println it.name
        }
    }
}

project(':projectB') {
    task taskY {
        doLast {
            println it.name
        }
    }
}

然後執行taskX任務：

% gradle taskX -q                                                       
taskY
taskX

除了使用任務名外，你還可以通過Task物件進行新增依賴：

task taskX {
    doLast {
        println it.name
    }
}

task taskY {
    doLast {
        println it.name
    }
}
taskX.dependsOn taskY

然後執行taskX任務：

% gradle taskX -q                                                       
taskY
taskX

再擴充套件一下，你甚至可以定義閉包作為依賴，這個閉包應該返回一個task或者多個task列表，這些task會被當做任務的依賴，示例如下：

task taskX {
    doLast {
        println it.name
    }
}

taskX.dependsOn {
    tasks.findAll {
        it.name.startsWith('lib')
    }
}

task lib1 {
    doLast {
        println it.name
    }
}

task lib2 {
    doLast {
        println it.name
    }
}

然後執行taskX任務：

± % gradle taskX -q   
lib1
lib2
taskX

任務排序

控制兩個任務的執行順序而不是顯示的宣告他們之間的依賴關係，在某些用例下它是非常有用的。任務排序和任務依賴的不同在於，任務排序不會影響哪個任務將被執行，僅僅只是影響將被任務的排序。

任務排序適用的場景：

  • 強制任務的執行順序：比如build必須在clean任務後面執行
  • 在build之後才執行校驗：比如需要在release構建之後才進行認證校驗
  • 在長校驗之前先進行短校驗：比如先單元測試再整合測試
  • 一個任務是其他所有任務的總結：比如測試報告任務需要其他測試任務都做完的情況下

有兩個排序規則：must run after和should run after

當你執行must run after規則時，taskB.mustRunAfter(taskA)表示taskB和taskA同事執行時，taskB必然在taskA之後執行。

而should run after就沒那麼嚴格了，它在兩種情況下就會被忽略掉：
第一種情況就是任務排序構成了迴圈，比如taskB.shouldRunAfter taskA之後又taskA.shouldRunAfter taskB。
第二種情況宣告的依賴和should run after的順序不一樣，should run after就會被忽略掉
使用should run after應該在有更好，沒有也行的情況下才使用。
看下面的例子：

task taskA {
    doLast {
        println it.name
    }
}

task taskB {
    doLast {
        println it.name
    }
}
taskB.mustRunAfter taskA

然後執行taskA和taskB任務：

± % gradle taskB taskA -q                                                 
taskA
taskB

should run after的情況：

task taskA {
    doLast {
        println it.name
    }
}

task taskB {
    doLast {
        println it.name
    }
}
taskB.shouldRunAfter taskA

然後執行taskA和taskB任務：

± % gradle taskB taskA -q                                                 
taskA
taskB

上面的例子中，如果單獨執行taskB任務：

± % gradle taskB  -q
taskB

可以看到taskA任務並沒有執行

如果有--continue選項，如果A失敗B也會繼續執行。

task taskA {
  doLast {
      throw new Exception()
      println it.name
  }
}

task taskB {
    doLast {
        println it.name
    }
}
taskB.shouldRunAfter taskA

然後執行taskA和taskB任務：

± % gradle --continue -q taskA taskB                                      
taskB

FAILURE: Build failed with an exception
···

和依賴關係衝突的情況下，shouldRunAfter會被忽略

task taskA {
    doLast {
        println it.name
    }
}

task taskB {
    doLast {
        println it.name
    }
}
taskA.dependsOn taskB
taskB.shouldRunAfter taskA

然後執行

± % gradle -q taskA taskB                                                 
taskB
taskA

如果是mustRunAfter和依賴衝突，那麼就會直接報錯

任務描述

你可以為任務增加描述資訊，他會在gradle tasks顯示出來。

task myCopy(type: Copy) {
    description 'Copy the resource directory to the build directory'
    from 'resource'
    into 'build'
    include '**/*.txt', '**/*.xml', '**/*.properties'
}

替代任務

有時候你需要替代任務，必須你想自定義java外掛的某個任務,可以參照下面這個例子：

task copy(type:Copy){
    doLast {
        println 'copy1'
    }
}
task copy(overwrite: true) {
    doLast {
        println 'copy2'
    }
}

任務輸出：

± % gradle copy -q                                                       
copy2

如果直接定義名字相同的任務，Gradle會丟擲任務已經被定義的異常，因此你需要增加overwrite:true的設定。

跳過任務

Gradle提供了多種方法可以跳過任務的執行

使用predicate

你可以用onlyIf()方法給任務附加一個predicate，只有當predicate為true時，任務的動作才會執行.predicate可以用closure去實現，closure將會作為一個引數傳入到OnlyIf方法中，只有當閉包返回true，任務的action才會執行，否則將會跳過，示例如下：

task hello {
    doLast {
        println 'hello world'
    }
}
hello.onlyIf {
    !project.hasProperty('skipHello')
}

然後執行任務：

± % gradle hello -PskipHello -q

任務跳過，沒有任何輸出

使用StopExecutionException

如果跳過的邏輯很難用predicate協程表示式，那麼可以考慮下StopExecutionException，這個異常可以通過一個action丟擲來，然後該任務之後的action都會跳過，但是會執行下一個任務：

task compile {
    doLast {
        println 'compile'
    }
}
compile.doFirst {
    if(true){
        throw new StopExecutionException()
    }
}
task myTask(dependsOn: compile) {
    doLast {
        println 'myTask'
    }
}

然後執行任務：

± % gradle myTask -q                                                     
myTask

這個特性非常有用，因為它的力度是基於action的，靈活使用可以寫出很多有趣的程式碼

啟用禁用任務

每個任務的enabled標籤預設都是true，如果設為false，它所以的action都不會被執行，任務結果也會變成SKIPPED

task disabledMe {
    doLast {
        println '反正寫什麼也不會被執行'
    }
}
disabledMe.enabled = false

然後執行任務：

± % gradle disabledMe -q

任務規則

有時候你需要任務可以包含無窮的引數，而你不想為每個都單獨寫一個task的話，你可以試試任務規則：

tasks.addRule('Pattern:ping<ID>') { String taskName ->
    if (taskName.startsWith('ping')) {
        task(taskName) {
            doLast {
                println "Panding: " + (taskName - 'ping')
            }
        }
    }
}

你可以這樣執行任務:

± % gradle pingServer1 -q                                                 
Panding: Server1

addRule的第一個引數是描述引數，用於gradle tasks的顯示，在命令列下可以看到，目前idea的gradle外掛還不支援。

任務規則不僅僅可以在命令列下呼叫，而且還可以與其他規則建立以來關係

tasks.addRule('Pattern:ping<ID>') { String taskName ->
    if (taskName.startsWith('ping')) {
        task(taskName) {
            doLast {
                println "Panding: " + (taskName - 'ping')
            }
        }
    }
}

task groupPing {
    dependsOn pingServer1,pingServer2
}

然後執行任務：

± % gradle groupPing -q                                                   
Panding: Server1
Panding: Server2

Finalizer任務

被終結的任務執行後，Finalizer任務必然會跟著執行

task taskC {
    doLast {
        println it.name
    }
}

task taskD {
    doLast {
        println it.name
    }
}
taskC.finalizedBy taskD

執行任務:

± % gradle taskC -q                                                       !1
taskC
taskD

即使被終結的任務失敗了，Finalizer任務一樣會執行

task taskC {
    doLast {
        println it.name
        throw new RuntimeException()
    }
}

task taskD {
    doLast {
        println it.name
    }
}
taskC.finalizedBy taskD

執行任務：

± % gradle taskC -q                                                       
taskC
taskD

FAILURE: Build failed with an exception.
...

僅僅有一種情況下Finalizer任務不會被執行，就是被終極的任務根本沒有工作，比如up to date或者依賴失敗了。

Finalizer任務在無論構建是否成功都必須要清除一些資源的情況下是非常有用的，比如測試中需要的web容器，它在整合測試前需要被開啟，而無論測試是否成功，都需要被關閉。

生命週期任務

生命週期任務本身自己沒有action可以執行，它有一下幾個特點

  • 一個工作流（比如用check執行所以的check任務）
  • 一個可以構建是事物（比如執行debug32MainExecutable為native元件生產32位下的debug可執行程式）
  • 一個可以執行相同邏輯任務的任務（比如compileAll執行所以的編譯任務）

很多Gradel外掛都有自己的生命週期任務，可以方便的指定具體的操作。如果你自己開發Gradle外掛時，一定要記得把相同邏輯的任務作出生命週期任務，以便於操作。

除非生命週期任務有自己的action，否則他的執行與否要看他所有的依賴是否需要執行，如果有一個需要執行，那麼生命週期任務就會被執行。如果所有的依賴都是up-to-date，skipped或者從構建快取拉取的，那麼這個任務就是up-to-date的。

相關推薦

Gradle學習(十四)——任務詳解

之前的文章已經將了一下任務的基礎知識，包括建立簡單的任務，以及任務的依賴，本文將進一步的講解一些任務的詳細知識 任務結果 當Gradle執行任務時，就會因為不同的結果給這些任務打上不同的標籤，這些標籤表示任務是否有動作需要執行，任務是否應該執行了動作，任

[ZT]周易六十四卦詳解（通俗易懂版）

周易六十四卦詳解（通俗易懂版） 圖1. 伏羲八卦次序方點陣圖 第1卦乾為天（乾卦）剛健中正 上上卦 象曰：困龍得水好運交，不由喜氣上眉梢，一切謀望皆如意，向後時運漸漸高。 這個卦是同卦（下乾上乾）相疊。象徵

PHPUnit學習筆記(四)斷言詳解

斷言(Assertions)是PHPUnit提供的一系列對程式執行結果測試的方法。通俗的講，就是斷言執行程式結果為我們期待的值，如果不是則測試失敗，下面是斷言方法的詳細介紹，內容全部來翻譯自PHPUnit的官方文件，部分方法官方介紹的很模糊，我根據官方的原始碼註釋增加了說明和註釋

多執行緒程式設計學習十一(ThreadPoolExecutor 詳解).

一、ThreadPoolExecutor 引數說明 public ThreadPoolExecutor(int corePoolSize, int maximumPoolSize,

Android 學習之《第一行程式碼》第二版 筆記（十一）詳解廣播機制（一）

一、廣播機制簡介 1. 四大元件之一 2. Android 提供了一套完整的API，允許應用程式自由地傳送和接收廣播。 A. 傳送廣播藉助Intent B. 接收廣播藉助廣播接收器（Broadcast Receiver） 3. 廣播型別： A. 標準廣播： 完全非同步執行

Android 學習之《第一行程式碼》第二版 筆記（十二）詳解廣播機制（二）

廣播的最佳實踐——實現強制下線功能 思路：在介面上彈出一個對話方塊，讓使用者無法進行任何操作，必須點選對話方塊中的確定按鈕，然後回到登入介面即可。 一、效果圖 1. 登入介面並輸入賬號密碼 2. 登陸後的介面 3. 強制下線 4. 退回登陸的介面

[引用]java多執行緒學習-java.util.concurrent詳解(四) BlockingQueue

自：http://janeky.iteye.com/blog/7706717.BlockingQueue     “支援兩個附加操作的 Queue，這兩個操作是：獲取元素時等待佇列變為非空，以及儲存元素時等待空間變得可用。“     這裡我們主要討論BlockingQueue的最典型實現：LinkedBlo

【系統學習SpringBoot】SpringBoot定時任務詳解

強大的SpringBoot對定時任務這種常用的功能做了很好的封裝，，只需三步即可完成 一、新增依賴 pom.xml檔案中新增如下依賴： <dependencies> <dependency> <

Java經典演算法四十例程式設計詳解+程式例項

JAVA經典演算法40例 【程式1】   題目：古典問題：有一對兔子，從出生後第3個月起每個月都生一對兔子，小兔子長到第四個月後每個月又生一對兔子，假如兔子都不死，問每個月的兔子總數為多少？   1.程式分析：   兔子的規律為數列1,1,2,3,4,6,9,13,....

uC/OS-III 任務詳解（四）

uC/OS系統的任務一般都放在最開始介紹，我放在第四章主要是對模糊的概念作清晰的講解。 從使用者的角度來看，uC/OS-III 中的任務可以分為5 種狀態，分別是休眠態、就緒態、執行態、掛起態和中斷態，如下表所示。      任務狀態之間的具體切換情況如下圖所示。  

crontab定時任務詳解

文件 install 重新 init 設定 ntpdate 關閉 同步 星期 1、安裝crontab:yum install crontabs 說明：/sbin/service crond start //啟動服務/sbin/service crond stop //關閉

JS學習十四天----server端運行JS代碼

times 接口 2.6 cal dynamic 支持 benchmark target log server端運行JS代碼 話說,當今不在client使用JS代碼才是稀罕事.因為web應用的體驗越來越豐富,client用JS實現的邏輯也越來越多,這造成的結果就是

Spring batch學習 持久化表結構詳解(2)

true fig 序列化 roc col id字段 exce har class #接上一篇 這一篇講一下持久化需要表 batch_job_execution, batch_job_execution_context, batch_job_execution_pa

Profile Lookup 任務詳解

發現 var 分支語句 code per 答案 括號 返回 結束 昨天刷題卡在這了，覺得很簡單一個問題啊，為什麽不對呢，甚至還懷疑過有bug。然後百度找答案，搜到第一個兄弟的答案，我發現了他的兩個錯誤，因此找到了我的原因。 建議小夥伴自己思考一遍，做一遍再來看該文章。

Linux 定時任務詳解

什麽 file 同名 實現 link 打印 環境 grep 導入 fileclear.sh tamcdir=${HOME}/ora/user_projects/domains/tamc cd ${tamcdir} echo rm -f `ls heapdump*.phd

Maven學習(十四)-----Maven 構建配置文件

dev sources png rod 基於 ret 丟失 tof inter Maven 構建配置文件 什麽是構建配置文件? 生成配置文件是一組可以用來設置或覆蓋 Maven 構建配置值的默認值。使用生成配置文件，你可以針對不同的環境，如：生產V/S開發環境自定義構建。

spring boot 學習(十四)SpringBoot+Redis+SpringSession緩存之實戰

blog 安裝 user 個人 turn pid pass pin star SpringBoot + Redis +SpringSession 緩存之實戰 前言 前幾天，從師兄那兒了解到EhCache是進程內的緩存框架，雖然它已經提供了集群環境下的緩存同步策略，這種同步仍

Ansible 小手冊系列 四（詳解配置文件）

method random vbo lec 執行 handle test 語言 rand [root@host-172-20-6-120 ansible]# ansible --version ansible 2.2.0.0 config file = /etc/an

crond定時任務詳解

ceo 開發 單用戶 init.d 管理 deny rest fin nta 首先來了解一下chkconfig這個命令： chkconfig命令檢查、設置系統的各種服務。這是Red Hat公司遵循GPL規則所開發的程序，它可查詢操作系統在每一個執行等級中會執行哪些系統服務，

系統學習前端之FormData詳解

pan 3.2 第一個 實例 open password 訪問表 -name 訪問 FormData1. 概述FormData類型其實是在XMLHttpRequest 2級定義的，它是為序列化表以及創建與表單格式相同的數據（當然是用於