Android Gradle 插件自定义 Gradle 任务 ⑭ ( TaskOutputs#upToDateWhen 设置重复任务是否执行 | Gradle 预置任务 )

Posted 韩曙亮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android Gradle 插件自定义 Gradle 任务 ⑭ ( TaskOutputs#upToDateWhen 设置重复任务是否执行 | Gradle 预置任务 )相关的知识，希望对你有一定的参考价值。

文章目录

Android Plugin DSL Reference 参考文档 :





一、TaskOutputs#upToDateWhen 设置重复任务是否执行


在 DefaultTask 中的 任务输出 调用 TaskOutputs#upToDateWhen 方法 , 在传入的闭包参数中 , 返回值为 true 时 , 在编译时遇到该 自定义 Gradle 任务 , 如果 第二次执行 且 输入 / 输出 相同 , 会跳过该任务 , 执行下一个任务 ;

// 设置第二次执行时是否跳过
// true 跳过
// false 不跳过
outputs.upToDateWhen 
    true

如果在 TaskOutputs#upToDateWhen 方法 传入的 闭包参数 的 返回值为 false , 无论执行多少次 , 无论任务输入 / 输出 是否相同 , 该任务都不会被跳过 , 强制执行 ;

// 设置第二次执行时是否跳过
// true 跳过
// false 不跳过
outputs.upToDateWhen 
    false

回顾 DefaultTask#outputs 方法调用 , 获取 任务输出 TaskOutputsInternal taskOutputs ;

DefaultTask#taskOutputs 可以通过在自定义的 DefaultTask 类中 , 通过调用 outputs 获取 , 实际上调用的是 DefaultTask#getOutputs 方法 ;

public class DefaultTask extends AbstractTask implements Task 
    public TaskInputsInternal getInputs() 
        return super.getInputs();
    

    public TaskOutputsInternal getOutputs() 
        return super.getOutputs();

DefaultTask#getOutputs 函数调用了 AbstractTask#getOutputs 方法 , 原型如下 :

public abstract class AbstractTask implements TaskInternal, DynamicObjectAware 
    private final TaskInputsInternal taskInputs;
    private final TaskOutputsInternal taskOutputs;

    public TaskInputsInternal getInputs() 
        return this.taskInputs;
    

    public TaskOutputsInternal getOutputs() 
        return this.taskOutputs;




二、Gradle 预置任务


除了自定义的 Gradle 任务之外 , Gradle 官方定义了一系列的预置的任务 , 如在 android 工程跟目录 build.gradle 构建脚本中定义的如下任务 ,

task clean(type: Delete) 
    delete rootProject.buildDir

clean 任务的类型就是 org.gradle.api.tasks.Delete 类型任务 , 其文档地址为 https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Delete.html ;

Delete 任务原型如下 :

public class Delete extends ConventionTask implements DeleteSpec 
    public Delete delete(Object... targets) 
        this.paths.from(targets);
        return this;

其中定义了 delete 方法 , 就是在 build.gradle 构建脚本中调用的方法 ;


在 Gradle 官方网站中 , 定义了一系列的 Task 任务类型 ,

可以在 https://docs.gradle.org/current/userguide/userguide.html 网站的搜索框中搜索 " Task Types " 任务类型 ,

然后可以定位到一个索引界面 https://docs.gradle.org/current/dsl/#N1045C , 在该界面中 , 可以查看所有的官方定义的任务类型 ;

以上是关于Android Gradle 插件自定义 Gradle 任务 ⑭ ( TaskOutputs#upToDateWhen 设置重复任务是否执行 | Gradle 预置任务 )的主要内容，如果未能解决你的问题，请参考以下文章

Android之Gradle的理解

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑤ ( 自定义插件中获定义方法 | 在插件中创建 Gradle 任务 | 代码示例 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑦ ( 自定义 Gradle 插件导入方式 | buildSrc 插件导入 | 构建脚本中自定义插件 | 独立文件 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ⑦ ( 自定义 Gradle 插件导入方式 | buildSrc 插件导入 | 构建脚本中自定义插件 | 独立文件 )

Android Gradle 插件自定义 Gradle 插件模块 ② ( 在模块中定义插件 | 引入自定义 Gradle 插件模块 | 配置 Gradle 插件上传选项 | 配置分组名称版本号 )

Android Gradle 插件Gradle 自定义 Plugin 插件 ④ ( 为自定义 Gradle 插件的扩展配置扩展 | 在自定义插件中获取扩展属性 )