一步步自定义Gradle插件

作者: juexingzhe | 来源:发表于2017-11-03 18:53 被阅读771次

Gradle自定义插件
自定义Gradle插件
启用Gradle远程调试
gradle插件调试
Android Gradle 插件(二)
Gradle 插件
Gradle自定义插件和发布
Android Gradle入门到精通(二)
Gradle自定义插件(Android)
EventTrackingAndroidGradle

AndroidStudio现在的构建工具都是采用的gradle，可能很多小伙伴都感觉比较神秘，今天我们来从零开始自定义一个自动输出Lint报告的Gradle插件，Lint报告中可以初步检查出我们程序中的一些问题，输出HTML或者XML文档。

废话不多说，直接开始开车了。

1.自定义Gradle插件的方式

Gradle是采用Groovy语言，编写Gradle插件主要有三种方法

1.build.gradle脚本中直接使用。这种方式就是直接在Android Studioapp moudle的build.gradle 中进行插件的编写，优点就是不用再上传插件到maven或者其它地方，项目就可以直接使用；缺点也是很明显，就是只能在自己的项目中使用，不能复用，这个不是我们今天要说的。

buildSrc中使用。这种方式需要在项目中新建一个model命名为buildSrc，这个目录就用来存放自定义插件。然后在src/main中建立两个目录，一个就是存放代码的groovy目录，一个是存放自定义插件名称的resources目录。这种定义方式也是只能在我们项目中进行使用，不好复用。我们今天要分享的是最灵活的方式，也就是第三点。

3.独立Module中使用。这种方式就是完全独立开发一个Module，可以随便用。

我们现在一步步来自定义这个Module。

2.自定义Module

2.1配置

首先打开IntelliJ这个神器，可以说是Android Studio之父了，然后按照下面配置新建一个工程。

新建Module.PNG

接着就是配置目录了，和上面说的第二种方式其实一样的，配置好的目录如下，其中groovy目录就是放置代码的地方，resources里面放置的是一个配置文件，文件的名字com.juexingzhe.cleaner就是在用这个插件的地方需要的名字，比如apply plugin:'com.juexingzhe.cleaner'。

配置目录.PNG
上面配置文件内容,其实就是一个映射关系，找到我们定义的插件CleanerPlugin，com.juexingzhe.mobile是CleanerPlugin这个插件类所在的包名。
implementation-class=com.juexingzhe.mobile.CleanerPlugin

2.2 撸代码

环境都配置好了，接下来肯定就是实现 com.juexingzhe.mobile.CleanerPlugin这个插件了，先贴出代码我们再做解释。当然groovy也是完全兼容Java的，所以小伙伴们看起来完全无压力啊。
定义插件首先要实现Plugin接口，然后在apply方法中实现插件功能。
我们这里实现的就是输出Lint报告，很简单就是两句话，首先定义文档的输出位置xmlOutput 。

class CleanerPlugin implements Plugin<Project>{
    @Override
    void apply(Project project) {
        project.afterEvaluate {
            project.android.lintOptions.xmlOutput = new File(project.buildDir, "lintResult.xml")
        }
        project.tasks.create('cleanTest', CleanTestTask)
    }
}

为了直观感受，我添加了一个task，也就是cleanTest，这个Task就是打印几句话，证明这个插件确实起作用了，不是我在忽悠小伙伴们。看下Task的代码,因为我们这里要输出Lint报告，所以要依赖lint这个task，也就是dependsOn "lint"这行代码的作用，task的具体工作就是@TaskAction这个注解标注的方法中了，代码就没什么好解释的了。

class CleanTestTask extends DefaultTask{
    CleanTestTask() {
        super()
        dependsOn "lint"
    }
    @TaskAction
    def testClean(){
        System.out.println("==================")
        System.out.println("Test Clean Task")
        System.out.println("==================")
    }
}

到这里我们插件的代码工作基本就完成了，剩下最后一个问题，怎么用这个插件呢？当然就是上传Maven等等的仓库中了，这里为了方便我就上传到自己的本地了。

2.3 上传插件

上传插件就是在这个Module的build.gradle中写Task了，看下代码,我就上传到工程目录的平级目录中的repo目录下了。

apply plugin: 'maven'
group = 'com.juexingzhe.mobile'
version = '1.0.0'

uploadArchives {
    repositories {
        mavenDeployer {
            //本地的Maven地址设置为D:/repos
            repository(url: uri('../repo'))
        }
    }
}

OK，代码的工作就真正完成了，这回没骗人。点击下build就能看见我们定义的uploadArchives这个Task了。

上传Task.PNG

点击下这个任务就能在我们的目录下生成这个插件。

插件仓库.PNG

这样我们的插件就完成了，接下来就是怎么用的问题了。

3.使用插件

首先在要使用这个插件的app目录下的build.gradle中添加下面代码:

1.apply plugin的名字就是上面我们在resources中定义的properties文件的文件名;

2.maven仓库就是我们上面的仓库地址;
3.就是添加依赖，其中com.juexingzhe.mobile就是group,juexingzhe就是上面插件工程的工程名，1.0.0就是版本号了，group和version都是在上面的gradle中定义了，module没定义就默认使用工程名了。

apply plugin: 'com.juexingzhe.cleaner'

buildscript {
    repositories {
        maven {
            url uri('E:/code/repo')
        }
    }

    dependencies {
        classpath 'com.android.tools.build:gradle:2.3.3'
        classpath 'com.juexingzhe.mobile:juexingzhe:1.0.0'
    }
}

添加上面代码后Sync一下就能看见我们的Task了：