Project
和Task
是Gradle
中最核心的两个元素,当创建了一个build.gradle
脚本那么Gradle
便会依据脚本的配置创建一个Project
,而脚本中的Task
也会创建与之相对应DeafultTask
实现。
Gradle
通过一个个Task
来完成具体的构建任务 ,可以说Task
乃是Gradle
的核心。根据执行阶段的不同,可以将Gradle
中Task
分为配置型Task
以及动作型Task
。
一、Task的基本组成
查看Task DSL
说明我们可以发现,通常一个Task
包括: 依赖、动作、属性、输入、输出、终结器等构成。
当然这些并不是每一个都是必须的。创建任务的时候需要根据自己的具体需要进行选择性配置。
二、定义Task
Gralde
中定义一个任务的方式十分灵活,下面都是定义一个任务的方式。
1 | task myTask |
配置型Task
定义一个Task
十分简单,只需要使用task name{}
即可定义一个简单的任务。
1 | task helloTask { |
执行gradle hT
,可以观察到执行结果。这里你可能会注意到Hello world
并非在执行阶段开始执行的,而是在配置阶段就已经打印了。没错,这就是一个配置型Task
,因为Gradle在任务执行前,总会去遍历所有任务去生成一张DAG(有向无环图)
来确定任务之间的关系。
动作型Task
如果不想让任务在配置阶段执行,那么可以参照如下方式,通过给任务添加action的方式使其在执行阶段运行。
1 | task helloTask { |
常用的action有两个,doFirst
和doLast
,通过这两个见名知意的action
可以用来定置化你的任务行为。
- 一个Task包含若干
Action
。所以,Task有doFirst
和doLast
两个函数,用于添加需要最先执行的Action
和需要和需要最后执行的Action
。Action
就是一个闭包。 - Task创建的时候可以指定Type,通过type:名字表达。这是什么意思呢?其实就是告诉
Gradle
,这个新建的Task对象会从哪个基类Task派生。比如,Gradle本身提供了一些通用的Task,最常见的有Copy 任务。Copy是Gradle中的一个类。当我们:*task myTask(type:Copy)*
的时候,创建的Task就是一个Copy Task。 - 当我们使用
task myTask{ xxx}
的时候。花括号是一个closure
。这会导致gradle在创建这个Task之后,返回给用户之前,会先执行closure的内容。
当用户执行test任务时,执行以下步骤:
- 执行build.gradle,初始化任务,初始化步骤为2-7;
- 注册test任务,任务体都是默认好的,不可更改,为打印冒号加任务名,所以test的任务体为
println ':test'
; - 每个任务都有一个队列一个栈,一个是依赖队列,一个是first栈,一个是last队列;
- 遇到doFirst函数,该函数接受一个闭包作为参数,doFirst函数会把闭包参数放入first栈;
- 遇到doLast函数,同理doFirst函数,闭包参数会被放入last队列;
- 然后遇到
println 'hello.'
,执行该指令//1; - 至此初始化过程完成。
- 开始执行test任务前,先检查是否任务依赖,如果有,先把依赖的任务都执行完。
- 然后开始执行test任务;
- 执行时,首先执行test任务的任务体,即
println ':test'
; - 然后执行test任务的first栈//2和last队列//3;
- 任务执行结束。
三、Task中属性的应用
分组
DeafultTask
提供了很多方便的属性,灵活运用这些属性可以让你更加灵活的配置自己的Task
。如:在IDEA
等编辑器中我们查看Gradle
任务时,任务都是放在各个任务组下面的,这便是借助任务属性中的group
属性实现的。如果在创建任务时没指定这个属性,那么任务会默认分配到other tasks
分组。
1 | task mytask{ |
依赖
由于Gradle
中任务的执行顺序是不确定的,当你需要按顺序执行某些任务时,可以通过dependsOn
、mustRunAfter
、finalizedBy
等定义任务之间的依赖关系来达到让任务按顺序执行的目的。看下面的例子。
1 | task one{ |
跳过
有时为了节约构建时间我们需要跳过某些任务的执行,此时可以通过指定enabled
属性的方式来跳过某些任务的执行。
当然,在执行时候通过命令行参数-x taskname
也可以达到相同的效果。
为了提高构建的速度,Gradle在执行任务时都会检查任务的输入与输出,如果输入输出相对上次构建没有变化那么会将此任务标记为UP-TO-DATE
来跳过任务的执行。当然你也可以通过inputs
和outputs
的upToDateWhen{}
来控制这种行为。
1 | task one{ |
动态任务
得益于Gradle
基于groovy
的dsl
可以方便的定义一个动态任务。
1 | 4.times { counter -> |
类型任务
Gradle
及其各种插件提供了许多内置的任务类型,我们可以直接创建需要的类型任务来实现一些自定义效果。下面的代码创建了一个Copy
类型的任务。Copy
任务实现了CopySpec
接口,通过查阅CopySpec
的API说明我们可以自定义该任务的属性和方法的实现。
1 | task copyTask(type: Copy) { |
四、自定义任务
在Gradle
中自定义一个任务是十分方便的,只需要编写一个继承自DefaultTask
的类即可。你可以直接在你的脚本文件中编写,也可以放到buildSrc
中,当然出于可维护性的考虑以及视觉上的感受更推荐后者的方式。
若要在buildSrc
下定义,只需要在build.gradle
同级目录创建buildSrc
并把任务类放在src\main\java
或src\main\groovy
下即可。
1 | // 直接在脚本文件中定义自定义任务 |