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

Posted 韩曙亮

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Android Gradle 插件自定义 Gradle 任务 ⑪ ( Gradle 任务分组 | 为自定义 Gradle 任务指定分组 | 为自定义 Gradle任务指定任务描述 | 代码示例 )相关的知识,希望对你有一定的参考价值。

文章目录

Android Plugin DSL Reference 参考文档 :





一、Gradle 任务分组



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

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

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





二、为自定义 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. 
The 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.AbstractTaskorg.gradle.api.internal.AbstractTask 中的getGroup

Returns:
The task group for this task. Might 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. 
The 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.AbstractTaskorg.gradle.api.internal.AbstractTask 中的setGroup

Parameters:
group - The task group for this task. Can 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. 
This should describe what the task does to the user of the build. 
The 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.AbstractTaskorg.gradle.api.internal.AbstractTask 中的 setDescription

Parameters:
description - The description of the task. Might 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 任务 :


但是 , 在 Terminal 面板中 , 执行

gradlew :app:task --all

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

以上是关于Android Gradle 插件自定义 Gradle 任务 ⑪ ( Gradle 任务分组 | 为自定义 Gradle 任务指定分组 | 为自定义 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 插件的扩展配置扩展 | 在自定义插件中获取扩展属性 )