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

╰+哭是因爲堅強的太久メ 2024-03-25 21:17 17阅读 0赞

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

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

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

> 疯狂Android讲义

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

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

###### 1.2.8 自定义插件 ######

所谓自定义插件，其实就是一个实现Plugin<Project>接口的类，实现该接口要求必须实现apply((Project project)方法，接下来就可以在该方法中为Project添加属性和定义任务了一正如前面所介绍的，所谓插件，无非就是为Project定义多个属性和任务，这样引入该插件后即可使用这些属性和任务。

> 【小贴士】
> 
> 项目的插件要实现Plugin<Project>接口，但实际上Plugin<T>是一个带泛型参数的接口，其中泛型T是可以动态变化的，因此Plugin<T>不仅可以为项目提供插件，也可以为其他类提供插件。

与自定义任务的Groovy类相同，自定义插件类既可被直接定义在build…gradle文件中，也可使用专门的Groovy源文件定义。

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

// 实现Plugin<Project>定义自定义插件类
    class FirstPlugin implements Plugin<Project>{
        
    
        // 重写接口中的apply方法
        void apply(Project project){
        
            
            // 为项目额外定义一个User类型的user属性
            project.extensions.create("user",User)
            // 调用task方法定义showName任务
            project.task('showName'){
        
                doLast{
        
                    println '用户名: ' + project.user.name
                }
            }
    
            // 调用tasks对象(TaskContainer) 的create方法定义showPass任务
            project.tasks.create('showPass'){
        
                doLast{
        
                    println '密码: ' + project.user.pass
                }
            }
        }
    }
    
    class User{
        
        String name = 'dingjiaxiongjava'
        String pass = 'dingjiaxiong'
    }

上面第一行代码定义了一个Plugin<Project>的实现类，这意味着该类就是一个自定义插件。

自定义插件需要重写apply方法，该方法中的Project形参就代表了引入插件的项目，因此apply方法中的`project.extensions.create("user",User)`代码用于为该项目扩展属性。此外，apply方法还为项目定义了两个任务。

需要说明的是，由于Gradle需要为插件定义的属性生成代理，因此为插件定义的属性类型不能是final类。所以，上面的User类没有使用final修饰。

接下来即可在构建文件中引入该插件。引入该插件之后，既可对插件扩展的属性赋值，也可直接调用插件为项目增加任务。例如如下构建代码。

// 引入FirstPlugin插件
    apply plugin: FirstPlugin
    
    // 为Project的user属性的name属性赋值
    user.name = '疯狂软件教育'

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

使用`gradle showName`命令调用插件定义的showName任务，可以看到如下输出。

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

使用`gradle showPass`命令调用插件定义的showPass任务，可以看到如下输出。

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

可以看到，上面在showPass输出时，输出了leegang,这是由于引入插件后没有为Project的user.pass属性赋值，因此直接使用默认值。

与自定义任务类似的是，自定义插件其实也应该使用专门的Groovy源文件定义，这些用于自定义插件的Groovy类也应该被放在buildSre目录下。

下面是本例自定义插件的Groovy类。

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

package org.dingjiaxiongjava;
    
    import org.gradle.api.*
    
    class ItemPlugin implements Plugin<Project>{
        
    
        // 重写接口中的apply方法
        void apply(Project project){
        
            // 为项目额外定义一个Item类型的item属性
            project.extensions.create("item",Item)
            //调用task方法定义showItem任务
            project.task('showItem'){
        
                doLast{
        
                    println '商品名: ' + project.item.name
                    println '商品销售价: ' + project.item.price * project.item.discount
                }
            }
        }
    }

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

上面的插件类同样实现了Plugin<Project>接口，并实现了该接口中的apply方法，而apply方法则可为项目添加属性和任务。

该插件只为项目额外定义了一个showItem任务。上面的插件类还使用了一个Item类，它是一个简单的Groovy类，代码如下。

class Item{
        
        String name = 'unknown item'
        double price = 0
        double discount = 1.0
    }

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

在定义好插件之后，接下来可以使用apply plugin引入该插件，该插件有包名，因此需要使用带包名的类名，并为该插件所扩展的项目属性赋值。构建代码如下。

// 引入org.dingjiaxiongjava.ItemPlugin插件
    apply plugin: org.dingjiaxiongjava.ItemPlugin
    // 为org.dingjiaxiongjava.ItemPlugin 插件所扩展的项目属性赋值
    item.name = '疯狂Android讲义'
    item.price = 108
    item.discount = 0.75

在引入该插件之后，接下来即可使用调用该插件定义的showItem任务了。使用`gradle showItem`命令执行showItem任务，可以看到如下输出。

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

妙啊

[bf3890289fa743de9b3ed41224f63111.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/0320d5538a58498b8d4754ad2711063e.png
[c10d8836afb24da6a1a8d96fea9974b2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/fc6f0c0b5b3d4988aff1ff3413286849.png
[859cdb36ee164ea78183872c470351ca.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/5335c98a38264f5c9de6cc567db5a027.png
[2a96a9fe01f54e5eb6fa7c504271a829.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/f29e0e47a3f04228927b626d21918cb9.png
[54015ca85dbb42e1a4d7f98edb7dde2d.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/06afa91e01de4d90b12d93e45fd2ba2f.png
[2c78418d2ef345a78108fd9345546496.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/25b45eeee7f440a4b8d44ccb9190ee35.png
[c07b13dd36c2446f9de3c517a878664c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/2045d84d2e334ec9b6c7213fbc0879a0.png