ASM實戰統計方法耗時

先上demo地址：https://github.com/JeasonWong/CostTime

需求

實際業務開發中有很多需要不改變原業務代碼，而需額外增加一些包括各種統計的需求，如APM、無數據埋點等，也就是耳熟能詳的AOP，本文以統計方法耗時為例，不使用Aspectj，采用原生態的方式進行實踐。

使用者所需要做的就是對所需要統計耗時的方法頭部加指定注解@Cost就可以使用了。

目標

  • 不影響現有邏輯

  • 需要統計耗時的方法頭部加上注解

  • 支持混淆

方案

方案分兩部分，一部分針對JVM，一部分針對Android平臺。

JVM

  • 自定義注解

  • 使用ASM增加字節碼

  • 反射實例化

  • 使用Instrumentation構建代理

Android

  • gradle plugin 自定義Transform Api

實踐

先讓我們的方案能在JVM上運行起來。

自定義注解

@Target(ElementType.METHOD)
public @interface Cost {
}

我們先只對方法進行耗時統計，因此Target設為Method。

使用ASM增加字節碼

首先自定義一個ClassVisitor，然后重載visitMethod方法，這樣我們便可以遍歷所有類文件的方法了，然后利用AdviceAdapter類來重新實例化一個MethodVisitor，并且重載它的visitAnnotation、onMethodEnter、onMethodExit方法，其中含義就如方法名一樣簡單明了。

然后我們通過visitAnnotation方法來判斷當前方法注解是否為我們自定義的注解，如果是指定注解，則插入代碼，具體插入代碼的內容我們接下來再講，自定義ClassVisitor的代碼如下：

public class CostClassVisitor extends ClassVisitor {

    public CostClassVisitor(ClassVisitor classVisitor) {
        super(Opcodes.ASM5, classVisitor);
    }

    @Override
    public MethodVisitor visitMethod(int access, String name, String desc, String signature, String[] exceptions) {
        MethodVisitor mv = cv.visitMethod(access, name, desc, signature, exceptions);
        mv = new AdviceAdapter(Opcodes.ASM5, mv, access, name, desc) {

            private boolean inject = false;

            @Override
            public AnnotationVisitor visitAnnotation(String desc, boolean visible) {
                if (Type.getDescriptor(Cost.class).equals(desc)) {
                    inject = true;
                }
                return super.visitAnnotation(desc, visible);
            }

            @Override
            protected void onMethodEnter() {
                if (inject) {
                    //坐等插代碼
                }
            }

            @Override
            protected void onMethodExit(int opcode) {
                if (inject) {
                    //坐等插代碼
                }
            }
        };
        return mv;
    }
}

再寫ASM插入代碼前，我們必須意識到一件事，那就是得知道我們會在onMethodEnter中存一個方法開始時間，再在onMethodExit中存一個方法結束時間，再去相減，那么問題來了，這個時間我們存哪呢？肯定不能是局部變量，因為兩個方法間并不會共享局部變量，那么本文是將變量存為靜態，方便不同方法間調用，具體可見TimeCache.java，代碼比較簡單，不多加介紹：

public class TimeCache {

    public static Map<String, Long> sStartTime = new HashMap<>();
    public static Map<String, Long> sEndTime = new HashMap<>();

    public static void setStartTime(String methodName, long time) {
        sStartTime.put(methodName, time);
    }

    public static void setEndTime(String methodName, long time) {
        sEndTime.put(methodName, time);
    }

    public static String getCostTime(String methodName) {
        long start = sStartTime.get(methodName);
        long end = sEndTime.get(methodName);
        return "method: " + methodName + " main " + Long.valueOf(end - start) + " ns";
    }

}

然后便是插入時間統計代碼了，我在之前的一篇文章就有介紹過 手摸手增加字節碼往方法體內插代碼 ，我們可以借助一個intelliJ plugin --
ASM Bytecode Outline來方便我們寫ASM代碼，先把原java代碼寫好：

System.out.println("========start=========");
TimeUtil.setsStartTime("newFunc", System.nanoTime());
        
TimeUtil.setEndTime("newFunc", System.nanoTime());
System.out.println(TimeCache.getCostTime("newFunc"));
System.out.println("========end=========");

然后利用插件，生成對應ASM代碼，刪除掉無用信息后，可得到：

mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
mv.visitLdcInsn("========start=========");
mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);

mv.visitLdcInsn(name);
mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "nanoTime", "()J", false);
mv.visitMethodInsn(INVOKESTATIC, "main/java/TimeCache", "setStartTime", "(Ljava/lang/String;J)V", false);

...

mv.visitLdcInsn(name);
mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "nanoTime", "()J", false);
mv.visitMethodInsn(INVOKESTATIC, "main/java/TimeCache", "setEndTime", "(Ljava/lang/String;J)V", false);

mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
mv.visitLdcInsn(name);
mv.visitMethodInsn(INVOKESTATIC, "main/java/TimeCache", "getCostTime", "(Ljava/lang/String;)Ljava/lang/String;", false);
mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);

mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
mv.visitLdcInsn("========end=========");
mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);

那么我們將這部分ASM代碼填充到剛剛遺留下來的CostClassVisitor.java里便可。

這樣一來，我們的ASM工作已經結束，接下來就是來讓插入的方法運行起來。

反射實例化

先來一種簡單的方案，就是將我們插入代碼后二進制流手動生成.class文件并利用反射實例化它。

首先來看看插入前的代碼：

public class Bazhang {

  public void newFunc1(String str) {
    System.out.println(str);
    for (int i = 0; i < 100; i++) {
      if (i % 10 == 0) {
        System.out.println(i);
      }
      if (i == 50) {
        return;
      }
    }
  }

  @Cost
  public void newFunc2(String str) {
    System.out.println(str);
    for (int i = 0; i < 100; i++) {
      if (i % 8 == 0) {
        System.out.println(i);
      }
      if (i > 50) {
        return;
      }
    }
  }

}

我給newFunc2方法增加了@Cost注解，但沒給newFunc1方法增加，然后開始用ASM提供的類生成插入代碼后的二進制流：

ClassReader cr = new ClassReader(Bazhang.class.getName());
ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS);
ClassVisitor cv = new CostClassVisitor(cw);

cr.accept(cv, EXPAND_FRAMES);

// 獲取生成的class文件對應的二進制流
byte[] code = cw.toByteArray();

//將二進制流寫到out/下
FileOutputStream fos = new FileOutputStream(System.getProperty("user.dir")
            + "/javademo/build/classes/main/wangyuwei/demo/Bazhang.class");
fos.write(code);
fos.close();

Demo loader = new Demo();
Class hw = loader.defineClass("wangyuwei.demo.Bazhang", code, 0, code.length);
Object o = hw.newInstance();
Method method1 = o.getClass().getMethod("newFunc1", String.class);
method1.invoke(o, "巴掌菜比");
Method method2 = o.getClass().getMethod("newFunc2", String.class);
method2.invoke(o, "巴掌菜比22");

然后run一下，可以得到：

巴掌菜比
0
10
20
30
40
50
========start=========
巴掌菜比22
0
8
16
24
32
40
48
method: newFunc2 main 1647919 ns
========end=========

只對newFunc2做了方法耗時統計。

使用Instrumentation構建代理

Instrumentation是Java5提供的新特性，關于詳細介紹，可以查看這篇文章：Java 5 特性 Instrumentation 實踐，簡單點說就是我們得在JVM執行main函數前動點手腳，自己實現一個代理，在得到虛擬機載入的正常的類的字節碼后通過ASM提供的類生成一個插入代碼后的字節流再丟給虛擬機，自定義的代理得實現ClassFileTransformer，并且提供premain()方法，寫有premain方法的類得在MANIFEST.MF中顯示調用，首先來看看我們自定義的代理類：

public class CostClassFileTransformer implements ClassFileTransformer {

    public static void premain(String args, Instrumentation inst) {
        inst.addTransformer(new CostClassFileTransformer());
    }

    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        ClassReader reader = new ClassReader(classfileBuffer);
        ClassWriter writer = new ClassWriter(reader, ClassWriter.COMPUTE_MAXS);
        reader.accept(new CostClassVisitor(writer), 8);
        return writer.toByteArray();
    }
}

再看看MANIFEST.MF：

Manifest-Version: 1.0
Premain-Class: wangyuwei.costtime.CostClassFileTransformer

這樣寫好代理類之后，我們便可以生成一個代理jar，之后為我們運行代碼使用，進入module javademo，生成jar可直接使用命令：

jar -cvfm lib/cost-time.jar src/main/META-INF/MANIFEST.MF src/main/java/wangyuwei/costtime/CostClassFileTransformer.class

得到代理jar后，再使用命令行java -javaagent: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：

public class CostTimePlugin extends Transform implements Plugin<Project> {
  @Override public void apply(Project project) {

    def android = project.extensions.getByType(AppExtension)
    android.registerTransform(this)
  }

  @Override
  String getName() {
    return "bazhang"
  }

  @Override
  Set<QualifiedContent.ContentType> getInputTypes() {
    return TransformManager.CONTENT_CLASS
  }

  @Override
  Set<QualifiedContent.Scope> getScopes() {
    return TransformManager.SCOPE_FULL_PROJECT
  }

  @Override
  boolean isIncremental() {
    return false
  }

