一份手把手的无埋点技术

在这之前你需要了解的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则会出现一些力有不逮的情况。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,125评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,293评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,054评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,077评论 1 291
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,096评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,062评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,988评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,817评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,266评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,486评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,646评论 1 347
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,375评论 5 342
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,974评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,621评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,796评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,642评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,538评论 2 352

推荐阅读更多精彩内容