android开发中自定义gradle plugin

时间:2021-6-3 作者:qvyue

  在android studio中gradle作为主要的构建工具,其核心工作任务在于执行一系列的Task。而plugin在gradle构建过程又扮演着举足轻重的角色,有时为了完成相应的构建任务必须通过引入相应的插件来辅助,这些插件中定义了构建Project需要的一系列Task,并且负责执行相应的Task,比如构建android应用’com.android.application’,构建Library的’com.android.library’。

  除了系统自带的插件外,有时候我们也需要开发属于我们自己的plugin,比如热修复,插件化开发中基本上都有可能会去自定义插件。

自定义插件主要有三种方式:

1、直接在module的build.gradle中开发
2、创建当前项目使用的插件
3、创建通用的插件,发布到maven

方式一、build.gradle中开发

在我们自己的module的build.gradle中编写代码

apply plugin: 'com.android.application'

apply plugin: HelloPlugin

class HelloPlugin implements Plugin{
    @Override
    void apply(Project project) {
        project.task('testPlugin') 

上面我们自定义了一个名为HelloPlugin的插件,然后其中定义了testPlugin的task。
下面我们测试下看看效果,在Terminal中执行gradle testPlugin命令

android开发中自定义gradle plugin
image.png

方式二、创建当前项目使用的插件

1、新建一个类型为Android Library的Module,名字为buildsrc,注意这个名字只能为buildsrc,如果不是这个名称,这里是无法apply包名的,会提示找不到。

2、除build.gradle,src/main外,其他文件都删除掉,删除main下的文件。

3、在src/main下新建groovy文件夹。

4、在groovy文件夹下新建package,包名随便取,例如com.build.src。

5、在package下创建.groovy的文件,例如PluginDemoTest.groovy。

android开发中自定义gradle plugin
工程结构目录.png

PluginDemoTest.groovy的内如为如下:

package com.build.src
import org.gradle.api.Plugin
import org.gradle.api.Project

public class PluginDemoTest implements Plugin {

    @Override
    void apply(Project project) {
        project.logger.error("==========定义插件开始运行了===========")
        //这里加一个简单的task
        project.task('test-task') 
应用自定义plugin

在同工程的其他module的build.gradle中应用这插件
apply plugin: com.build.src.PluginDemoTest
运行控制台中执行gradle test-task

android开发中自定义gradle plugin
应用插件运行结果.png

方式三、创建通用的插件,发布到maven

1、创建module

[1] 选择Android Library类型,名称可以随便定义了,比如:PluginDemo

[2] 将Module里面的内容删除,只保留build.gradle文件和src/main目录。

[3]在main目录下新建groovy目录

[4]在groovy目录下新建package,包名随便取,比如:com.plugin.demo

[5]在com.plugin.demo包下创建.groovy文件,比如MyPluginDemo.groovy,需要实现org.gradle.api.Plugin接口,代码如下:

package com.plugin.demo
import org.gradle.api.Plugin
import org.gradle.api.Project
public class MyPluginDemo implements Plugin {

    @Override
    void apply(Project project) {

        println "hello, this is test plugin!"
     
        project.task('plugin-task') 

[6] 定义插件的类创建好后,需要我们去定义使用插件时的名称,在src/main 目录下创建resources目录,然后在resources目录下再新建META-INF目录,再在META-INF里面新建gradle-plugins目录。最后在gradle-plugins目录里面新建.properties文件,文件的名称可以随意取名 ,比如为com.plugin.gradle.properties,后面应用的时候就是apply plugin: ‘com.plugin.gradle’.
properties里面的内容为指定我们自定义的类
implementation-class=com.plugin.demo.MyPluginDemo

[7]编写build.gradle,我们最后要打包到maven,所以需要用到maven插件,内容为:

apply plugin: 'groovy'
apply plugin: 'maven'

repositories {
    mavenCentral()
}

dependencies {
    compile gradleApi()  //gradle sdk
    compile localGroovy()    //groovy sdk
}

这样我们的plugin工程目录都创建完成了,如下图

android开发中自定义gradle plugin
插件工程目录结构.png
2、利用mavenDeployer发布插件

  自定义插件开发好后,我们可以发布到Maven库里面去,可以选择发布到本地也可以选择发布到远程服务器中。在我们自定义Module目录下的build.gradle添加如下代码:

//设置maven deployer
uploadArchives {
    repositories {
        mavenDeployer {
            pom.project {
                groupId 'com.plugin.demo' //决定jar文件生成的目录
                artifactId 'plugin-test'  //模块的名称
                version '1.0.0'  //指定版本号
                description project.description ?:''
                packaging 'jar'
            }
            //文件发布到下面目录
            repository(url: uri('../release'))
            //发布到远程服务端
            // repository(url: "http://www.xxx.com/repos") {
            // authentication(userName: "xxx", password: "xxx")
            // }
        }
    }
}

执行uploadArchives这个task,点击AndroidStudio右侧的gradle工具,具体操作如下图:

android开发中自定义gradle plugin
maven打包.png

双击这个task之后,就在本地目录下生成相应的jar包,生成结果请看下图:

android开发中自定义gradle plugin
maven打包后文件生成图.png

在build.gradle中我们配置的maven本地仓库路径是release,故生成的文件都在release目录下。

3、定义plugin的应用

  插件开发包生成完成后,就是实战应用了,首先需要先引入maven仓库以及生成的插件jar,其实跟我们使用ButterKnife需要在工程的build.gradle中配置ButterKnife插件依赖是一样的道理,我们这里将其配置到module的build.gradle里,也就是说只有这个module可以使用这个插件包。其次,就是应用具体的plugin,也就是apply plugin:xxx,具体的配置如下:

//com.plugin.gradle为resources/META-INF/gradle-plugins下的properties文件名称
apply plugin: 'com.plugin.gradle'
buildscript {
    repositories {
        maven {
            //本地Maven仓库地址
            //这里是发布在本地文件夹了
            url uri('../release')
        }
    }
    dependencies {
        //格式为 groupId:artifactId:version
        classpath 'com.plugin.demo:plugin-test:1.0.0'
    }
}

执行gradle plugin-task 结果如下

android开发中自定义gradle plugin
应用插件执行结果.png

以上便是自定义插件的三种方式,一般而言第三种方式最常用,实用性比较强。

声明:本文内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:qvyue@qq.com 进行举报,并提供相关证据,工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。