  @Override
  void transform(Context context, Collection<TransformInput> inputs,
      Collection<TransformInput> referencedInputs, TransformOutputProvider outputProvider,
      boolean isIncremental) throws IOException, TransformException, InterruptedException {
    println '//===============asm visit start===============//'

    def startTime = System.currentTimeMillis()

    inputs.each { TransformInput input ->

      input.directoryInputs.each { DirectoryInput directoryInput ->

        //坐等遍歷class并被ASM操作

        def dest = outputProvider.getContentLocation(directoryInput.name,
            directoryInput.contentTypes, directoryInput.scopes,
            Format.DIRECTORY)


        FileUtils.copyDirectory(directoryInput.file, dest)
      }

      input.jarInputs.each { JarInput jarInput ->
        def jarName = jarInput.name
        def md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())
        if (jarName.endsWith(".jar")) {
          jarName = jarName.substring(0, jarName.length() - 4)
        }

        def dest = outputProvider.getContentLocation(jarName + md5Name,
            jarInput.contentTypes, jarInput.scopes, Format.JAR)

        FileUtils.copyFile(jarInput.file, dest)
      }
    }

    def cost = (System.currentTimeMillis() - startTime) / 1000

    println "plugin cost $cost secs"
    println '//===============asm visit end===============//'
  }
}

我們預留了一行注釋，去遍歷build/intermediates/classes/release/下面生成的所有class，當然R.class、BuildConfig.class這些我們就可以直接跳過，ASM過濾一遍插入新代碼之后再去覆蓋原class，代碼如下：

if (directoryInput.file.isDirectory()) {
    directoryInput.file.eachFileRecurse { File file ->
        def name = file.name
        if (name.endsWith(".class") && !name.startsWith("R\$") &&
            !"R.class".equals(name) && !"BuildConfig.class".equals(name)) {

            println name + ' is changing...'

            ClassReader cr = new ClassReader(file.bytes);
            ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS);
            ClassVisitor cv = new CostClassVisitor(cw);

            cr.accept(cv, EXPAND_FRAMES);

            byte[] code = cw.toByteArray();

            FileOutputStream fos = new FileOutputStream(
                file.parentFile.absolutePath + File.separator + name);
            fos.write(code);
            fos.close();
        }
    }
}

這樣一來，我們可以看看新生成的class是不是有被插入代碼。

這是源代碼MainActivity.java：

public class MainActivity extends AppCompatActivity {

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
  }

  @Cost
  public void show() {
    for (int i = 0; i < 100; i++) {

    }
  }
}

這是build/intermediates/classes/release/里的MainActivity.class：

public class MainActivity extends AppCompatActivity {
  public MainActivity() {
  }

  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    this.setContentView(2130968603);
  }

  @Cost
  public void show() {
    System.out.println("========start=========");
    TimeCache.setStartTime("show", System.nanoTime());

    for(int i = 0; i < 100; ++i) {
      ;
    }

    TimeCache.setEndTime("show", System.nanoTime());
    System.out.println(TimeCache.getCostTime("show"));
    System.out.println("========end=========");
  }
}

而且我們可以看下build過程：

:app:transformClassesWithBazhangForRelease
//===============asm visit start===============//
Demo.class is changing...
MainActivity.class is changing...
plugin cost 0.148 secs
//===============asm visit end===============//
:app:processReleaseJavaRes 
:app:transformResourcesWithMergeJavaResForRelease
:app:transformClassesAndResourcesWithProguardForRelease

我們的class操作是在混淆前的，那么此次AOP也完全不影響正常的混淆，可看混淆后的MainActivity.java：


public class MainActivity extends f {
    protected void onCreate(Bundle bundle) {
        super.onCreate(bundle);
        setContentView((int) R.layout.activity_main);
    }

    @a
    public void p() {
        System.out.println("========start=========");
        b.a("show", System.nanoTime());
        for (int i = 0; i < 100; i++) {
        }
        b.b("show", System.nanoTime());
        System.out.println(b.a("show"));
        System.out.println("========end=========");
    }
}

尾語

我們采取的方案其實大有可為，計算方法耗時只是冰山一角，包括無數據埋點、性能的監控都是可以繼續拓展的。以上方案難免有些漏洞，歡迎指出，有興趣的朋友可以一起探討。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 173,142評論 25贊 708
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具（例如配置管理，服務發現，斷路器，智...
    卡卡羅2017閱讀 134,890評論 18贊 139
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,947評論 6贊 342
  • 一個人經歷的越多， 他的抱怨就會越少。 越是優秀的人越努力； 越是富有的人越勤奮； 越是智慧的人越謙卑。 這是因為...
    李星辰1314閱讀 264評論 0贊 0
  • 每天想很多的事， 我可以來數一數。 太陽出來的時候，我想， 陽光真是溫暖。 貓一直叫的時候，我想， 它們...
    程子秋閱讀 263評論 0贊 1