强大！ASM 插桩实现 Android 端无埋点性能监控！

上面的代码就已经实现了无埋点进行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文件

…

}

…

注意到，修改class文件这部分，我们在之前的Java工程里已经实现了！

最后

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数初中级Android工程师，想要提升技能，往往是自己摸索成长，自己不成体系的自学效果低效漫长且无助。

因此我收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！
开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**

[外链图片转存中…(img-92cVUoDs-1715905723690)]

[外链图片转存中…(img-bQyRIBP1-1715905723692)]

[外链图片转存中…(img-rSZxQW69-1715905723693)]

[外链图片转存中…(img-CnCDb9yL-1715905723694)]

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点！不论你是刚入门Android开发的新手，还是希望在技术上不断提升的资深开发者，这些资料都将为你打开新的学习之门

如果你觉得这些内容对你有帮助，需要这份全套学习资料的朋友可以戳我获取！！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！