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

Posted 韩曙亮

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Android Gradle 插件自定义 Gradle 任务 ⑩ ( 自定义任务类继承 DefaultTask 类 | TaskContainer#create 函数创建任务 | 生成自定义任务)相关的知识，希望对你有一定的参考价值。

文章目录

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 任务 , 两种方式是等价的 ;

以上是关于Android Gradle 插件自定义 Gradle 任务 ⑩ ( 自定义任务类继承 DefaultTask 类 | TaskContainer#create 函数创建任务 | 生成自定义任务)的主要内容，如果未能解决你的问题，请参考以下文章

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 插件的扩展配置扩展 | 在自定义插件中获取扩展属性 )