Gradle随记---渐入

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

属性

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

public interface Task extends Comparable, 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 args创建参数是一一对应的,不清楚则会对于这个参数需要添加什么会很疑惑。

方法

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

action closure

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

Task doFirst(Closure action)
Task doFirst(Action action)

Task doLast(Closure action)
Task doLast(Action action)

void onlyIf(Closure onlyIfClosure)
void onlyIf(Spec onlyIfSpec)

其中,doFirstdoLast应该很熟悉,常常用到在hook住对应的task后,通过这两个方法分别在task原本动作执行前和执行后添加相应的action动作。
onlyIf有点特殊,是在任务execute time而不是跟上述两个一样在configuration time进行评估,并且如果Spec返回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 args, String name) throws InvalidUserDataException;

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

Task task(String name, Closure configureClosure);

归根结底就是不同参数的重载方法,这里的Map 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 args, String name, Closure configureClosure);

尾结

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

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

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

你可能感兴趣的:(Gradle随记---渐入)