AndroidStudio自定义Gradle插件附源码地址

妖狐艹你老母 2022-05-31 04:05 232阅读 0赞

## 我们一起用AndroidStudio写一个自定义的Gradle插件吧 ##

*  注：这篇文章注重实际操作，插图丰富，易于理解上手。 对于理论知识的解释我自己也一头雾水，所以跟着我做就好啦。我也慢慢在学嘛
    
    [点这里github代码地址][github]

我把这个整个过程分为三部

1.  创建项目和插件，
2.  完善插件内容和配置，
3.  打包发布并且正确引用自定义插件

### 一.创建项目和插件 ###

我们写一个gradle插件是为了用在android项目中，我们先创建一个android项目起名字叫做DemoPlugin

![这里写图片描述][SouthEast]

那创建好项目好之后就要开始写插件了 ，可能会想是不是要去new一个xxxPlugin啊，可是我们会发现AndroidStudio中并没有这样后缀的项目正确的做法是 我们创建一个library类型的module 。那下面我的这个插件起名字叫kathiePlugin

![这里写图片描述][SouthEast 1]

![这里写图片描述][SouthEast 2]  
![这里写图片描述][SouthEast 3]

*  点击完finish之后。来看看是不是创建了这样一个插件呢，他的目录结构是图中红框的部分，

![这里写图片描述][SouthEast 4]

*  下一步我们要做的是删除kathiePlugin默认创建的部分文件 ，只留下部分的文件，其余全部删除了

![这里写图片描述][SouthEast 5]

那我们删了一些还要创建一些目标文件夹和文件

首先我们要在`src/main/`这个路径下创建两个文件夹

*  一个是`groovy/com/kathie/plugin`
 *  另外一个是`resources/META-INF/gradle-plugins`

注意⚠️ 这里的**目录名字**千万不能写错 。不然运行的时候就会找不到

![这里写图片描述][SouthEast 6]

基础的创建工作大概就完成了 下来就进入到完善插件内容和配置信息这部分

### 二. 完善插件内容和配置信息 ###

*  因为我们插件是用groovy语言写的（不用怕  
    我个人感觉和Java很像，而且不用会可以完成这篇教程，如果有深入研究的兴趣，可以自己找资料去看看）所以我们要把gradle改变一下成支持groovy的以及我们还要支持打包所以要用到maven。

把插件下的gradle中的内容全部删除，将下面这段代码复制进去

apply plugin: 'groovy'
    
    dependencies {
        compile gradleApi()
        compile localGroovy()
    }
    
    repositories {
        mavenCentral()
    }

![这里写图片描述][SouthEast 7]

*  下一步要在`com/kathie/plugin`新建一个`xxx.groovy`的文件，我们找不到后缀为groovy的创建步骤  
    这样就可以了（new->file->myPlugin.groovy ） 这个groovy名字可以随便起嘛？当然可以 不过这个名字后面有用到  
    我这里的groovy叫做`myPlugin.groovy`

我们这个groovy文件的目标是成为gradle的 需要实现`org.gradle.api.Plugin`的接口 ，`apply()`方法中是插件执行的逻辑，我这个插件只是输出了 五句相同的代码，代码如下

package com.kathie.plugin
    
    import org.gradle.api.Plugin
    import org.gradle.api.Project
    
    
    class myPlugin implements Plugin<Project>{
        
    
        @Override
        void apply(Project project) {
    
            println "-----------this is kethie plugin!----------"
            println "-----------this is kethie plugin!----------"
            println "-----------this is kethie plugin!----------"
            println "-----------this is kethie plugin!----------"
            println "-----------this is kethie plugin!----------"
    
    
        }
    }

![这里写图片描述][SouthEast 8]

我们创建了groovy 下来就要声明了

*  声明文件在目录`resources/META-INF/gradle-plugins`下，我们新建一个`xxx.properties`的文件  
    注意这个文件的名字是之后我们引用插件（apply）所需要的名字
 *  这个文件的内容就是指明我们自定义的类

`implementation-class=自定义的类的路径`

![这里写图片描述][SouthEast 9]

### 三.打包发布并且正确引用自定义插件 ###

