06 Gradle 入门-Gradle 自定义任务task

文章来源

任务是 Gradle 构建中的两个基本概念之一,而任务的定义和使用有多种形式,以下就给大家介绍几个task 的定义和使用。

定义任务基本语法

// 使用task 后带任务名称 加上执行闭包{}
task t1 {
  println 't1'
}
// 任务名称后加上圆括号
task t2() {
  println 't2'
}
// IDEA 刷新 Task 点击 build 或 左下 Terminal 输入 gradle build 即可看到结果
t1
t2

以上是任务的基本定义,结果得知会在配置 project 阶段时被执行,除了任务依赖,任何涉及到需要配置 project 对象的操作都会被执行。如果需要在任务调用时才执行动作代码需要定义在 doFirst 或者 doLast 方法中。

任务的常见定义方式

task t1{
    // 任务调用前执行动作
   doFirst{
       println 't1'
   }
}
// 任务调用后执行动作
task t2(){
    doLast{
       println 't2'
    }
}
// << 是 doLast 的简写,任务调用后执行动作
task t3 << {
    println 't3'
}
// 可给任务名带 ' '

测试:gradle t1 t2 t3

> Task :t1
t1

> Task :t2
t2

> Task :t3
t3

以上为任务的最常见的定义方式,配置project 时不会调用 doFirst 和 doLast 中的方法。只有在直接调用任务或被其他任务依赖时才会被执行。那这里说的依赖到底怎么依赖呢? 以下就来看下任务的依赖配置。

任务的依赖配置 dependsOn

任务的依赖需要使用一个关键字 dependsOn 来做依赖配置,配置有多种形式,以下就来给大家演示下常见的用法

task t1 {
    doFirst {
        println 't1'
    }
}
// 定义任务时指明依赖
task t2(dependsOn : t1) {
    doLast {
        println 't2'
    }
}
task t3 << {
    println 't3'
}

task t4 {
    dependsOn t3          // 任务内写依赖
    doLast{
        println 't4'
    }
}
// 外部添加依赖 t1 依赖 t3
t1.dependsOn t4

// 外部增加任务动作达到依赖
t3.doFirst{
    println '给 t3 增加增加动作1'
}
t3 << {
    println '给 t3 增加增加动作2'
}

执行任务 t2 gradle t2 ,结果如下:

> Task :t3
给 t3 增加增加动作1
t3
给 t3 增加增加动作2
> Task :t4
t4
> Task :t1
t1
> Task :t2
t2

以上就是 task 常见的几种依赖的书写方式,那 task 还有没有什么高级点的语法特性呢?

其实有的,借助 Groovy 的强大不仅可以定义简单任务还能做更多的事。例如,可以动态定义任务。

动态任务

4.times {
    val ->
    task "tk${val}" << {
        println "The task is task${val}"
    }
}

以上就动态定义了4个任务tk0,tk1,tk2,tk3,那除了动态任务还有哪些高级牛逼的操作呢?其实还可以给任务自定义属性。

给任务自定义属性

这里使用 ext 来给任务添加额外属性,用 ext.属性名 = 值来自定义。

// 给任务添加属性
task tk5{
    ext.myProperty = "The property value"
}
// 获取自定义属性
task printTaskProperty << {
    println tk5.myProperty
}
// ============== 结果 ===================
> Task : printTaskProperty
The property value

还有木有?

其实任务这里只是介绍了一些常用的操作而已,想了解更深入的知识点,请期待任务 task 详讲,这里是带大家先入门的。

接下来用一个例子来巩固下任务。

例子

需求:自定义任务来自动生成项目目录。

// 定义创建目录的普通方法
def createDir(fileName){
    File f = new File(fileName);
    f.mkdirs()
}

// 定义生成Java 项目目录的任务
task createJavaProjectDir << {
    def dirList = ['src/main/java','src/main/resources','src/test/java','src/test/resources']
    dirList.each {fileName  ->  createDir(fileName)}
}

// 定义生成 Web 项目目录的任务
task createWebProjectDir (dependsOn: createJavaProjectDir) << {
    def fileName = 'src/main/webapp'
    createDir(fileName)
}

其实 Java 组件中已经事先定义好了,咱们只需要直接调用就行了。

task createDirs << {
    sourceSets*.java.srcDirs*.each{
        it.mkdirs()
    }
    sourceSets*.resources.srcDirs*.each{
        it.mkdirs()
    }
}

以上就是Gradle 中任务的介绍和任务的实践。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容