-
**代码3:**我们定义了一个方法,进行我们的逻辑处理。需要了解的是方法的参数joinPoint, joinPoint表达的是连接点对象.
-
**代码4:**通过
joinPoint.proceed()
实现对原有逻辑的调用,我们正是在这一处前后插入我们的执行逻辑
上面的代码就已经实现了无埋点进行JSON反序列化耗时统计。
通过注解来统计方法耗时,可以参照Hugo的源码。
可以看出,AspectJ方案写起来很简单,非常适合做一些Android里需要的AOP编程操作,比如动态权限检查。但AspectJ还是有一些局限,我们统计Activity页面生命周期耗时需要以生命周期为切点,在实际工程代码里,我们最终使用的页面Activity类一般是经过多次抽象后继承实现的,代码里已经不包含OnCreate/onResume
方法了,这时候AspectJ就无能为力了。另外查看处理后的class文件,可以发现除了桩点代码外,还会增加额外的一些代码,对包大小限制不利。
ASM插桩方案
我们知道,class文件是按照JVM规范格式存储的二进制文件,本质上是一个表,记录了类的常量池、访问标志、属性和方法等。ASM库不仅能够对class文件进行解读,还提供了方便的API进行字节码的修改,支持直接产生二进制class文件。
ASM提供了基于事件的API,ClassReader
用于读取class文件的二进制流,ClassVisitor
以事件的形式输出class的结构信息, ClassWriter
则用于把修改后的字节码生成二进制流。
我们先以Java工程的方式演示对Class文件的处理,不考虑集成打包。
我们定义一个简单的页面MainActivity
,增加一个加了编译期注解的方法
public class MainActivity extends AppCompatActivity {
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
@TraceTime
public void fun(){
Log.d(“tt_apm”, “annotated function”);
}
}
它的class文件在工程的app/build/intermediates/classes
目录下,用ASM读取分析
public static void main(String[] args) {
try {
File classFile = new File(“./source/MainActivity.class”);
File dir = new File(“.”);
transformClassFile(dir, classFile)
} catch (Exception e){}
}
private static File transformClassFile(File dir, File sourceFile){
String className = sourceFile.getName();
// 得到class文件二进制流
FileInputStream fileInputStream = new FileInputStream(sourceFile);
byte[] sourceClassBytes = IOUtils.toByteArray(fileInputStream);
// 定义classWriter,用于输出修改后的二进制流
ClassWriter classWriter = new ClassWriter(ClassWriter.COMPUTE_MAXS);
// 自定义ClassVisitor, 负责字节码的消费
MyClassVisitor myClassVisitor = new MyClassVisitor(classWriter);
// ClassReader负责字节码的读取
ClassReader classReader = new ClassReader(sourceClassBytes);
// 开始字节码处理
classReader.accept(myClassVisitor, 0);
// 生成二进制流并保存成新的文件
byte[] destByte = classWriter.toByteArray();
File modified = new File(dir, className)
if (modified.exists()) {
modified.delete()
}
modified.createNewFile();
new FileOutputStream(modified).write(destByte)
return modified;
}
private static class MyClassVisitor extends ClassVisitor {
public MyClassVisitor(ClassVisitor classVisitor) {
super(Opcodes.ASM6, classVisitor);
}
@Override
public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
System.out.println(“visit:access: " + access + " ,name: " + name + " , superName: " + superName + " ,singature: " + signature + “, interfaces: " + interfaces.join(”/”));
super.visit(version, access, name, signature, superName, interfaces);
}
@Override
public MethodVisitor visitMethod(int access, String name, String descriptor, String signature, String[] exceptions) {
System.out.println("visitMethod:access: " + access + " ,name: " + name + " , desc: " + descriptor + " ,singature: " + signature);
MethodVisitor mv = super.visitMethod(access, name, descriptor, signature, exceptions);
MethodVisitor myMv = new MethodVisitor(Opcodes.ASM6, mv) {
@Override
AnnotationVisitor visitAnnotation(String desc, boolean visible) {
System.out.println("visitAnnotation: desc: " + desc);
return super.visitAnnotation(desc, visible)
}
@Override
void visitCode() {
super.visitCode()
}
}
return myMv;
}
}
我们用ClassReader读取了MainActivity.java
的class文件,并用自定义的ClassVisitor
接收事件。查看输出:
visit:access: 33 ,name: com/example/wangkai/MainActivity , superName: android/support/v7/app/AppCompatActivity ,singature: null, interfaces:
visitMethod:access: 1 ,name: , desc: ()V ,singature: null
visitMethod:access: 4 ,name: onCreate , desc: (Landroid/os/Bundle;)V ,singature: null
visitMethod:access: 1 ,name: fun , desc: ()V ,singature: null
visitAnnotation: desc: Lcom/example/wangkai/annotation/TraceTime;
我们通过visit
回调可以读取到class的名字、父类名和接口,这样就可以判断出一个类是否是我们要插桩的白名单页面,是不是Activity子类以及是否实现了点击事件接口View$onClickListener
(实现对点击事件的监控)
通过visitMethod
我们拿到了方法名,这样就可以判断这个方法是不是我们要监控的生命周期方法。
通过在visitMethod
方法里返回自定义的MethodVisitor
对象,我们拿到了方法上的注解,从而可以知道这个方法是否是要插桩的方法。
visitCode
表示方法开始执行,如果能在这里插入代码,那我们的代码就能在原始代码执行前执行。
我们已经找到了切入点,下一步就是插入代码了。插入代码要难一些,因为我们是在字节码层面操作,插入的也只能是字节码,这就需要对字节码有一定了解。包括局部变量表和操作数栈的概念,常见指令(ALOAD, INVOKEVIRTUAL等)的含义[参考5]
。
这里以实现监听点击事件为例。手动埋点时,我们需要插入这样的代码:
private static class MyClickListener implements View.OnClickListener{
@Override
public void onClick(View v) {
ClickAgent.click(v); //待插入代码,方法里获取view的ID和当前时间,实现对点击事件的记录
Log.d(TAG, "onClick: ");
}
}
我们要做的是,通过ASM methodVisitor
提供的API,把ClickAgent.click(v)
的字节码,注入到原始onClick
方法里。查看字节码:
L0
LINENUMBER 27 L0
ALOAD 1
INVOKESTATIC com/example/wangkai/ClickAgent.click (Landroid/view/View;)V
L1
LINENUMBER 28 L1
LDC “MainActivity”
LDC "onClick: "
INVOKESTATIC android/util/Log.d (Ljava/lang/String;Ljava/lang/String;)I
可以看到ClickAgent.click(v)
对应的字节码是两行
ALOAD 1
表示把局部变量表里索引为1的值,推到操作数栈上,也就是参数值View v
。对应到ASM,是methodVisitor.visitVarInsn(Opcodes.ALOAD, 1);
INVOKESTATIC com/example/wangkai/ClickAgent.click (Landroid/view/View;)V就是调用ClickAgent的静态方法click。对应到ASM,是methodVisitor.visitMethodInsn(Opcodes.INVOKESTATIC, “com/example/wangkai/ClickAgent”, “click”, “(Landroid/view/View;)V”, false)
当我们在visitorMethod
回调里判断name、desc和signature和原始方法一致,并且该类实现的interfaces
包含了View$onClickListener
时,就可以注入了。
怎么注入进去呢?这样写就可以了:
@Override
void visitCode() {
super.visitCode()
mv.visitVarInsn(Opcodes.ALOAD, 1);
mv.visitMethodInsn(Opcodes.INVOKESTATIC, “com/example/wangkai/ClickAgent”, “click”, “(Landroid/view/View;)V”, false)
}
修改后执行,会生成插桩后的class文件,可以用JD_GUI查看插桩后的效果,
实际编码中,我们可以借助于Bydecode Outline
插件。
怎么实现AspectJ方案里演示的对JSONObject
的反序列化监控呢?只需要将JSONObject
对应的构造函数替换成我们的函数
@Override
void visitMethodInsn(int opcode, String owner, String methodName, String descriptor, boolean isInterface) {
if(opcode == Opcodes.INVOKESPECIAL && owner.equals(“org/json/JSONObject”)
&& methodName.equals(“”) && descriptor.equals(“(Ljava/lang/String;)V”)) {
super.visitMethodInsn(Opcodes.INVOKESTATIC, “com.example.apm.JSONObjectAgent”,
“init”, “(Ljava/lang/String;)Lorg/json/JSONObject;”, false);
} else {
super.visitMethodInsn(opcode, owner, methodName, descriptor, isInterface)
}
}
插桩的问题已经解决了!
Oh, we have solved one problem.
我们再把插桩的处理过程集成到Gradle打包里就可以。
我们知道,通过在build.gradle里配置apply plugin: 'xxplugin'
,可以实现调用自定义的plugin。自定义plugin:
class ApmPlugin implements Plugin {
@Override
void apply(Project project) {
android = project.extensions.getByType(AppExtension);
ApmTransform transform = new ApmTransform(project)
android.registerTransform(transform)
}
}
apply方法会在build.gradle apply plugin: 'xxplugin'
行执行时被调用。我们在apply
方方法里注册了自定义的Transform,实现对class文件的处理。
Transform是Android gradle提供的修改class的一套API,Transform每次都是将一个输入进行处理,然后将处理结果输出,而输出的结果将会作为另一个Transform的输入。
我们在回调里可以拿到输入
class ApmTransform extends Transform {
…
@Override
void transform(
@NonNull Context context,
@NonNull Collection inputs,
@NonNull Collection referencedInputs,
@Nullable TransformOutputProvider outputProvider,
boolean isIncremental) throws IOException, TransformException, InterruptedException {
}
}
transform
回调方法里的inputs
即上一个Transform
输出的class文件目录,是本工程自己的代码文件,referencedInputs
是上一个Transform
输出的jar包,是本工程依赖的jar包。我们遍历inputs
就能拿到class文件
input.directoryInputs.each { DirectoryInput directoryInput ->
File dest = outputProvider.getContentLocation(directoryInput.name, directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY);
File dir = directoryInput.file
if (dir) {
dir.traverse(type: FileType.FILES, nameFilter: ~/.*.class/) {
File classFile ->
File modified = modifyClassFile(dir, classFile, context.getTemporaryDir()); // 修改class文件
…
最后
分享一份NDK基础开发资料
分享内容包括不限于高级UI、性能优化、架构师课程、NDK、混合式开发(ReactNative+Weex)微信小程序、Flutter等全方面的Android进阶实践技术;希望能帮助到大家,也节省大家在网上搜索资料的时间来学习,也可以分享动态给身边好友一起学习!
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门,即可获取!
dir.traverse(type: FileType.FILES, nameFilter: ~/.*.class/) {
File classFile ->
File modified = modifyClassFile(dir, classFile, context.getTemporaryDir()); // 修改class文件
…
最后
分享一份NDK基础开发资料
[外链图片转存中…(img-9naNxMYM-1715264109710)]
分享内容包括不限于高级UI、性能优化、架构师课程、NDK、混合式开发(ReactNative+Weex)微信小程序、Flutter等全方面的Android进阶实践技术;希望能帮助到大家,也节省大家在网上搜索资料的时间来学习,也可以分享动态给身边好友一起学习!
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》,点击传送门,即可获取!