Gradle之恋(4)-任务1

任务作为Gradle的核心功能模块,而且Gradle的任务还可以具有自己的属性和方法,大大扩展了Ant任务的功能。由于任务相关内容比较多,将分为两篇来探讨,本篇主要涉及到:任务的定义、任务的属性、任务的配置、任务间依赖。 Gradle

创建demo项目

为了本文演示的顺利运行,创建一个demo,名为gradle-tasks

mkdir gradle-tasks && cd gradle-tasks && gradle init

由于我没有windows环境,windows环境的朋友可仿照上面:创建文件夹->进入文件夹->执行gradle init任务。

任务定义

Gradle的任务定义除了关键词定义,还有几个变种,是为了使用某些场合而设计的,比如关键词定义不支持表达式的场合等。实际上创建任务是调用org.gradle.api.tasks.TaskContainer的create方法,TaskContainer中的方法签名如下,因此这玩意最好不要死记硬背,忘记了就查下dsl文档
TaskContainer Method

关键词方式

编辑build.gradle,添加任务

task helloWorld {
doLast {
println "hello world!"
}
}

任务执行

执行任务的语法是

gradle [option...] [task...]

其中有个选项是quiet简写为q,只记录错误信息,用于输出简洁的回显。执行上面关键词的任务

gradle helloWorld

回显

Starting a Gradle Daemon (subsequent builds will be faster)
:hello
hello world!

gradle -q helloWorld

回显

hello world!

如果你的任务名称是驼峰格式,还可以使用简写如执行helloWorld

gradle -q hW

关键词-字符串
task 'str'{
doLast{
println 'this is a str task';
}
}
函数式-关键词
task(testName){
doLast{
println "my names is zhaiqianfeng."
}
}
函数式-字符串
task('testString'){
doLast{
println "This is a string task."
}
}
函数式-map
tasks.create(name:'testMap'){
doLast{
println "This is a map task."
}
}

当然你还可以使用更多参数如type,configuration等,具体值可以参考dsl文档,如

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

任务属性

经常会对你定义的任务进行一些配置或定义依赖的操作,这就需要能够访问到它们。每个任务都是作为项目的属性(property)

println helloWorld.name
println project.helloWorld.name

也可以通过任务集合来访问任务

println tasks['helloWorld'].name
println tasks.helloWorld.name

也可以通过getByPath访问任何项目的任务,”:”代表根路径

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

我们在build script中添加任务来测试

task accessTask{
doLast{
println helloWorld.name
println project.helloWorld.name
println tasks['helloWorld'].name
println tasks.helloWorld.name
println tasks.getByPath('helloWorld').path
println tasks.getByPath(':helloWorld').path
}
}

执行

$ gradle -q aT
helloWorld
helloWorld
helloWorld
helloWorld
:helloWorld
:helloWorld

配置任务

可以先定义一个没有任何行为的任务,在后期再配置其行为,如

task config

config {
doLast{
println "this is a config task."
}
}

你也可以使用变量的方式来配置

Task cf=task('config')
cf.doLast{
println 'this is added by var.'
}
config.doLast{
println 'this is added by name.'
}

任务依赖

任务之间可以有依赖关系,当执行该任务时,会先执行其依赖的任务。任务之间的依赖通过dependsOn关键词来设定,被依赖的任务定义在先:

task hello{
doLast{
print 'hello '
}
}
task world(dependsOn:hello){
doLast{
println 'world!'
}
}

如果依赖的顺序颠倒则必须使用字符串了,否则会找不到的异常:

task world(dependsOn:'hello'){
doLast{
println 'world!'
}
}

task hello{
doLast{
print 'hello '
}
}

当然也可以用属性的方式添加行为

task world{
doLast{
println 'world!'
}
}

world.dependsOn{'hello'}

task hello{
doLast{
print 'hello '
}
}

翟前锋 wechat
欢迎订阅我的微信公众号:zhaiqianfeng!