0
点赞
收藏
分享

微信扫一扫

【Android Gradle 插件】自定义 Gradle 任务 ⑪ ( Gradle 任务分组 | 为自定义 Gradle 任务指定分组 | 为自定义 Gradle任务指定任务描述 | 代码示例 )


文章目录

  • ​​一、Gradle 任务分组​​
  • ​​二、为自定义 Gradle 任务指定分组 ( DefaultTask#setGroup 函数 | DefaultTask#getGroup 函数 )​​
  • ​​三、为自定义 Gradle 任务指定任务描述 ( DefaultTask#setDescription函数 )​​
  • ​​四、代码示例​​

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​​





一、Gradle 任务分组


每个 Gradle 任务都有一个任务分组 , 下图中的

  • android
  • build
  • cleanup
  • help
  • install
  • other
  • verification

等分组 , 是 Gradle 自带分组 , 自定义的 Gradle 任务 默认放置在 other 分组 中 ;

【Android Gradle 插件】自定义 Gradle 任务 ⑪ ( Gradle 任务分组 | 为自定义 Gradle 任务指定分组 | 为自定义 Gradle任务指定任务描述 | 代码示例 )_android studio






二、为自定义 Gradle 任务指定分组 ( DefaultTask#setGroup 函数 | DefaultTask#getGroup 函数 )


org.gradle.api.DefaultTask 配置 ( Gradle 自定义任务类父类 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html​​



在 DefaultTask 类中 , 维护了一个 group 属性 , 该属性表示了该 Gradle 任务的分组 ,

通过 DefaultTask#setGroup 函数 , 可以 设置 该 Gradle 任务的分组 ,

通过 DefaultTask#getGroup 函数 , 可以 获取 该 Gradle 任务的分组 ;



DefaultTask#getGroup 函数原型 :

public String getGroup()

Description copied from interface: Task
Returns the task group which this task belongs to. task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user.
从接口复制的描述:任务
返回此任务所属的任务组。
在向用户显示任务列表时,任务组在报告和用户界面中用于将相关任务分组在一起。

Specified by:
getGroup in interface Task
接口Task中的getGroup

Overrides:
getGroup in class org.gradle.api.internal.AbstractTask
org.gradle.api.internal.AbstractTask 中的getGroup

Returns:
The task group for this task. be null.

文档地址 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html#getGroup–​​



DefaultTask#setGroup 函数原型 :

public void setGroup(String group)

Description copied from interface: Task
Sets the task group which this task belongs to. task group is used in reports and user interfaces to group related tasks together when presenting a list of tasks to the user.
从接口复制的描述:任务
设置此任务所属的任务组。
在向用户显示任务列表时,任务组在报告和用户界面中用于将相关任务分组在一起。

Specified by:
setGroup in interface Task
接口Task中的setGroup

Overrides:
setGroup in class org.gradle.api.internal.AbstractTask
org.gradle.api.internal.AbstractTask 中的setGroup

Parameters:
group - The task group for this task. be null.

文档地址 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html#setGroup-java.lang.String-​​






三、为自定义 Gradle 任务指定任务描述 ( DefaultTask#setDescription函数 )


org.gradle.api.DefaultTask 配置 ( Gradle 自定义任务类父类 ) 文档 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html​​



在 DefaultTask 类中 , 维护了一个 description 属性 , 该属性表示了该 Gradle 任务的描述 ,

通过 DefaultTask#setDescription 函数 , 可以 设置 该 Gradle 任务的任务描述 ;



DefaultTask#setDescription函数原型 :

public void setDescription(String description)

Description copied from interface: Task
Sets a description for this task. should describe what the task does to the user of the build. description will be displayed when gradle tasks is called.
从接口复制的描述:任务
设置此任务的说明。
这应该描述任务对构建用户的作用。
调用分级任务时,将显示描述。


Specified by:
setDescription in interface Task
接口Task中的setDescription

Overrides:
setDescription in class org.gradle.api.internal.AbstractTask
org.gradle.api.internal.AbstractTask 中的 setDescription

Parameters:
description - The description of the task. be null.

文档地址 : ​​https://docs.gradle.org/current/javadoc/org/gradle/api/DefaultTask.html#setDescription-java.lang.String-​​






四、代码示例


自定义人物类 MyTask , 在其构造函数中 , 指定 group 属性 和 description 属性 , 其中

  • group 属性 : 设置 自定义 Gradle 任务的分组 ;
  • description 属性 : 设置 自定义 Gradle 任务的描述 ;


代码示例 :

/**
* 自定义任务类
*/
class MyTask extends DefaultTask {

MyTask() {
// 设置该任务属于 MyTaskGroup 分组
group 'MyTaskGroup'
description 'MyTask Description'
}

/**
* 使用 @TaskAction 注解指定任务需要执行的方法
*/
@TaskAction
void run() {
println 'MyTask'
}
}

/*
生成自定义 Gradle 任务
*/
task myTask(type: MyTask){
}

重新构建代码后 , 在 Gradle 面板中没有显示该自定义的 Gradle 任务 :

【Android Gradle 插件】自定义 Gradle 任务 ⑪ ( Gradle 任务分组 | 为自定义 Gradle 任务指定分组 | 为自定义 Gradle任务指定任务描述 | 代码示例 )_gradle_02


但是 , 在 Terminal 面板中 , 执行

gradlew :app:task --all

命令 , 可以输出所有的 Gradle 任务分组以及分组下的任务 和 任务描述 ;

【Android Gradle 插件】自定义 Gradle 任务 ⑪ ( Gradle 任务分组 | 为自定义 Gradle 任务指定分组 | 为自定义 Gradle任务指定任务描述 | 代码示例 )_android_03


举报

相关推荐

0 条评论