Java Gradle入門指南之內建與定製任務類
1.內建任務類（in-built tasks）
Gradle在不斷地更新，其內建任務也在不斷地豐富，這一章節介紹Gradle中最常用的幾個內建任務類，這只是Gradle眾多內建任務類中的一部分，拋磚引玉，更多方法可以參見Gradle官方文件
1.1 複製（Copy）
專案開發和部署過程中，複製檔案是很常見的工作，gradle為了簡化開發步驟提供了大量的內建任務類， Copy 便是其中之一
•先看一段最簡單的程式碼
// org.gradle.api.tasks.Copy
// 將in.txt從當前資料夾複製到abc資料夾（不存在則新建）
// 程式碼中的路徑為相對路徑
task copyTask(type: Copy) {
from •include 與 exclude
(1) include ‘*’ => 包含所有的檔案以及資料夾
(2) include/exclude ‘*.xml’ => 包含/排除當前資料夾下xml型別檔案
(3) include/exclude ‘.txt’,’.data’ =>包含/排除多類檔案，逗號隔開
(4) include/exclude ‘*/.xml’ => 包含/排除所有資料夾下xml型別檔案
•with
// 定義一個copySpec，通常是重複使用的語句 •其他屬
(1) caseSensitive => 大小寫敏感，true/false，預設為true
(2) includeEmptyDirs => 是否包含空資料夾，true/false，預設為true
(3) filter => 重用org.apache.tools.ant.filters.*的方法
(4) 更多參見官方文件
1.2 重新命名（Rename）
•閉包方法
// rename(Closure closure)
// 執行gradle cT
// 將當前資料夾下的所有.txt檔案複製到build/中，並將字尾改為.data
task copyTask(type: Copy) {
from '.'
into 'build'
include '*.txt'
rename { String fileName ->
fileName.replace( '.txt' , '.data' )
}
} •正則表示式
// rename(String sourceRegEx, String replaceWith)
// 將所有以out開頭的檔案複製到build/，並將out替換為output
// $指代正則表示式匹配的地方，從1開始
task copyTask(type: Copy) {
from '.'
into 'build'
include '*.txt'
rename 'out(.*)' , 'output$1' //=> out.txt->output.txt
// rename '(.*)t(.*)', '$1output$2'
} >> 原來的結構如下
--Test/
|--out.txt
|--build.gradle
>> 執行任務後結構
--Test/
|--build/
|--output.txt
|--out.txt
|--build.gradle
1.3 打包（Zip）
// 執行gradle zT
// 將src資料夾下所有檔案打包到dest/資料夾下
task zipTask(type: Zip) {
File destDir = file( 'dest' )
archiveName 'abc.zip'
from 'src'
destinationDir destDir
} >> 原來的結構如下
--Test/
|--src/
|--hello.java
|--world.java
|--build.gradle
>> 執行任務後結構
--Test/
|--dest/
|--abc.zip // 解壓後為hello.java和world.java2個檔案
|--src/
|--hello.java
|--world.java
|--build.gradle
1.4 刪除（delete）
專案打包時，往往需要刪除除錯、測試時的臨時檔案，例如輸出、日誌等，可以使用內建方法 Delete 完成這個任務，使用也非常簡單
task deleteTask(type: Delete) {
delete 'out.txt' , 'log.txt'
}1.5 執行（Exec）
每次執行時，都要切換環境，敲入命令，gradle提供了 Exec 內建方法去簡化除錯、測試過程，可以根據需要編寫程式碼
// Java Web開發，關閉Tomcat
task stopTomcat(type:Exec) {
workingDir '../tomcat/bin'
//linux下
commandLine './stop.sh'
// 重定向輸出到擴充套件屬性output，而不是控制檯
// 當然可以改為輸出到檔案
standardOutput = new ByteArrayOutputStream()
ext.output = {
return standardOutput.toString()
}
} •其他屬性
(1) args(args) =>命令引數，List
(2) commandLine(args) =>命令，List
(3) environment(name, value)，=> 臨時新增一個環境變數，多個需Map
(4) workingDir(dir) => 工作目錄，file型別
(5) 更多參見官方文件
2.定製任務（custom tasks）
Gradle支援大量的外掛，例如war、java、gretty等，這些外掛能夠自動化自動化編譯、打包等過程，但是有時由於專案需求，外掛並不能滿足專案的需求，Gradle支援定製任務類去完成你的工作。接下來將介紹三種定製Gradle任務類的方法
2.1 建立build檔案
// .../Test/build.gradle
println 'I Am A Custom Task'
class HelloTask extends DefaultTask {
String nickName = 'default'
@TaskAction
def action1() { println 'Step 3 I Am ' + name }
@TaskAction
def action2() { println 'Step 2 NickName Is ' + nickName }
}
task hello(type: HelloTask) {
nickName = 'gzdaijie'
doFirst { println 'Step 1' }
doLast { println 'Step 4' }
} 執行結果
C:\Users\gzd\Desktop\Test>gradle -q hello
I Am A Custom Task
Step 1
Step 2 NickName Is gzdaijie
Step 3 I Am hello
Step 4
•name是內建屬性，值為任務名稱，doFirst，doLast內建方法
•擴充套件自類 DefaultTask ， @TaskAction 新增Action
•關於Task基礎知識的介紹，可以參考我的上一篇部落格
2.2 建立buildSrc目錄
事實上，build.gradle檔案中不適合寫類的定義，假設我們定製的每個Task類都寫在build.gradle中，那麼build.gradle檔案將會變得很大，可讀性大大降低，但是又不想為此單獨建立一個工程，那麼將程式碼寫在buildSrc資料夾中將是一個很好的選擇。
// 檔案 HelloTask.groovy
import org.gradle.api.DefaultTask
import org.gradle.api.tasks.TaskAction
class HelloTask extends DefaultTask {
String nickName = 'default'
@TaskAction
def action1() { println 'Step 3 I Am ' + name }
@TaskAction
def action2() { println 'Step 2 NickName Is ' + nickName }
}
// 檔案 build.gradle
task hello(type: HelloTask) {
nickName = 'gzdaijie'
doFirst { println 'Step 1' }
doLast { println 'Step 4' }
} 新建檔案 buildSrc/src/main/groovy/ch3/HelloTask.groovy
目錄結構如下
---Test/
|--build.gradle
|--buildSrc/
|--src/
|--main/
|--groovy/
|--ch3/
|--HelloTask.groovy
執行gradle -q hello
結果與2.1一致，build.gradle中的程式碼顯得十分乾淨
2.3 建立獨立的groovy專案
新建一個groovy專案，命名為HelloTask，可以使用eclipse、IDEA等IDE，接下來純手工建專案吧~
•新建檔案~/HelloTask/src/main/groovy/HelloTask.groovy，將之前的HelloTask複製進去，然後在HelloTask/目錄下新建檔案build.gradle，這裡我們同樣使用gradle來構建groovy專案。
// => HelloTask/build.gradle
// apply plugin 應用外掛
apply plugin: 'groovy'
version= 1.0
dependencies {
// 新增依賴
compile gradleApi()
compile localGroovy()
} 目錄結構如下
--HomeDir
|--Test
|--build.gradle
|--HelloTask
|--build.gradle
|--src
|--main
|--groovy
|--HelloTask.groovy
在HelloTask/ 下執行gradle build
你會發現該目錄下多了build/libs/HelloTask-1.0.jar
這就是我們編譯好的定製任務類
•接下來在HelloTask/ 下執行 gradle build ，gradle會在src/main/groovy目錄下搜尋所有的類build
•回到Test/目錄，清空所有內容，只留下build.gradle，寫入以下內容
// => Test/build.gradle
// buildscript 配置匯入路徑，包資訊
buildscript {
repositories {
flatDir { dirs '../HelloTask/build/libs' }
}
dependencies { classpath group: 'ch3' , name: 'HelloTask' ,version: '1.0' }
}
task hello(type: HelloTask) {
nickName = 'gzdaijie'
doFirst { println 'Step 1' }
doLast { println 'Step 4' }
} •在Test/ 中執行gradle hello，效果和2.1、2.2完全一致
3.小結
1中介紹了常用的內建Task類，2.3中使用了Gradle建立了 Groovy 專案，並用了 buildscript 匯入了編譯好的包，入門指南寫到這裡，build.gradle已經很接近使用IDE（例如Eclipse、IDEA、Andriod Studio）自動生成的build.gradle檔案了，Gradle依賴管理的威力已經開始顯現。
實際專案開發中，更多地是匯入maven倉庫，而不是自己寫依賴，但是希望這個指南能給希望瞭解Gradle的博友帶來幫助，喜歡就關注一下吧~