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

文章目录

• ​​一、TaskOutputs#upToDateWhen 设置重复任务是否执行​​
• ​​二、Gradle 预置任务​​

Android Plugin DSL Reference 参考文档 :

• Android Studio 构建配置官方文档 : ​​https://developer.android.google.cn/studio/build​​
• 添加构建依赖项 参考文档 : ​​https://developer.android.google.cn/studio/build/dependencies​​
• Android Gradle 插件配置与 Gradle 配置关联 : 【Android Gradle 插件】Gradle 依赖管理 ① ( org.gradle.api.Project 配置 | Android Gradle 插件配置与 Gradle 配置关联 ) ★
• Android Gradle 插件文档主页 : ​​https://google.github.io/android-gradle-dsl/2.3/​​
• BaseExtension 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.BaseExtension.html​​
• AppExtension ( build.gradle#android 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.AppExtension.html​​
• build.gradle#android 模块配置文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.AppExtension.html​​
• ProductFlavor ( build.gradle#android#defaultConfig 配置 ) 文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.ProductFlavor.html​​
• ProductFlavor#externalNativeBuild 配置 ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) : ​​com.android.build.gradle.internal.dsl.ProductFlavor:externalNativeBuild​​
• ExternalNativeBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.ExternalNativeBuildOptions.html​​
• NdkBuildOptions ( build.gradle#android#defaultConfig#externalNativeBuild#ndkBuild 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.NdkBuildOptions.html​​
• CmakeOptions ( build.gradle#android#defaultConfig#externalNativeBuild#cmake 配置 ) 文档位置 : ​​android-gradle-dsl-gh-pages/2.3/com.android.build.gradle.internal.dsl.CmakeOptions.html​​
• JackOptions ( build.gradle#android#defaultConfig#jackOptions 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.JackOptions.html​​
• AnnotationProcessorOptions ( 注解处理器配置 ) ( build.gradle#android#defaultConfig#javaCompileOptions配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AnnotationProcessorOptions.html​​
• NdkOptions ( build.gradle#android#defaultConfig#ndk 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.NdkOptions.html​​
• NDK 参考文档 : ​​Add C and C++ Code to Your Project.​​
• VectorDrawablesOptions ( build.gradle#android#defaultConfig#vectorDrawables 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.VectorDrawablesOptions.html​​
• BuildType ( build.gradle#android#buildTypes 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.BuildType.html​​
• SigningConfig ( build.gradle#android#signingConfigs 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.SigningConfig.html​​
• AaptOptions ( build.gradle#android#aaptOptions 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AaptOptions.html​​
• AndroidSourceSets ( build.gradle#android#sourceSets 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceSet.html​​
• AndroidSourceDirectorySet ( build.gradle#android#sourceSets#aidl/assets/java/jni/jniLibs 配置 ) 文档位置 :​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceDirectorySet.html​​
• AndroidSourceFile ( build.gradle#android#sourceSets#manifest 配置 ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.api.AndroidSourceFile.html​​
• DataBindingOptions ( build.gradle#android#dataBinding ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DataBindingOptions.html​​
• DexOptions ( build.gradle#android#dexOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DexOptions.html​​
• LintOptions ( build.gradle#android#lintOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LintOptions.html​​
• PackagingOptions ( build.gradle#android#packagingOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.PackagingOptions.html​​
• Splits ( build.gradle#android#splits ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.Splits.html​​
• AbiSplitOptions ( build.gradle#android#splits#abi ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.AbiSplitOptions.html​​
• LanguageSplitOptions ( build.gradle#android#splits#language ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.LanguageSplitOptions.html​​
• DensitySplitOptions ( build.gradle#android#splits#density ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.DensitySplitOptions.html​​
• TestOptions ( build.gradle#android#testOptions ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.html​​
• Android 测试相关文档 : ​​https://developer.android.google.cn/training/testing​​
• UnitTestOptions ( build.gradle#android#testOptions#unitTests ) 文档位置 : ​​android-gradle-dsl/2.3/com.android.build.gradle.internal.dsl.TestOptions.UnitTestOptions.html​​
• org.gradle.api.tasks.testing.Test 单元测试配置类 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/testing/Test.html​​
• LibraryExtension ( Library 依赖库的 build.gradle#android 配置 ) 文档 : ​​android-gradle-dsl/2.3/com.android.build.gradle.LibraryExtension.html​​
• org.gradle.api.Project 配置 ( build.gradle 根配置 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/Project.html​​
• org.gradle.api.artifacts.dsl.DependencyHandler 配置 ( build.gradle#dependencies#implementation 配置 ) : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/artifacts/dsl/DependencyHandler.html​​
• 添加构建依赖项 参考文档 : ​​https://developer.android.google.cn/studio/build/dependencies​​
• org.gradle.api.Task 配置 ( Gradle 任务类型 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/Task.html​​
• org.gradle.api.tasks.TaskContainer配置 ( Gradle 任务容器类型 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/TaskContainer.html​​
• org.gradle.api.DefaultTask 配置 ( Gradle 自定义任务类父类 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html​​
• org.gradle.api.tasks.Delete 配置 ( clean 任务类型 ) 文档 : ​​https://docs.gradle.org/current/dsl/org.gradle.api.tasks.Delete.html​​
• Gradle 自带任务查询界面 ( 搜索 Task Types ) : ​​https://docs.gradle.org/current/dsl/#N1045C​​

一、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​​ , 在该界面中 , 可以查看所有的官方定义的任务类型 ;