Gradle系列(四) Gradle插件

1. 前言

Gradle系列已完成,专注于Gradle,有如下几篇文章

Gradle系列(一) Groovy 基础
Gradle系列(二) Gradle执行顺序和task
Gradle系列(三) Gradle配置构建和渠道包
Gradle系列(四) Gradle插件

依赖apply plugin: 'com.android.application'就是依赖了安卓的应用程序插件.然后这个插件里面有android扩展,在官方文档里面有详细描述.但是,有时候不得不自己写一个插件,方便与业务开展.比如我觉得美团的热修复,在每个方法前面插逻辑的话,肯定得插桩,插桩就得自己写插件.方便快捷.Gradle+ASM可以插桩.有兴趣的可以去了解.

demo地址: https://github.com/xfhy/GradleStudy

2. 简单插件

新建一个简单的项目,然后创建一个buildSrc这个名字的module,这个module的名称必须为buildSrc.因为我们创建的这个module是AS专门用来写插件的,会自动参与编译.创建好之后删除Android那一堆东西,什么java代码,res,清单文件等.只剩下build.gradle和.gitignore

把build.gradle文件内容改成

repositories {    google()    jcenter()}apply {    plugin 'groovy'    plugin 'java-gradle-plugin'}dependencies {    implementation gradleApi()    implementation localGroovy()    implementation "commons-io:commons-io:2.6"}

然后在main下面创建文件夹groovy,sync一下.没啥问题的话,应该能编译过.然后在groovy文件夹下面创建包名com.xfhy.plugin,然后创建一个插件,名字叫CustomPlugin.groovy

package com.xfhy.pluginimport org.gradle.api.Pluginimport org.gradle.api.Projectclass CustomPlugin implements Plugin {    @Override    void apply(Project project) {        project.task('showCustomPlugin') {            doLast {                println('hello world plugin!')            }        }    }}

我在这里声明了一个CustomPlugin插件,然后里面创建了一个task名字叫showCustomPlugin,showCustomPlugin插件就只是简单输出一句话. 然后在app的build.gradle里面引入这个插件

import com.xfhy.plugin.CustomPluginapply plugin: CustomPlugin

然后就可以在命令行输入gradlew showCustomPlugin执行这个插件.然后就可以在命令行看到输出了.就这样简单的几步,一个简单的插件就写完了,虽然只是简单地打印了hello world..

3. 插件 plus

但是,我们肯定不会满足于只会输出hello world的插件,我们来做一个稍微有点用的插件.正如我们平常在android{} 闭包里面,我们写了很多次的

compileSdkVersion Config.compileSdkVersionbuildToolsVersion Config.buildToolsVersion....

那我们就来做这样一个插件,读取这些配置信息的数据.首先在包名com.xfhy.plugin下面创建AndroidExtension.groovy,它是一个bean对象,用来保存信息的.定义如下:

package com.xfhy.pluginclass AndroidExtension {    String compileSdkVersion = ''    String buildToolsVersion = ''    String applicationId = ''    String minSdkVersion = ''}

然后创建一个新的插件MyAndroidPlugin.groovy

package com.xfhy.pluginimport org.gradle.api.Pluginimport org.gradle.api.Projectclass MyAndroidPlugin implements Plugin {    @Override    void apply(Project project) {        def extension = project.extensions.create('testExtension', AndroidExtension)        project.task('AndroidPlugin') {            doLast {                println("minSdkVersion = ${extension.minSdkVersion}")                println("applicationId = ${extension.applicationId}")                println("compileSdkVersion = ${extension.compileSdkVersion}")                println("buildToolsVersion = ${extension.buildToolsVersion}")            }        }    }}

通过project.extensions.create来获取testExtension闭包中的内容,并通过反射将闭包中的内容转成一个AndroidExtension对象.然后我创建了一个task去读取它.

然后我们在app下面的build.gradle中加入代码:

testExtension {    minSdkVersion '22'    applicationId 'com.xfhy.gradledemo'    compileSdkVersion '29'    buildToolsVersion '29.0.2'}

输出如下:

minSdkVersion = 22applicationId = com.xfhy.gradledemocompileSdkVersion = 29buildToolsVersion = 29.0.2

不错,已经能搞一个能读取到闭包信息的插件了.

4. 实操

我们来实现一个插件,打包的时候将pic/test.png复制到apk文件中的assets中.实际上是在打包之前将test.png复制到相应的文件夹,等待打包合成.首先是新建HookAssetsPlugin.groovy

class HookAssetsPlugin implements Plugin {    @Override    void apply(Project project) {        project.afterEvaluate { it ->            //1. 在afterEvaluate闭包中才能获取当前project中的所有task            project.plugins.withId('com.android.application') {                //2.确保当前project是Android app project,而不是Android library project, 为给定id的插件执行或注册操作                project.android.applicationVariants.all { variant ->                    //3. 拿到所有变体信息                    //[ApkVariantOutputImpl_Decorated{apkData=Main{type=MAIN, fullName=freeDebug, filters=[], versionCode=2, versionName=2.0.0}}]                    variant.outputs.each { variantOutput ->                        // 4. outputs 字段可知道该字段代表着当前变体的输出信息（DomainObjectCollection 类型）//                        println("${variantOutput.name}")  //free-debug  free-release                        if (variantOutput.name.contains('release')) {                            //5. 拿到release                            project.tasks.findByName("package${variant.name.capitalize()}").doFirst { task ->                                //6. 得到packageApplication                                project.copy {                                    //7. 复制                                    from "${project.projectDir.absolutePath}/pic/test.png"                                    into "${task.assets.provider.value.value.getAbsolutePath()}"                                }                            }                        }                    }                }            }        }    }}

嵌套特别多,写起来不是很舒服,而且不能智能提示,而且api还不好查…吐血…详细的注释在代码中已给出,这里就不多做介绍了.使用的时候在app下的build.gradle中添加如下代码即可:

import com.xfhy.plugin.HookAssetsPluginapply plugin: HookAssetsPlugin

然后执行gradlew assembleFreeRelease,完事儿之后看一下打出来的apk包,可以看到是apk文件里面的assets里面确实多了test.png文件.看起来没什么鸟用,但是却让我们感受到了插件到底可以干些什么事儿.

5. 调试Gradle

首先是我们在执行指令的时候加一个参数gradlew assembleFreeRelease -Dorg.gradle.debug=true --no-daemon,这样.
然后在AS->Run->EditConfigurations,然后点击左上角的+号,添加一个Remote,然后直接点击apply即可.

然后点击debug按钮即可进入调试.

6. 总结

Gradle插件很多时候能方便我们进行一些骚操作,用处还是挺大的.

参考

写给 Android 开发者的 Gradle 系列（三）撰写 plugin
又掌握了一项新技能 - 断点调试 Gradle 插件