一、前言
现在大家基本都用Android Studio（AS）开发安卓，AS是使用Gradle构建项目，打开工程的build.gradle文件，在头部能看到apply plugin: 'com.android.application'，或者apply plugin: 'com.android.library'，如果引入了Tinker热修复，还看到apply plugin: 'com.tencent.tinker.patch'，那apply plugin是什么，起什么作用，如何定义及使用。
二、Gradle Plugin的作用
2.1 Gradle 与Gradle Plugin
Gradle：Gradle：Gradle是一款帮助开发人员更快更好的编译、自动化运行和分发软件的工具。Gradle具有无与伦比的通用性，可以编译Java、C++，Python或者任何其他你使用的语言。Gradle官网链接。
Gradle Plugin：Gradle的插件，编译Android App的插件叫做Android Plugin for Gradle。 Android Studio的编译系统使用的就是Gradle，Android Plugin for Gradle增加了编译Android APP所需要的特性。
Android Studio创建的APP工程中可以在工程（非子module）的build.gradle文件buildscript里配置依赖的插件版本。如下：
buildscript {
repositories {
google()
}
dependencies {
classpath 'com.android.tools.build:gradle:3.3.0'
}
}
2.2 Gradle Plugin的作用
- 模块化构建脚本的功能
- 公共的功能可以抽取出来成为插件，可以供多个 build.gradle 使用，增加复用性
- 通过插件修改编译后的class文件，对于关键节点的插桩做性能监控，修改第三方依赖等
三、自定义一个Gradle Plugin
3.1 创建Gradle Plugin工程
1、在项目工程中，新建一个命名为buildSrc的Module，类型为Java Library，其他类型也行，创建后删掉不必要的文件和目录，只保留src和build.gradle即可。
2、将 main/src/java 修改为 main/src/groovy
项目结构
3、创建MyPlugin类实现接口Plugin<Project>，并重写apply方法。
class MyPlugin implements Plugin<Project> {
@Override
void apply(Project project) {
System.out.println("start ")
System.out.println("hello my gradle plugin")
System.out.println("end")
}
}
4、在外部使用该插件
先Sync Project，然后在其他子工程的build.gradle中输入关键字就能出现刚刚创建的plugin：
import com.siu.buildsrc.MyPlugin
apply plugin: 'com.android.application'
apply plugin: MyPlugin
5、执行验证
在命令行中执行打包命令：
gradlew build
Configure project :app
start
hello my gradle plugin
end
从日志，可以看到，在Configure app工程的阶段，执行了插件。
3.2 打包插件
上面新创建的插件的引用方式是直接引用了MyProject，可以跳转到对应的plugin文件定义，跟apply plugin: 'com.android.application'有些不同，那另外这种方式是怎么定义的呢。
Gradle plugin的引用方式可分为两种：
- 一种是只能在本工程中使用的插件
- 另一种是可以将其打包发布出去使用的插件，引用其实是一个别名（ Plugin ID ）
上面创建的插件就是在本工程直接引用的，命名必须为buildSrc，而打包发布出去的对命名没有要求。
要发布出去该怎么打包？
1、新建文件夹src/main/resources/META-INF/gradle-plugins，并在文件夹下创建文件:myplugin_alias.properties，
注意myplugin_alias是引用的别名（Plugin ID ）。
buildSrc结构
2、文件内容指向plugin文件
implementation-class=com.siu.buildsrc.MyPlugin
3、打包发布
在插件工程buildSrc的build.gradle文件中配置版本号和打包上传目录。
apply plugin: 'groovy'
apply plugin: 'maven'
dependencies {
compile gradleApi()
compile localGroovy()
}
repositories {
mavenCentral()
}
uploadArchives {
repositories {
mavenDeployer {
//提交到远程服务器：
// repository(url: "maven url") {
// authentication(userName: "xxx", password: "xxx")
// }
//本地的Maven地址设置为项目根目录下的repositories
repository(url: uri('../repositories'))
pom.groupId = 'com.siu.buildSrc' //groupId,自行定义,一般是包名
pom.artifactId = 'buildSrc'//artifactId,自行定义
pom.version = '1.0.0' //插件版本号
}
}
}
然后在AS右侧的Gradle菜单中找到对应的task，先执行双击执行build，再执行uploadArchives。
打包发布
然后在刚配置的本地maven目录repositories中能找到打包后的文件。
打包后文件
4、引用
先在工程总的build.gradle目录下指定需要依赖的插件及版本
buildscript {
repositories {
google()
url uri('./repositories') //指定本地maven路径
}
}
dependencies {
classpath 'com.android.tools.build:gradle:3.3.0'
classpath 'com.siu.buildsrc:customId:1.0.0'
}
}
然后在需要执行插件的子工程的build.gradle中引用：
apply plugin: 'com.android.application'
apply plugin: 'myplugin_alias'
5、验证
gradlew build
Configure project :app
start
hello my gradle plugin
end
从日志，可以看到，在Configure app工程的阶段，执行了插件。
四、总结
本文总结了Gradle Plugin的作用及如何自定义Gradle Plugin，学习后对Gradle的打包流程有更多的了解，也知道了可以通过Plugin hook 编译过程，在编译前、中或后执行一些特定的任务，例如修改配置文件、修改class文件对关键节点进行插桩，事实上，一些性能监控sdk就是通过Plugin的方式对代码插桩，然后做监控性能，微信的Tinker也是使用插件（apply plugin: 'com.tencent.tinker.patch'）打补丁包。
网友评论