Gradle

Gradle基础(一) 定义Task or创建task多种方法

2017-12-29  本文已影响0人  Kael_祈求者

1.Gradle的Project从本质上说只是含有多个Task的容器,一个Task与Ant的Target相似,表示一个逻辑上的执行单元。我们可以通过很多种方式定义Task,所有的Task都存放在Project的TaskContainer中。

2.Task可以理解为Gradle的执行单元,实在是太重要了。根据前面的分析,Gradle通过一个个task来完成具体的构建任务,下面我们来看下Task的定义。

(1)调用Project的task()方法创建Task
 在使用Gradle时,创建Task最常见的方式便是:

task helloWord << {
    println 'Hello World! Charles'
}

这里的“<<”表示追加的意思,即向hello中加入执行过程。我们还可以使用doLast来达到同样的效果:

task hello2 {
    doLast {
        println 'hello2'}
}

另外,如果需要向Task的最前面加入执行过程,我们可以使用doFirst:
task hello3 {
    doFirst {
        println 'hello3'}
}

除此之外,doLast还有一个等价的操作leftShift,leftShift还可以缩写为<<,因此下这三种实现效果等价
helloWord .leftShift {
    println 'Hello World! Charles--left'
}

在上面的例子中,Gradle的DSL向我们展示了一种非常自然的风格来创建Task,而事实上这些都只是一种内部DSL,也即必须符合groovy的语法要求。上面的task关键字实际上是一个方法调用,该方法属于Project。Project中存在多个重载的task()方法。和Ruby等动态语言一样,在调用groovy方法时,我们不用将参数放在括号里面。
以上我们自定义的Task都位于TaskContainer中,Project中的tasks属性即表示该TaskContainer。为此,我们可以新建一个Task来显示这些信息:

task showTasks {
    println tasks.class
    println tasks.size()
}

将以上4个Task放在同一个build.gradle中,再执行gradle showTasks,命令行输出如下:

...
class org.gradle.api.internal.tasks.DefaultTaskContainer_Decorated
4
...

上面的DefaultTaskContainer_Decorated表示tasks类型,而4表示该TaskContainer中包含有4个自定义的Task——包括showTasks本身。

(2)通过TaskContainer的create()方法创建Task而Project又维护了一个TaskContainer类型的属性tasks,那么我们完全可以直接向TaskContainer里面添加Task。查查TaskContainer的API文档可以发现,TaskContainer向我们提供了大量重载的create()方法用于添加Task。

tasks.create(name:'hello4') <<{
    println 'hello4'
}

(3)声明Task之间的依赖关系
Task之间是可以存在依赖关系,比如TaskA依赖TaskB,那么在执行TaskA时,Gradle会先执行TaskB,再执行TaskA。我们可以在定义一个Task的同时声明它的依赖关系:

task hello5(dependsOn:hello4) << {
    println 'hello5'
}

当然,我们也可以在定义Task之后再声明依赖:

task hello6 << {
    println 'hello6'
}

hello6.dependsOn hello5

(4)配置Task
一个Task除了执行操作之外,还可以包含多个Property,其中有Gradle为每个Task默认定义的Property,比如description,logger等。另外,每一个特定的Task类型还可以含有特定的Property,比如Copy的from和to等。当然,我们还可以动态地向Task中加入额外的Property。在执行一个Task之前,我们通常都需要先设定Property的值,Gradle提供了多种方法设置Task的Property值。

首先,我们可以在定义Task的时候对Property进行配置:

task hello7 << {
    description = "this is hello7"
    println description
}

我们还可以通过闭包的方式来配置一个已有的Task:

task hello8 << {
    println description
}

hello8 {
    description = "this is hello8"
}

需要注意的是,对hello8的description设置发生在创建该Task之后,在执行“gradle hello8”时,命令行依然可以打印出正确的“this is hello8”,这是因为Gradle在执行Task时分为两个阶段,首先是配置阶段,然后才是实际执行阶段。所以在执行hello8之前,Gradle会扫描整个build.gradle文档,将hello8的description设置为“this is hello8”,然后执行hello8,此时hello8的description已经包含了设置后的值。

我们还可以通过调用Task的configure()方法完成Property的设置:

task hello9 << {
    println description
}

hello9.configure {
    description = "this is hello9"
}

实际上,通过闭包的方式配置Task在内部也是通过调用Task的configure()方法完成的

(5)group task属于哪个组下面我来看一个列子

// 定义一个名字为Cls的task,属于Charles分组,并且依赖myTask1和myTask2两个task。
project.task('ClsTask', group: "charles", description: "我自己的Task", dependsOn: ["myTask1", "myTask2"] ).doLast {
    println "execute ClsTask"
}

尝试执行gradle ClsTask,结果如下:

:myTask1
execute myTask1
:myTask2
execute myTask2
:ClsTask
execute ClsTask

BUILD SUCCESSFUL

(6)定义Task的时候是可以指定很多参数的,如下所示:

参数                     含义                       默认值
name                   task的名字              不能为空,必须指定
type                   task的“父类”              DefaultTask
overwrite             是否替换已经存在的task         false
dependsOn             task依赖的task的集合            []
group                   task属于哪个组               null
descriptions             task的描述                  null
 

到此 Gradle 定义Task就全部讲完。最后,定义task的API很多,我介绍了最常用的部分,剩下的细节还是需要大家查看Gradle文档,其实学习Gradle就是一个查文档的过程。如下几个文档,大家读读。
Project API

TaskContainer API

Task API

上一篇下一篇

猜你喜欢

热点阅读