Gradle系列 (上篇) —Android自定义Gradle插件并在项目中使用

一、关于Gradle

Android项目的构建过程是通过一系列Gradle插件完成的，而Gradle插件是使用Groovy语言实现的，Groovy是一种脚本语言，在国外还是很火的，但是国内使用的貌似不多，Groovy 可以与 Java 语言无缝对接，在写 Groovy 的时候如果忘记了语法可以直接按Java的语法继续写，也可以在 Java 中调用 Groovy 脚本，都可以很好的工作。关于Groovy语言可以到官网做稍微了解学习：Groovy官网，也可以到精通Groovy简单学习。

Gradle中的所有内容都基于两个基本概念：Project和Task

Project：这个接口是build file与Gradle交互的主要API，通过Project接口可以访问Gradle的功能。
Task：一个Project本质上是Task对象的集合，每个Task都执行一些基本的工作，比如compileDebugJavaWithJavac、assembleRelease等等。

Android项目的build过程

上面这张图诠释了Gradle build的生命周期的过程，分为三个阶段。对于Android项目，在Configuration阶段会解析项目根目录下的build.gradle文件。

上面的 classpath 'com.android.tools.build:gradle:3.6.1' 就是用来导入用于构建Android项目的Gradle 插件库的，导入插件库以后，就可以在项目的子module的build.gradle中应用该插件库中的插件了：

apply plugin: 'com.android.application'

为了更清晰的理解gradle插件和使用，那接下来就来自定义一个gradle插件并使用它。

二、自定义Gradle插件

Gradle 一共提供了三种方式创建自定义插件：

1、直接在build脚本中开发包含插件的源代码：

插件可以自动编译并包含在build脚本的classpath中，而无需执行其他任何操作。但是不能在build脚本之外重用插件。

2、在buildSrc这个project中创建自定义插件：

在项目中创建module，命名为BuildSrc(必须为BuildSrc)，与app同级。该方式与第三种有点相似，下面会重点介绍第三种方式。该插件对build使用的每个build脚本都是可见的。但是在build之外是不可见的，所以不能在build之外重用该插件。

3、在独立的module中创建自定义插件：

为自定义gradle插件创建一个单独的project。该project生成并发布一个包，可以在多个build中使用该包。

创建一个module（Android Library），命名随意，我这里叫“MyPlugin”。

删除多余的文件，只留下src/main以及build.gradle文件，如下：

首先我们要在src/main/这个路径下创建两个文件夹：一个是groovy，另外一个是resources/META-INF/gradle-plugins
注意：这里的目录名字不能写错，不然运行的时候会找不到。
修改过后的截图如下：

接下来就可以完善插件内容和配置信息了。
因为插件是用groovy语言写的，所以接下来我们要在myplugin中的build.gradle添加如下信息，先删除之前的内容。

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

dependencies {
    implementation gradleApi()
    implementation localGroovy()
}

repositories {
    mavenCentral()
}


//设置插件的GAV参数
group = 'com.zhuyong.myplugin'
archivesBaseName = 'MyPlugin'
version = '1.0.0'


uploadArchives {
    repositories {
        mavenDeployer {
            //在当前同级目录下生成maven包
            repository(url: uri('repository'))
        }
    }
}

此时可以执行以下Sync同步一下。下一步要开发插件的可执行代码了，在groovy文件夹下新建package包：com/zhuyong/myplugin，然后新建一个xxx.groovy的文件（创建方式：new → file → xxx.groovy ），我这里的groovy叫做MyPlugin.groovy，截图如下：

这个groovy文件的是为成为gradle插件而服务的，需要实现org.gradle.api.Plugin的接口，然后在重载的apply()方法中是插件执行的逻辑，我们在这个插件中输出一些字符串来验证是否执行了当前插件：

OK，Plugin已经完成了，那么如何引用它呢，别急继续看。
如何让其他Project知道我们这个是gradle插件呢？关键就在刚才创建的resources/META-INF/gradle-plugins，在该目录下创建properties类型的文件，这里文件命名很重要，这里的命名就是后面我们使用插件所依赖的方式，比如命名为custom-gradle-plugin.properties，那么在使用时就是：

apply plugin: 'custom-gradle-plugin'

这里新建完成properties文件以后，输入以下内容：implementation-class=自定义的Plugin类的路径，截图如下：

打包发布自定义插件

我们已经自定义好了插件，下一步我们就要进行打包的过程了，刚才已经在build.gradle里面指定好了打包的路径以及版本号等参数信息，现在我们需要打包一下，在右侧边栏的myplugin这个module下，在upload下面有一个uploadArchives，双击他就会开始打包了：

此时我们可以看到打包的过程如下：

此时，在myplugin目录下就可以看到生成的文件夹了：

引用自定义插件
第一步：在项目根目录下的build.gradle中添加以下代码：

maven {
    url uri('myplugin/repository')
}

------------------------------------------------------------------

classpath 'com.zhuyong.myplugin:MyPlugin:1.0.0'

截图如下：

第二步：在app目录下的build.gradle中添加以下代码：

apply plugin: 'custom-gradle-plugin'