3、Working with tasks

task定义

// 1
task('hello') {
    doLast {
        println "hello"
    }
}
task('copy', type: Copy) {
    from(file('srcDir'))
    into(buildDir)
}

// 2
tasks.create('hello') {
    doLast {
        println "hello"
    }
}

tasks.create('copy', Copy) {
    from(file('srcDir'))
    into(buildDir)
}

// 3 Using Groovy dynamic keywords
task(hello) {
    doLast {
        println "hello"
    }
}

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

这里'copy'就是task的名字,而Copy本身是gradle的默认task,这里我们使用这个默认task来定义自己的task。通过create方法创建task时会将task加入到一个task容器。

定位task

task hello
task copy(type: Copy)

// Access tasks using Groovy dynamic properties on Project

println hello.name
println project.hello.name

println copy.destinationDir
println project.copy.destinationDir

// 还可以通过容器的方式进行访问
task hello
task copy(type: Copy)

println tasks.hello.name
println tasks.named('hello').get().name

println tasks.copy.destinationDir
println tasks.named('copy').get().destinationDir

从这里我们可以更容易理解了task容器tasks

或者使用getByPath方法

task hello

println tasks.getByPath('hello').path
println tasks.getByPath(':hello').path

task依赖

task taskX {
    doLast {
        println 'taskX'
    }
}
task taskY {
    doLast {
        println 'taskY'
    }
}
taskX.dependsOn taskY

我们还可以这样定义依赖

task taskY {
    doLast {
        println 'taskY'
    }
}

task taskX(dependsOn: taskY) {
    doLast {
        println 'taskX'
    }
}

注意:这里如果taskY定义在taskX后面则在运行的时候会报错。

> gradle -q taskX
taskY
taskX

但是这种依赖却可以

task taskX {
    doLast {
        println 'taskX'
    }
}
task lib1 {
    doLast {
        println 'lib1'
    }
}
// Using a Groovy Closure
taskX.dependsOn {
    tasks.findAll { task -> task.name.startsWith('lib') }
}
task lib2 {
    doLast {
        println 'lib2'
    }
}
task notALib {
    doLast {
        println 'notALib'
    }
}

task的顺序

task taskX {
    doLast {
        println 'taskX'
    }
}
task taskY {
    doLast {
        println 'taskY'
    }
}
taskY.mustRunAfter taskX
E:\project\gradle-study>gradle -q taskX
taskX
E:\project\gradle-study>gradle -q taskY
taskY
E:\project\gradle-study>gradle -q taskY taskX
taskX
taskY

这里使用mustRunAfter来规定两个任务的运行顺序,当然我们还可以使用shouldRunAfter来规定,但是这个规定并不是强制的,只是建议。

task taskX {
    doLast {
        println 'taskX'
    }
}
task taskY {
    doLast {
        println 'taskY'
    }
}
task taskZ {
    doLast {
        println 'taskZ'
    }
}
taskX.dependsOn taskY
taskY.dependsOn taskZ
taskZ.shouldRunAfter taskX
E:\project\gradle-study>gradle -q taskX
taskZ
taskY
taskX

这里涉及到一个循环依赖的问题,此时shouldRunAfter就会失效。

task备注说明信息(description)

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

跳过相关task不执行

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

执行

E:\project\gradle-study>gradle -q hello
hello world
E:\project\gradle-study>gradle -q hello -PskipHello

还可以通过一场控制依赖的task

task compile {
    doLast {
        println 'We are doing the compile.'
    }
}

compile.doFirst {
    if (project.hasProperty('throwExp')) { throw new StopExecutionException() }
}
task myTask {
    dependsOn('compile')
    doLast {
        println 'I am not affected'
    }
}

执行的时候如果依赖的task中报异常,则会跳过此依赖

E:\project\gradle-study>gradle -q myTask -PthrowExp
I am not affected
E:\project\gradle-study>gradle -q myTask
We are doing the compile.
I am not affected

task有一个默认的标签属性enabled,默认为true,如果设置为false则会跳过

myTask.enabled = false

task设置超时时间

task hangingTask() {
    doLast {
        Thread.sleep(10000)
    }
    timeout = Duration.ofMillis(500)
}
E:\project\gradle-study>gradle -q hangingTask

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':hangingTask'.
> Timeout has been exceeded

增量编译

如果我们将GradleTask看作一个黑盒子,那么我们便可以抽象出输入和输出的概念,一个Task对输入进行操作,然后产生输出。比如,在使用java插件编译源代码时,输入即为Java源文件,输出则为class文件。如果多次执行一个Task时的输入和输出是一样的,那么我们便可以认为这样的Task是没有必要重复执行的。此时,反复执行相同的Task是冗余的,并且是耗时的。

为了解决这样的问题,Gradle引入了增量式构建的概念。在增量式构建中,我们为每个Task定义输入(inputs)和输入(outputs),如果在执行一个Task时,如果它的输入和输出与前一次执行时没有发生变化,那么Gradle便会认为该Task是最新的(UP-TO-DATE),因此Gradle将不予执行。一个Taskinputsoutputs可以是一个或多个文件,可以是文件夹,还可以是Project的某个Property,甚至可以是某个闭包所定义的条件。

每个Task都拥有inputsoutputs属性,他们的类型分别为TaskInputsTaskOutputs。在下面的例子中,我们展示了这么一种场景:名为combineFileContentNonIncrementalTasksrc目录中读取所有的文件,然后将每个文件的内容合并到destination.txt文件中。让我们先来看看没有定义Task输入和输出的情况:

task combineFileContentNonIncremental {
    def sources = fileTree('src')
    def destination = file('destination.txt')

    doLast {
        destination.withPrintWriter {
            writer -> sources.each {
                source -> writer.println(source.text)
            }
        }
    }
}

多次执行,那么会多次合并,但是其实我们运行一次就达到目的了。此时我们可以将sources声明为该Taskinputs,而将destination声明为outputs,重新创建一个Task如下:

task combineFileContent {
    def sources = fileTree('src')
    def destination = file('destination.txt')

    inputs.dir sources
    outputs.file destination

    doLast {
        destination.withPrintWriter {
            writer -> sources.each {
                source -> writer.println(source.text)
            }
        }
    }
}
E:\project\gradle-study>gradle -q combineFileContent
E:\project\gradle-study>gradle combineFileContent

Deprecated Gradle features were used in this build, making it incompatible with Gradle 7.0.
Use '--warning-mode all' to show the individual deprecation warnings.
See https://docs.gradle.org/6.1-rc-1/userguide/command_line_interface.html#sec:command_line_warning
s

BUILD SUCCESSFUL in 1s
1 actionable task: 1 up-to-date
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 141,930评论 1 299
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 60,888评论 1 255
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 93,606评论 0 211
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 40,848评论 0 175
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 48,544评论 1 253
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 38,671评论 1 173
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 30,312评论 2 267
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 29,112评论 0 165
  • 想象着我的养父在大火中拼命挣扎,窒息,最后皮肤化为焦炭。我心中就已经是抑制不住地欢快,这就叫做以其人之道,还治其人...
    爱写小说的胖达阅读 28,899评论 6 229
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 32,451评论 0 213
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 29,221评论 2 213
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 30,541评论 1 225
  • 白月光回国,霸总把我这个替身辞退。还一脸阴沉的警告我。[不要出现在思思面前, 不然我有一百种方法让你生不如死。]我...
    爱写小说的胖达阅读 24,196评论 0 31
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 27,079评论 2 213
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 31,448评论 3 204
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,597评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 25,969评论 0 164
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 33,451评论 2 230
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 33,523评论 2 229

推荐阅读更多精彩内容