【Android Gradle 插件】自定义 Gradle 任务 ⑩ ( 自定义任务类继承 DefaultTask 类 | TaskContainer#create 函数创建任务 | 生成自定义任务)

企业开发 2022-09-26 21:44:01 阅读次数: 0

文章目录

Android Plugin DSL Reference 参考文档 :





一、自定义 Task 类继承 DefaultTask 类


Gradle 任务就是一个 Task 类 , 在 Gradle 脚本中 , 可以 自定义 Task 类 ,

自定义任务类 , 需要继承 DefaultTask 类 ,

并且 使用 @TaskAction 注解 指定任务需要执行的方法 ;


代码示例 : 下面自定义的 MyTask 任务类中 , 任务内容是 执行 run 方法 ;

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

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




二、TaskContainer#create 函数创建任务


在 Project 中 , 维护了一个 TaskContainer 类型的任务容器 tasks , 其包含了所有的 Gradle 任务 ,

调用 TaskContainer 任务容器的 create 函数 , 创建一个 MyTask 任务 , 传入的第一个参数是任务名称 , 第二个参数是任务类型 ;


TaskContainer#create 函数原型 :

<T extends Task> T create​(String name,
                          Class<T> type)
                   throws InvalidUserDataException
                   
Creates a Task with the given name and type, and adds it to this container.
使用给定的名称和类型创建Task，并将其添加到此容器中。

After the task is added, it is made available as a property of the project, so that you can reference the task by name in your build file.
添加任务后，它将作为项目的属性提供，以便您可以在生成文件中按名称引用该任务。

Specified by:
在接口 PolymorphicDomainObjectContainer<Task> 中创建

Type Parameters:
T - the type of the domain object to be created
    要创建的域对象的类型
Parameters:
name - The name of the task to be created.
       要创建的任务名称
type - The type of task to create.
       要创建的任务类型
Returns:
The newly created task object
最新创建的任务对象

Throws:
InvalidUserDataException - If a task with the given name already exists in this project.
                           如果此项目中已存在具有给定名称的任务。
See Also:
More information about how tasks are exposed by name in build scripts
有关如何在生成脚本中按名称公开任务的详细信息

文档地址 : https://docs.gradle.org/current/javadoc/org/gradle/api/tasks/TaskContainer.html#create-java.lang.String-java.lang.Class-


代码示例 :

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

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

/*
    Project # tasks 是任务容器 , 其包含了所有的 Gradle 任务
    可以调用该任务容器的 create 方法创建一个 MyTask 任务
    传入的第一个参数是任务名称 , 第二个参数是任务类型
 */
tasks.create('myTask', MyTask)

调用了 tasks.create 函数之后 , 就在 Gradle 面板中生成了 myTask 任务 ,
在这里插入图片描述

也可以在 Terminal 面板中 , 执行

gradlew :app:myTask

命令 , 执行结果如下 :

在这里插入图片描述





三、生成自定义 Gradle 任务


除了使用 TaskContainer#create 函数创建任务之外 , 还可以使用

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

的方式生成 自定义 Gradle 任务 , 两种方式是等价的 ;

在这里插入图片描述

猜你喜欢

转载自blog.csdn.net/han1202012/article/details/126988907
今日推荐
美国拟限制 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