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

企业开发 2022-09-26 21:43:59 阅读次数: 0

文章目录

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.AbstractTask
类 org.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.AbstractTask
类 org.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.AbstractTask
类 org.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 任务分组以及分组下的任务 和 任务描述 ;

在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/han1202012/article/details/126996839
今日推荐
美国拟限制 AI 大模型出口中国和俄罗斯
苹果将与 OpenAI 达成协议，将 ChatGPT 应用于 iPhone
openKylin 社区生态委员会第六次会议圆满召开
阿里云正式发布通义千问 2.5
Python 3.13 发布首个 Beta：实验性自由线程模式和 JIT、改进交互式解释器
Stack Overflow 拿我的代码去训练 AI 大模型，还封了我的账号
Pop!_OS 的 COSMIC 桌面完成 App Store 上架工作
报告：Django 仍然是 74% 开发者的首选
《2024 年一季度互联网投融资运行情况》研究报告
15 年前上了“FFmpeg 耻辱柱”，今天他还得谢谢咱——腾讯QQPlayer一雪前耻？
TIOBE 5 月榜单：Fortran “复活”进入 Top 10
GCC 14.1 发布
周排行
NEFU 117 素数个数的位数
Closest Common Ancestors (Lca,tarjan)
ELK部署
【转载】Hive笔记整理（三）
SQL语句（一）基本表的定义
关于Java web开发中的MySQL的事务语句
MFC创建自定义窗体
如何用一句话激怒程序员？
《逆袭大学》文摘——9.4 基础和应用的平衡中找到大学的节奏
【spring源码分析】@Value注解原理
每日归档
更多
2024-05-11(38)
2024-05-10(38)
2024-05-09(35)
2024-05-08(42)
2024-05-07(14)
2024-05-06(40)
2024-05-05(0)
2024-05-04(7)
2024-05-03(19)
2024-05-02(0)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022