Gradle随记---渐入

这章来说说Gradle中最重要的编译执行载体task,它实质是一系列Action的集合,其中最为重要的是七个属性和六个方法。
可以通过gradlew :projectName:tasks来查看指定project所配置的所有任务,整个编译会在configure期间,配置所有的task依赖关系,计算出Task Graph,换句话说只能在 configure期间添加任务到编译链条中,否则是不生效的。
接下来我们从task的重要属性,方法以及创建方式来深扒一下。

属性

task的属性主要由名称,描述,组,类型,依赖,覆盖以及行为组成。

public interface Task extends Comparable<Task>, ExtensionAware {
    String TASK_NAME = "name";

    String TASK_DESCRIPTION = "description";

    String TASK_GROUP = "group";

    String TASK_TYPE = "type";

    String TASK_DEPENDS_ON = "dependsOn";

    String TASK_OVERWRITE = "overwrite";

    String TASK_ACTION = "action";
    ...
}
  • TASK_NAME: 任务名称(getTasksByName等方法唯一标示)
  • TASK_DESCRIPTION: 任务描述
  • TASK_TYPE: 任务类型(例如type: Jar表示是JarTask的子类,默认是DefaultTask)
  • TASK_DEPENDES_ON: 指定执行上游依赖的任务
  • TASK_OVERWRITE: 覆盖取代指定的任务
  • TASK_ACTION: 任务进行执行的具体动作

为什么要把task这几个属性特意拿出来说一下,是因为这是跟后面的task创建中Map<String, ?> args创建参数是一一对应的,不清楚则会对于这个参数需要添加什么会很疑惑。

方法

task涉及的方法主要分为两个类,添加对应执行的action以及配置对应的执行ordering relationship

action closure

task添加action动作主要涉及三个方法,分别是:

Task doFirst(Closure action)
Task doFirst(Action<? super Task> action)

Task doLast(Closure action)
Task doLast(Action<? super Task> action)

void onlyIf(Closure onlyIfClosure)
void onlyIf(Spec<? super Task> onlyIfSpec)

其中,doFirstdoLast应该很熟悉,常常用到在hook住对应的task后,通过这两个方法分别在task原本动作执行前和执行后添加相应的action动作。
onlyIf有点特殊,是在任务execute time而不是跟上述两个一样在configuration time进行评估,并且如果Spec<? super Task>返回truetask只会覆盖执行onlyIf中配置的closure,返回falsetask会直接skipped不再执行。

ordering relationship

对应task添加执行顺序关系也是主要涉及三个方法,分别是:

Task mustRunAfter(Object... paths);

Task finalizedBy(Object... paths);

TaskDependency shouldRunAfter(Object... paths);

finalizedBy也是比较熟悉常用的方法,用来指定task执行完后续衔接的任务。
mustRunAftershouldRunAfter从字面意思就能看出用来指定task需要在其后进行执行的任务,这个和dependsOn的区别在于,dependsOn具体指定了两个任务之间的依赖关系,而mustRunAftershouldRunAfter只是描述两个任务之间的顺序,但没有强制依赖。换句话说,例如:

taskY.dependsOn taskX

task taskY {
     mustRunAfter "taskX"
}

dependsOntaskY一定会在taskX之后执行,而用mustRunAftershouldRunAfter则不一定。

创建

任务主要是由org.gradle.api.Project来负责创建,对应的方法分别是:

Task task(String name) throws InvalidUserDataException;

Task task(Map<String, ?> args, String name) throws InvalidUserDataException;

Task task(Map<String, ?> args, String name, Closure configureClosure);

Task task(String name, Closure configureClosure);

归根结底就是不同参数的重载方法,这里的Map<String, ?> args中的key对应的就是上述提到的task的属性字符了。

  1. 通过闭包配置的方式来进行创建
task smapleTask(type: Jar, group: 'athena'){Jar it->
    ...
}

这里typegroup对应的就是task的两个属性。

  1. 代码块创建
project.task('smapleTask', group: 'athena', type: Jar) { Jar it->
    ...
}

换成java代码块就是如此,跟上述闭包配置的方式实际是调用了同一个方法,也就是:

Task task(Map<String, ?> args, String name, Closure configureClosure);

尾结

最后补充一下前面提到的只能在 configure期间添加任务到编译链条中的问题,也就是说如果在task的执行内容中添加task或者指定dependsOn是无效的,只能在project configure期间,例如:

project.tasks.whenTaskAdded{ Task task ->
    ...
}

好了,task就说到这里了,下章来说说plugin的开发。

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

推荐阅读更多精彩内容