前言
我之前写过一篇AOP的文章 看AspectJ在Android中的强势插入 是通过AspectJ来实现的,本篇是『巴掌』的投稿,他通过使用ASM来讲解了在Java和Android中的AOP方法,非常值得大家学习交流~
demo地址:https://github.com/JeasonWong/CostTime
需求
实际业务开发中有很多需要不改变原业务代码,而需额外增加一些包括各种统计的需求,如APM、无数据埋点等,也就是耳熟能详的AOP,本文以统计方法耗时为例,不使用Aspectj,采用原生态的方式进行实践。
使用者所需要做的就是对所需要统计耗时的方法头部加指定注解@Cost就可以使用了。
目标
- 不影响现有逻辑
- 需要统计耗时的方法头部加上注解
- 支持混淆
方案
方案分两部分,一部分针对JVM,一部分针对Android平台。
JVM
- 自定义注解
- 使用ASM增加字节码
- 反射实例化
- 使用Instrumentation构建代理
Android
- gradle plugin 自定义Transform Api
实践
先让我们的方案能在JVM上运行起来。
自定义注解
我们先只对方法进行耗时统计,因此Target设为Method。
使用ASM增加字节码
首先自定义一个ClassVisitor,然后重载visitMethod方法,这样我们便可以遍历所有类文件的方法了,然后利用AdviceAdapter类来重新实例化一个MethodVisitor,并且重载它的visitAnnotation、onMethodEnter、onMethodExit方法,其中含义就如方法名一样简单明了。
然后我们通过visitAnnotation方法来判断当前方法注解是否为我们自定义的注解,如果是指定注解,则插入代码,具体插入代码的内容我们接下来再讲,自定义ClassVisitor的代码如下:
再写ASM插入代码前,我们必须意识到一件事,那就是得知道我们会在onMethodEnter中存一个方法开始时间,再在onMethodExit中存一个方法结束时间,再去相减,那么问题来了,这个时间我们存哪呢?肯定不能是局部变量,因为两个方法间并不会共享局部变量,那么本文是将变量存为静态,方便不同方法间调用,具体可见TimeCache.java,代码比较简单,不多加介绍:
然后便是插入时间统计代码了,我在之前的一篇文章就有介绍过 手摸手增加字节码往方法体内插代码(http://www.wangyuwei.me/2017/01/22/手摸手增加字节码往方法体内插代码/) ,我们可以借助一个intelliJ plugin —
ASM Bytecode Outline来方便我们写ASM代码,先把原java代码写好:
然后利用插件,生成对应ASM代码,删除掉无用信息后,可得到:
那么我们将这部分ASM代码填充到刚刚遗留下来的CostClassVisitor.java里便可。
这样一来,我们的ASM工作已经结束,接下来就是来让插入的方法运行起来。
反射实例化
先来一种简单的方案,就是将我们插入代码后二进制流手动生成.class文件并利用反射实例化它。
首先来看看插入前的代码:
我给newFunc2方法增加了@Cost注解,但没给newFunc1方法增加,然后开始用ASM提供的类生成插入代码后的二进制流:
然后run一下,可以得到:
只对newFunc2做了方法耗时统计。
使用Instrumentation构建代理
Instrumentation是Java5提供的新特性,关于详细介绍,可以查看这篇文章:Java 5 特性 Instrumentation 实践(https://www.ibm.com/developerworks/cn/java/j-lo-instrumentation/),简单点说就是我们得在JVM执行main函数前动点手脚,自己实现一个代理,在得到虚拟机载入的正常的类的字节码后通过ASM提供的类生成一个插入代码后的字节流再丢给虚拟机,自定义的代理得实现ClassFileTransformer,并且提供premain()方法,写有premain方法的类得在MANIFEST.MF中显示调用,首先来看看我们自定义的代理类:
再看看MANIFEST.MF:
这样写好代理类之后,我们便可以生成一个代理jar,之后为我们运行代码使用,进入module javademo,生成jar可直接使用命令:
得到代理jar后,再使用命令行java -javaagent:{{lib的绝对地址/}}lib/cost-time.jar Demo2.java运行即可,如果在使用命令行运行时带来了问题,可以直接通过对IntelliJ IDE进行修改:
Windows, Linux, some Macs:
ALT SHIFT F10->Right->E->Enter->Tab->enter your command line parameters->Enter.
Mac with “OS X 10.5” key schema:
CTRL ALT R->Right->E->Enter->Tab->enter your command line parameters->Enter.
在VM options一栏填入-javaagent:lib/cost-time.jar即可。
以上便是运行在JVM上的操作,然而我们最终的目标是为Android平台所用。
gradle plugin 自定义Transform Api
Transform API允许第三方插件在class文件转为为dex文件前操作编译好的class文件,那么这就是我们的入口,拿到正常的class后再经过ASM插入字节码后得到新的class,再被dx转成dex。
首先自定义个plugin—CostTimePlugin.groovy:
我们预留了一行注释,去遍历build/intermediates/classes/release/下面生成的所有class,当然R.class、BuildConfig.class这些我们就可以直接跳过,ASM过滤一遍插入新代码之后再去覆盖原class,代码如下:
这样一来,我们可以看看新生成的class是不是有被插入代码。
这是源代码MainActivity.java:
这是build/intermediates/classes/release/里的MainActivity.class:
而且我们可以看下build过程:
我们的class操作是在混淆前的,那么此次AOP也完全不影响正常的混淆,可看混淆后的MainActivity.java:
尾语
我们采取的方案其实大有可为,计算方法耗时只是冰山一角,包括无数据埋点、性能的监控都是可以继续拓展的。以上方案难免有些漏洞,欢迎指出,有兴趣的朋友可以一起探讨。