android插件怎么开发,入坑 Android Gradle 插件开发（一）

最近由于需要做一些功能，比如统计方法的执行时间，处理删除一方法等。网上找了一圈，虽有有很多开源工具有类似的功能了，但是不够灵活，所以想自己开发 Android Gradle 插件，于是研究了下如何开发 Android Gradle 插件。

仅自己的工程里面使用

如果是指自己使用的话，可以用下面的方法来快速开发一个插件。在 apk module 下面的 build.gradle 新增一段代码

class DemoPlugin implements Plugin {

@Override

void apply(Project project) {

println "=============================="

println 'hello, DemoPlugin!'

println "=============================="

}

}

apply plugin: DemoPlugin

然后 执行一下 assembleDebug 命令，会在控制台看到下面的打印。

==============================

hello, DemoPlugin!

==============================

到这里一个简单的 gradle 插件就完成了。

希望开源发布出去，供大家使用

如果需要发布出去，那么需要新建一个 Module 了，在刚刚的 Demo Project 里面新建一个 Java Library Module 。建好 Module 后，我们需要进行一定的改造才可以开发 gradle 插件，改造的方法如下：

修改 build.gradle

修改刚刚新建的 Module 下面的 build.gradle 为下面的内容

//apply plugin: 'java-library'

apply plugin: 'groovy'

dependencies {

compile gradleApi() //gradle sdk

compile localGroovy() //groovy sdk

implementation fileTree(dir: 'libs', include: ['*.jar'])

}

新建 src/main/groovy 目录

由于插件是用 groovy 开发的，所有我们需要在 src/main 下面新建一个 groovy 目录，groory 的源码将在这个目录( src/main/groovy) 下面。有一个小技巧是，如果 AS 给你新建了一个 src/main/java 目录的话，建议你直接把 java 目录名修改为 groovy 。

创建 Plugin 类

groovy 目录创建好了以后，我们需要创建一个实现 Plugin 的类，然后通过 Plugin 接口里面的 apply 方法入口做我们后面想做的事情。这里有一个 demo 代码片段：

// 源码路径为 src/main/groovy/com/xander/plugin/DemoPlugin.groovy

package com.xander.plugin

import org.gradle.api.Plugin

import org.gradle.api.Project

public class DemoPlugin implements Plugin {

@Override

void apply(Project project) {

println "===================================="

println "Hello DemoPlugin!!!"

println "===================================="

}

}

新建一个 properties 配置

刚刚我们新建了一个 Plugin 了，但是我们如何让 AS 知道我们的插件是哪一个呢，这个时候我们就需要新建一个 properties 配置来告诉 AS。这个配置文件需要放在 src/main/resources/META-INF/gradle-plugins 目录下面，如果没有想要的目录，需要自己创建。当目录创建好以后，你可以新建一个 properties 配置了，需要特别注意的是，配置的文件名就是后面 build.gradle 里面的 apply plugin: 'xxx.xxx.xxx'。 在这里我新的配置的文件名是 com.xander.plugin。配置建好了，我们需要往里面写入配置。你可以参考下面的配置。

implementation-class=com.xander.plugin.DemoPlugin

properties 里面的内容说白了就是一个个的键值对，这里面键是 implementation-class ，这个是固定的，用来告诉 AS 我们的 Plguin 的入口实现类，而值就是类的路径，简单说就是包名+类名。

到这里，改造就完成了，我们就有了一个 gradle 插件开发的环境。最后的 Module 结构如下

.

├── build.gradle

├── libs

├── plugin.iml

└── src

└── main

├── groovy

│ └── com

│ └── xander

│ └── plugin

│ └── DemoPlugin.groovy

└── resources

└── META-INF

└── gradle-plugins

└── com.xander.plugin.properties

上传到 maven 库

既然我们的插件是希望提供给别人用的，所以我们需要把我们的插件上传到 maven 库供大家下载使用。这个时候需要修改 plugin module 下面的 build.gradle 文件，可以参考下面的示例

//apply plugin: 'java-library'

apply plugin: 'groovy'

apply plugin: 'maven'

uploadArchives {

repositories.mavenDeployer {

repository(url: uri("../repos")) // repos 为本地的地址，后续可以替换为网路上的 maven 库地址

pom.groupId = "com.xander.plugin"

pom.artifactId = "demoplugin"

pom.version = "1.0.0"

}

}

dependencies {

compile gradleApi() //gradle sdk

compile localGroovy() //groovy sdk

implementation fileTree(dir: 'libs', include: ['*.jar'])

}

修改 build.gradle 文件后， sync 下就可以看到 uploadArchives task 了，执行 uploadArchives task 就会发布我们的插件了。如果在控制台看到类似下面的 log 信息，一般就是上次成功了。

> Task :plugin_demo:compileJava NO-SOURCE

> Task :plugin_demo:compileGroovy UP-TO-DATE

> Task :plugin_demo:proce***esources NO-SOURCE

> Task :plugin_demo:classes UP-TO-DATE

> Task :plugin_demo:jar UP-TO-DATE

> Task :plugin_demo:uploadArchives

别人如何引用 gradle 插件

当我们的插件开发完成，并且也上传到了 maven 库了以后，别人如何使用我们开发的插件呢？

首先我们需要修改 project 根目录下面的 build.gradle 文件

buildscript {

repositories {

maven { url uri("./repos") } // repos 为本地的地址，后续需要修改为发布的 maven 库地址

google()

jcenter()

}

dependencies {

classpath 'com.android.tools.build:gradle:3.2.1'

// NOTE: Do not place your application dependencies here; they belong

// in the individual module build.gradle files

//格式为 --> group:module:version

classpath 'com.xander.plugin:demoplugin:1.0.0'

}

}

然后修改 apk module 下面的 build.gradle 文件，新增下面的一句命令就好了

// com.xander.plugin 为 resources/META-INF/gradle-plugins 下的 properties 文件名称

apply plugin: 'com.xander.plugin'

到这里，插件的开发就介绍完了。

参考资料: