Android学习笔记第1章 Android应用和开发环境 1.2 使用Gradle自动化构建项目 1.2.7 自定义任务

谁践踏了优雅 2024-03-25 21:17 22阅读 0赞

#### Android学习笔记 ####

#### 文章目录 ####

*   *   *  Android学习笔记
         *  第1章 Android应用和开发环境
         *   *  1.2 使用Gradle自动化构建项目
             *   *  1.2.7 自定义任务

> 疯狂Android讲义

#### 第1章 Android应用和开发环境 ####

##### 1.2 使用Gradle自动化构建项目 #####

###### 1.2.7 自定义任务 ######

自定义任务就是一个实现Task接口的Groovy类，该接口定义了大量抽象方法需要实现，因此一般自定义任务类会继承DefaultTask基类。

自定义任务的Groovy类可以自定义多个方法，这些方法可作为Action使用。

自定义任务的Groovy类既可直接定义在build.gradle文件中，也可使用专门的Groovy源文件定义。

下面先直接在build.gradle文件中定义一个自定义任务类。

// 继承DefaultTask定义自定义任务类
    class HelloWorldTask extends DefaultTask{
        
        @Optional
        def message = '疯狂软件教育中心'
    
        // 使用@TaskAction 修饰的方法被自动当成Action
        @TaskAction
        def test(){
        
            println "test: $message"
        }
        def info(){
        
            println "info: $message"
        }   
    }
    
    task hello(type: HelloWorldTask){
        
        doLast{
        
            info()
        }
    }
    
    task hello1(type: HelloWorldTask){
        
        message = '疯狂Java联盟'
    }

上面代码定义了一个Hello WorldTask类，该类继承了DefaultTask基类，这就是一个自定义任务类。

该自定义任务类可以定义属性作为任务属性，也可以定义方法作为Action,使用@TaskAction修饰的方法将会被自动添加为该任务的Action。

接下来构建文件定义了hello和hellol两个任务，这两个任务的类型都是Hello WorldTask,其中hello任务没有为message属性指定值，因此该属性将使用默认值；hello1任务为message属性重新指定了值，因此该属性将会使用新值。

HelloWorldTask类使用@TaskAction修饰了test方法，因此该方法将会被添加成该任务的Action;而info方法并未使用@TaskAction修饰，因此需要使用doLast或doFirst方法手动将它添加成Action;否则，该方法不会被执行。

执行上面的hello任务，将会看到如下输出。

![在这里插入图片描述][07f02ea8ef594e8099285fae56fead9d.png_pic_center]

> e，好像昨天晚上配置的东西生效了？现在中文不乱码了

执行上面的hello1任务，将会看到如下输出。

![在这里插入图片描述][45a82ee000eb4382b7f3fd78ba7a5515.png_pic_center]

从上面的输出结果可以看出，在执行hello1任务时，只有test方法（有@TaskAction修饰）执行，并未看到info方法执行。

上面这种自定义任务的方式虽然简单，但会使得自定义任务类被直接放在build.gradle文件中，从而导致build…gradle文件比较混乱。

当自定义任务较少且比较简单时，可以采用这种方式，但是当自定义任务较多或比较复杂时，建议采用专门的Groovy源文件来自定义任务。

自定义任务的源代码属于项目构建的源代码，因此Gradle约定将这些源代码放在buildSrc目录下。buildSrc目录就相当于另一个Gradle项目，Gradle执行时会先构建buildSrc目录下的Groovy源代码以供build.gradle文件使用。

> 【小贴士】buildSre目录相当于另一个Gradle项目，因此在该目录下还会包含src、build目录。在src目录下也需要定义main子目录，在main子目录下使用groovy子目录保存Groovy源代码。

试试

在buildSrc\\src\\main\\groovy\\org\\dingjiaxiongjava目录下添加如下自定义任务的Groovy类。

package org.dingjiaxiongjava;
    
    import org.gradle.api.*
    import org.gradle.api.tasks.*
    
    class ShowTask extends DefaultTask{
        
        @Optional
        File file = new File('dist.txt')
        
        @TaskAction
        def show(){
        
            println file.text
        }
    
        // @TaskAction 注解用于把该方法标注为默认执行的Action
        @TaskAction
        def multiShow(){
        
            println "-------------"
            println file.text
            println "-------------"
        }
    }

![在这里插入图片描述][a376ae3c7b0849cca90c85119ad66d68.png_pic_center]

上面的自定义任务类同样继承了DefaultTask,并包含两个使用@TaskAction修饰的Action方法。

从该代码可以看出，将自定义任务类直接放在build.gradle文件中和单独放在Groovy源文件中并没有区别。

由于上面的自定义任务类指定了包名，因此在build.gradle中为任务指定类型时也需要指定包名。例如，如下构建代码使用了上面的ShowTask。

// 使用Groovy文件中的task
    task show(type: org.dingjiaxiongjava.ShowTask)
    
    // 使用Groovy文件中的task
    task show1(type: org.dingjiaxiongjava.ShowTask){
        
        // 对file属性赋值
        file = file("D:/GradleLoggerTest.java")
    }

![在这里插入图片描述][9e16dad775d54e359b6e6820e20a63d8.png_pic_center]

![在这里插入图片描述][a6181547fed94ea6b5851a54eb390b6a.png_pic_center]

上面的构建代码定义的show和show1两个任务的类型都是org.dingjiaxiongjava.ShowTask,其中show任务没有为file属性指定初始值，因此执行该任务将会打印项目根路径下dist.txt文件的内容：show1任务的file属性被指定为D:/GradleLoggerTest.java文件，因此执行该任务将会打印D盘中LoggerTest.java文件的内容。

![在这里插入图片描述][2b685f49d93e4fadba19e3ba532bcf91.png_pic_center]

这是读取的默认dist.txt 文件内容

![在这里插入图片描述][de802f149ff84c8eba5365be18709491.png_pic_center]

没毛病。

[07f02ea8ef594e8099285fae56fead9d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/82603c3c80204c9f868a58cecdec3763.png
[45a82ee000eb4382b7f3fd78ba7a5515.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/6496c68431e74fab8a29a64c64a06e96.png
[a376ae3c7b0849cca90c85119ad66d68.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/3564b67e6fe046b1a516996a45e1d8f5.png
[9e16dad775d54e359b6e6820e20a63d8.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/00b30dff84974496958585d567a4e973.png
[a6181547fed94ea6b5851a54eb390b6a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/e0cb3629817d4fb89ec6712ffa1481b8.png
[2b685f49d93e4fadba19e3ba532bcf91.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/9501667ba40d4c1ca068bc5ea02722b4.png
[de802f149ff84c8eba5365be18709491.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/c00400799ab14b1aa8b8764489d24a63.png