*  前面我们已经自定义好了插件，下一步我们就要进行打包的过程了，我们需要在自定义插件的build.gradle里面指定打包的路径，版本号等参数信息代码指定好了之后我们需要编译一下  
    **点击右侧边栏 里面插件的build**，代码如下

apply plugin: 'groovy'
    apply plugin: 'maven'
    
    dependencies {
        compile gradleApi()
        compile localGroovy()
    }
    
    repositories {
        mavenCentral()
    }
    uploadArchives {
        repositories {
            mavenDeployer {
                repository(url: uri('repo'))
                //设置插件的GAV参数
                pom.groupId = 'com.kathie.myplugin'
                pom.artifactId = 'myPlugin'
                pom.version = 1.0
            }
        }
    }

![这里写图片描述][SouthEast 10]

我们只是配置好了打包路径等等，还没有看到出现repo这个路径呢 那是因为我们还没有开始打包，还是右侧边栏的kathieplugin这个task下 在upload下面有一个**uploadArchives** 点击他就会开始打包了  
![这里写图片描述][SouthEast 11]

*  他build完我们就可以看到在同级目录下出现了repo文件夹，我们点开就可以看到我们打包好的插件了

![这里写图片描述][SouthEast 12]  
至此 打包就完成啦。下一步就是我们怎么引用他了

我们需要在两个`build.gradle`中进行操作

*  一个是app下的`build.gradle` 我们需要将插件apply进去  
    apply后面的名字是我们之前说过的`xxx.properties`文件的名字

apply plugin: 'kathie-plugin'

![这里写图片描述][SouthEast 13]

*  还有一个是在project下的`build.gradle` ，我们需要指定插件的地址和版本之类的信息 这个跟的地址是repo的地址

maven { 
             url uri("/Users/katherine/AndroidStudioProjects/DemoPlugin/kathieplugin/repo")
            }
    
     dependencies {
            classpath 'com.kathie.myplugin:myPlugin:1.0'
        }

![这里写图片描述][SouthEast 14]

配置完了之后 我们重新编译一下 如果没有错误的话就可以在下面的gradleConsole中看到我们apply里面执行的逻辑啦  
![这里写图片描述][SouthEast 15]  
好啦 这样我们就为gradle写好了一个自定义的插件了。

有了这个基础 如果我们有一些在编译期间需要完成的需求就可以在插件中完成了。

*  讲给自己：

有时间多学习，很厉害了吗？都学会了吗？sdk写的很溜了吗？那你想别人干什么啊？干好自己的事情吧先

[github]: https://github.com/katherineqj/PluginDemo
[SouthEast]: /images/20220531/e0f0402efc5142e2be92d8e3343f99f1.png
[SouthEast 1]: /images/20220531/c0765347903747a1ac9f28e4fff75461.png
[SouthEast 2]: /images/20220531/53fe478caaf14b059410b4c43bafd80c.png
[SouthEast 3]: /images/20220531/09e025af39b24c07ab1bc7d209b3b207.png
[SouthEast 4]: /images/20220531/bcdae5f08cff4c2ea291330f80020e4f.png
[SouthEast 5]: /images/20220531/718992f40a604f148b6c72dfbc7048e4.png
[SouthEast 6]: /images/20220531/3e5c0af93cf44f08a057245094c3a3d0.png
[SouthEast 7]: /images/20220531/fe4654d04e274a1f89f973d9e7b70549.png
[SouthEast 8]: /images/20220531/c402191a11b643f58da36685f7d70263.png
[SouthEast 9]: /images/20220531/031d74b06c40490683e8d00141354402.png
[SouthEast 10]: /images/20220531/6905077a04ea4839ae452937db3a7fa0.png
[SouthEast 11]: /images/20220531/f30e656efb1842d097da01fcd9968f4c.png
[SouthEast 12]: /images/20220531/dfbc2cadf0fe41859682f25e2891d0de.png
[SouthEast 13]: /images/20220531/eeceb3ebe5884bf08b35af45c609784c.png
[SouthEast 14]: /images/20220531/ea08826d387740c58bb991f9c2015520.png
[SouthEast 15]: /images/20220531/1a1d9f0788734b849a949d78ebc62e5a.png