前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >【Android Gradle 插件】自定义 Gradle 任务 ⑩ ( 自定义任务类继承 DefaultTask 类 | TaskContainer#create 函数创建任务 | 生成自定义任务)

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

作者头像
韩曙亮
发布2023-03-30 17:07:34
7830
发布2023-03-30 17:07:34
举报
文章被收录于专栏:韩曙亮的移动开发专栏

文章目录

Android Plugin DSL Reference 参考文档 :

一、自定义 Task 类继承 DefaultTask 类


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

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

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

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

代码语言:javascript
复制
/**
 * 自定义任务类
 */
class MyTask extends DefaultTask {

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

二、TaskContainer#create 函数创建任务


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

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

TaskContainer#create 函数原型 :

代码语言:javascript
复制
<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-

代码示例 :

代码语言:javascript
复制
/**
 * 自定义任务类
 */
class MyTask extends DefaultTask {

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

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

调用了 tasks.create 函数之后 , 就在 Gradle 面板中生成了 myTask 任务 ,

在这里插入图片描述
在这里插入图片描述

也可以在 Terminal 面板中 , 执行

代码语言:javascript
复制
gradlew :app:myTask 

命令 , 执行结果如下 :

在这里插入图片描述
在这里插入图片描述

三、生成自定义 Gradle 任务


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

代码语言:javascript
复制
/*
    生成自定义 Gradle 任务
 */
task myTask(type: MyTask){
}

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

在这里插入图片描述
在这里插入图片描述
本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022-09-22,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 文章目录
  • 一、自定义 Task 类继承 DefaultTask 类
  • 二、TaskContainer#create 函数创建任务
  • 三、生成自定义 Gradle 任务
相关产品与服务
容器服务
腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档