在这之前你需要了解的DSL语法原理与常用API介绍、gradle打包流程、gradle生命周期和hook技术、transfrom API。文章过程中也会对一些API使用做讲解。
一：首先需要自定义一个插件。
二：搞清楚插件的用途
在build一个project的时候，会有非常多的build variant供我们选择，搞清楚插件时在什么时候生效的。比如美团的热修复框架，是采用函数插桩的形式实现的，那么它的插件就要应用在release版本中。又或者在开发期间做一些效率监控的插桩就需要把插件应用在debug版本中，同时考虑Instantrun等问题。
控制插件的生效与否可以参考下面的例子：
String taskNames = project.gradle.startParameter.taskNames.toString()
PluginInfo.TaskType taskType = PluginInfo.TaskType.OTHER
if (taskNames.toUpperCase().contains(PluginInfo.TaskType.DEBUG.toString())) {
taskType = PluginInfo.TaskType.DEBUG
} else if (taskNames.toUpperCase().contains(PluginInfo.TaskType.RELEASE.toString())) {
taskType = PluginInfo.TaskType.RELEASE
}...
或者有时候我们想知道插件是在application里还是在依赖的modul里:
if (!project.plugins.hasPlugin('com.android.application')) {
return
}
这是通过build.gradle里有没有 apply plugin: 'com.android.application'来判定的，library会有不同的plugin。
三：Transform的注册
（1）正常流程
另一种方式获取modul的类型：
例1：
project.getPlugins().hasPlugin(AppPlugin.class);
例2：
def test = project.extensions.findByType(TestedExtension)
def android
if (test instanceof AppExtension) {
android = project.extensions.findByType(AppExtension)
}
注册：
例:android.registerTransform(new MyTransform());
一点解释：
build.gradle 会转化为Script类 ，利用元编程设置Project对象为代理类。Project对象和build.gradle文件一 一对应。build文件中的android{}代码块是一个extension，最终会被添加到project的extensions（一个容器）去，和我们自己创建的extension一样。AppExtension继承了TestedExtension，TestedExtension继承了BaseExtension，registerTransform 就是BaseExtension中定义的方法。获取modul的类型不是必须的，只是可以根据不同的modul，做的事情可能会有差别。
（2）hook
Transform其实就是task，原本的打包流程中也会把一些工作封装进Transform中。自定义的Transform在原本的打包流程中的transform之前执行，自定义的多个Transform的执行顺序由apply plugin的顺序决定。如果想在一个既定的流程中再插入一个Transform，可以使用hook的方式。
利用project.getGradle().getTaskGraph().addTaskExecutionGraphListener可以获得全部的Task，或者通过project.getGradle().getTaskGraph().whenReady方法然后根据名称筛选出你想hook的task，然后
Field field = TransformTask.class.getDeclaredField("transform")
field.setAccessible(true)
field.get(task)
将原本transform保存下来，然后设置一个新Transform的进去，只要新的Transform执行完，再去调用保存的Transform的transform方法就可以了。
一点解释：
这里可能需要理解一下构建的生命周期，可以读一下文章刚开始的链接文章。
四：插桩
1、这里第一步要进行类和方法的收集，根据Transform API，tranform的输入参数中有我们想要的class文件，遍历它们，遍历的过程中要对类加以识别，本文以ASM（在插入代码的时候不是很方便，但是有一些插件可以用，你可以写一段java代码，然后用插件转译成asm代码）为例，要注意几个特殊的情况：
（1）transform的输入文件有一些是我们不需要的
R.class、R$开头的、Manifest、以及Buildconfig要去除。
（2）既然是插桩，那么一些不能插桩的类也要剔除，使用ASM识别出文件是否是接口、抽象类，或者注意函数是否是abstract方法。
（3）代码插入会导致一些本该内联的方法无法内联，最后导致方法数超限（美团热更新遇到的问题）。并且一些适合内联的短函数大部分情况也不需要插入代码，插入代码反而会降低效率。过滤掉这些函数，可以通过ASM来访问函数内容，一条一条的判断函数语句，如果只是单纯的代码计算（没有invoke）、get/set方法（只有filed访问和return）的函数过滤掉他们。
（4）构造方法。如果在函数头部插入代码会有语法错误，需要特殊处理。（同样还有使用super关键字进行的函数调用，这部分问题在美团的热修复中也有顾及到）
排除掉不需要插桩的类之后，将类收集起来，可以保存在list当中，然后遍历类，对需要插桩的函数进行插桩。最后处理修改后的类到合适的路径下。
说明：关于输入的jar包，可以用zipfile来解压获得class文件。
考虑代码增量更新：
Transform的输入file会加上file的状态，如果是change或者add则做代码插入，如果是delete则要将之前保存了插入过代码的文件删除。如下例程：
boolean isIncremental = transformInvocation.isIncremental();
//如果非增量，则清空旧的输出内容
if(!isIncremental) {
outputProvider.deleteAll();
}
for(DirectoryInput directoryInput : input.getDirectoryInputs()) {
File dest = outputProvider.getContentLocation(directoryInput.getName(),
directoryInput.getContentTypes(), directoryInput.getScopes(),
Format.DIRECTORY);
FileUtils.forceMkdir(dest);
if(isIncremental && !emptyRun) {
String srcDirPath = directoryInput.getFile().getAbsolutePath();
String destDirPath = dest.getAbsolutePath();
Map<File, Status> fileStatusMap = directoryInput.getChangedFiles();
for (Map.Entry<File, Status> changedFile : fileStatusMap.entrySet()) {
Status status = changedFile.getValue();
File inputFile = changedFile.getKey();
String destFilePath = inputFile.getAbsolutePath().replace(srcDirPath, destDirPath);
File destFile = new File(destFilePath);
switch (status) {
case NOTCHANGED:
break;
case REMOVED:
if(destFile.exists()) {
FileUtils.forceDelete(destFile);
}
break;
case ADDED:
case CHANGED:
FileUtils.touch(destFile);
transformSingleFile(inputFile, destFile, srcDirPath);
break;
}
}
} else {
transformDir(directoryInput.getFile(), dest);
}
来自社区，如果需要一些代码细节的话，比如文件的遍历，可以再翻一下文章。
五：插桩方案选用：
对ASM 以及Javassist进行过实践。相比较其他的方案，ASM还是最强大的一种方案，只不过使用起来比较抽象。比如使用Javassist插代码，只需要像接口中传入自定义的代码对应的字符串即可，但是ASM需要插入的一堆指令。但是实践中ASM的问题很少，Javassist则会出现一些力有不逮的情况。
网友评论