前言

做項(xiàng)目優(yōu)化時(shí)，我們通常會先打印出方法的執(zhí)行時(shí)間，再根據(jù)方法的耗時(shí)情況對其進(jìn)行優(yōu)化拐纱。代碼如下：

public static void main(String[] args) {
        long startTime = System.currentTimeMillis(); 
        //...
        long endTime = System.currentTimeMillis(); 
        System.out.println("程序運(yùn)行時(shí)間： " + (endTime - startTime) + "ms");
    }

如果是一兩個(gè)方法我們手動插入代碼沒有問題铜异，但是整個(gè)項(xiàng)目的方法何其多，都要我們手動去插入的話秸架，估計(jì)能把C揍庄、V兩鍵扣廢掉。那么有沒有一種優(yōu)雅的方式實(shí)現(xiàn)耗時(shí)打印呢东抹？當(dāng)然有的蚂子，這就是今天要介紹的主角 ASM (字節(jié)碼插樁)。

有同學(xué)到這里可能就會問缭黔，我不會寫ASM代碼該怎么辦呢食茎？

悄悄的跟你說，其實(shí)我也不會寫ASM代碼馏谨。

那這會影響到我們的開發(fā)嗎别渔？

當(dāng)然不會了，如果有影響就不會有這篇文章了惧互。

ASM Bytecode Viewer

ASM Bytecode Viewer是一款能 查看字節(jié)碼 和 生成ASM代碼 的插件哎媚，是幫助我們學(xué)習(xí)ASM的利器，剩下就是對ASM的熟悉和使用可以說是so easy喊儡。

• 在Android Studio中搜索 ASM Bytecode Viewer Support Kotlin 找到并安裝拨与。
• 代碼右鍵 ASM Bytecode Viewer 便能自動生成ASM插樁代碼。

ASM 和 ASM Bytecode Viewer 我在之前的文章 最通俗易懂的字節(jié)碼插樁實(shí)戰(zhàn)（Gradle + ASM）—— 自動埋點(diǎn) 已經(jīng)介紹過了管宵，有不了解的同學(xué)可以翻看一下截珍。具體使用方法我會在后面的編碼階段詳細(xì)介紹。

實(shí)戰(zhàn)

至此我們已經(jīng)做了大量的準(zhǔn)備工作箩朴，現(xiàn)在就正式進(jìn)入實(shí)戰(zhàn)環(huán)節(jié)岗喉。
首先創(chuàng)建一個(gè)module作為插件開發(fā)，再刪除掉多余的文件炸庞，然后創(chuàng)建groovy目錄供代碼編寫……
PS：由于gradle插件開發(fā)并不是我們今天的任務(wù)钱床，這里就不過多的展開說明了，具體代碼可在 github 上查看埠居，module目錄結(jié)構(gòu)如下：

1查牌、StatisticPlugin

我們本次編寫的插件，在apply 方法的注冊 MethodTimerTransform滥壕，并讀取 build.gradle 里面配置信息纸颜。

class StatisticPlugin implements Plugin<Project> {

    public static List<MethodTimerEntity> METHOD_TIMER_LIST

    @Override
    void apply(Project project) {
        def android = project.extensions.findByType(AppExtension)
        // 注冊Transform
        android.registerTransform(new MethodTimerTransform())
        // 獲取gradle里面配置的埋點(diǎn)信息
        def statisticExtension = project.extensions.create('statistic', StatisticExtension)
        project.afterEvaluate {
            // 獲取方法計(jì)時(shí)信息，將其保存在METHOD_TIMER_LIST方便調(diào)用
            METHOD_TIMER_LIST = new ArrayList<>()
            def methodTimer = statisticExtension.getMethodTimer()
            if (methodTimer != null) {
                methodTimer.each { Map<String, Object> map ->
                    MethodTimerEntity entity = new MethodTimerEntity()
                    if (map.containsKey("time")) {
                        entity.time = map.get("time")
                    }
                    if (map.containsKey("owner")) {
                        entity.owner = map.get("owner")
                    }
                    METHOD_TIMER_LIST.add(entity)
                }
            }
        }
    }
}

2绎橘、MethodTimerTransform

通過transform 方法的 Collection<TransformInput> inputs 對 .class文件遍歷拿到所有方法胁孙。

class MethodTimerTransform extends Transform {

    ...省略中間非關(guān)鍵代碼，詳細(xì)請到github中查看...

    /**
     *
     * @param context
     * @param inputs 有兩種類型，一種是目錄涮较，一種是 jar 包稠鼻，要分開遍歷
     * @param outputProvider 輸出路徑
     */
    @Override
    void transform(
            @NonNull Context context,
            @NonNull Collection<TransformInput> inputs,
            @NonNull Collection<TransformInput> referencedInputs,
            @Nullable TransformOutputProvider outputProvider,
            boolean isIncremental
    ) throws IOException, TransformException, InterruptedException {
        if (!incremental) {
            //不是增量更新刪除所有的outputProvider
            outputProvider.deleteAll()
        }
        inputs.each { TransformInput input ->
            //遍歷目錄
            input.directoryInputs.each { DirectoryInput directoryInput ->
                handleDirectoryInput(directoryInput, outputProvider)
            }
            // 遍歷jar 第三方引入的 class
            input.jarInputs.each { JarInput jarInput ->
                handleJarInput(jarInput, outputProvider)
            }
        }
    }

}

3、MethodTimerClassVisitor

通過visitMethod拿到方法進(jìn)行修改狂票。

class MethodTimerClassVisitor extends ClassVisitor {

    ...省略中間非關(guān)鍵代碼候齿，詳細(xì)請到github中查看...

    /**
     * 掃描類的方法進(jìn)行調(diào)用
     * @param access 修飾符
     * @param name 方法名字
     * @param descriptor 方法簽名
     * @param signature 泛型信息
     * @param exceptions 拋出的異常
     * @return
     */
    @Override
    MethodVisitor visitMethod(int methodAccess, String methodName, String methodDescriptor, String signature, String[] exceptions) {
        MethodVisitor methodVisitor = super.visitMethod(methodAccess, methodName, methodDescriptor, signature, exceptions)
        if ((methodAccess & Opcodes.ACC_INTERFACE) == 0 && "<init>" != methodName && "<clinit>" != methodName) {
            methodVisitor = new MethodTimerAdviceAdapter(api, methodVisitor, methodAccess, methodName, methodDescriptor)
        }
        return methodVisitor
    }

}

4、MethodTimerAdviceAdapter

這里就是我們插入打印方法耗時(shí)的地方了闺属，可以看到代碼沒有很多慌盯。

• onMethodEnter在方法進(jìn)入時(shí)調(diào)用，我們先在這里插入一個(gè)時(shí)間戳屋剑，標(biāo)記方法開始的時(shí)間润匙。
• onMethodExit在方法退出前調(diào)用诗眨，這里我們也插入一個(gè)時(shí)間戳唉匾，標(biāo)記方法結(jié)束的時(shí)間。最后把兩個(gè)時(shí)間戳相減得到方法耗時(shí)時(shí)間并打印匠楚。

聽完解釋后是不是覺得非常簡單呢巍膘。

大家最關(guān)心的編（sheng）寫（cheng）ASM代碼，今天它來了芋簿。

1. 首先我們創(chuàng)建一個(gè)Test類峡懈，先用java代碼來實(shí)現(xiàn)我們的需求与斤，代碼如下：

public class Test {

    public static void main(String[] args) {
        long startTime = System.currentTimeMillis();
        String str = "--- I'm the code line ---";
        long endTime = System.currentTimeMillis();
        long time = endTime - startTime;
        if(time > 500){
            System.out.println("程序運(yùn)行時(shí)間： " + time + "ms");
        }
    }

}

細(xì)心的同學(xué)會發(fā)現(xiàn)代碼中有一段分割線字符串 String str = "--- I'm the code line ---";
前面說過方法進(jìn)入時(shí)和方法退出前分別是 onMethodEnter 和 onMethodExit肪康，因此我們通過分割線字符串來判斷代碼插入的時(shí)機(jī)撩穿。
分割線字符之前的代碼在 onMethodEnter 插入雾狈，分割線字符之后的代碼在onMethodExit插入。

2. 代碼右鍵 ASM Bytecode Viewer 自動生成ASM插樁代碼呻畸，生成代碼如下：

        {
            methodVisitor = classWriter.visitMethod(ACC_PUBLIC | ACC_STATIC, "main", "([Ljava/lang/String;)V", null, null);
            methodVisitor.visitParameter("args", 0);
            methodVisitor.visitCode();
            methodVisitor.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
            methodVisitor.visitVarInsn(LSTORE, 1);
            methodVisitor.visitLdcInsn("--- I'm the code line ---");
            methodVisitor.visitVarInsn(ASTORE, 3);
            methodVisitor.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false);
            methodVisitor.visitVarInsn(LSTORE, 4);
            methodVisitor.visitVarInsn(LLOAD, 4);
            methodVisitor.visitVarInsn(LLOAD, 1);
            methodVisitor.visitInsn(LSUB);
            methodVisitor.visitVarInsn(LSTORE, 6);
            methodVisitor.visitVarInsn(LLOAD, 6);
            methodVisitor.visitLdcInsn(new Long(500L));
            methodVisitor.visitInsn(LCMP);
            Label label0 = new Label();
            methodVisitor.visitJumpInsn(IFLE, label0);
            methodVisitor.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;");
            methodVisitor.visitTypeInsn(NEW, "java/lang/StringBuilder");
            methodVisitor.visitInsn(DUP);
            methodVisitor.visitMethodInsn(INVOKESPECIAL, "java/lang/StringBuilder", "<init>", "()V", false);
            methodVisitor.visitLdcInsn("\u7a0b\u5e8f\u8fd0\u884c\u65f6\u95f4\uff1a ");
            methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false);
            methodVisitor.visitVarInsn(LLOAD, 6);
            methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(J)Ljava/lang/StringBuilder;", false);
            methodVisitor.visitLdcInsn("ms");
            methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false);
            methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "toString", "()Ljava/lang/String;", false);
            methodVisitor.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false);
            methodVisitor.visitLabel(label0);
            methodVisitor.visitInsn(RETURN);
            methodVisitor.visitMaxs(4, 8);
            methodVisitor.visitEnd();
        }

我們把 methodVisitor.visitCode(); 之后 methodVisitor.visitLdcInsn("--- I'm the code line ---"); 之前的代碼插入到 onMethodEnter 伤为。把 methodVisitor.visitLdcInsn("--- I'm the code line ---"); 之后 methodVisitor.visitInsn(RETURN); 之前的代碼插入到 onMethodExit 咒循。

最終的 MethodTimerAdviceAdapter 代碼如下：

class MethodTimerAdviceAdapter extends AdviceAdapter {

    int slotIndex

    ...省略中間非關(guān)鍵代碼，詳細(xì)請到github中查看...

    @Override
    protected void onMethodEnter() {
        super.onMethodEnter()
        for (MethodTimerEntity entity : StatisticPlugin.METHOD_TIMER_LIST) {
            if (methodOwner.contains(entity.getOwner())) {
                slotIndex = newLocal(Type.LONG_TYPE)
                mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false)
                mv.visitVarInsn(LSTORE, slotIndex)
            }
        }
    }

    @Override
    void onMethodExit(int opcode) {
        for (MethodTimerEntity entity : StatisticPlugin.METHOD_TIMER_LIST) {
            if (methodOwner.contains(entity.getOwner())) {
                mv.visitMethodInsn(INVOKESTATIC, "java/lang/System", "currentTimeMillis", "()J", false)
                mv.visitVarInsn(LLOAD, slotIndex)
                mv.visitInsn(LSUB)
                mv.visitVarInsn(LSTORE, slotIndex)
                mv.visitVarInsn(LLOAD, slotIndex)
                mv.visitLdcInsn(new Long(entity.getTime()))
                mv.visitInsn(LCMP)
                Label label0 = new Label()
                mv.visitJumpInsn(IFLE, label0)
                mv.visitFieldInsn(GETSTATIC, "java/lang/System", "out", "Ljava/io/PrintStream;")
                mv.visitTypeInsn(NEW, "java/lang/StringBuilder")
                mv.visitInsn(DUP)
                mv.visitMethodInsn(INVOKESPECIAL, "java/lang/StringBuilder", "<init>", "()V", false)
                mv.visitLdcInsn(methodOwner + "/" + methodName + " --> execution time : (")
                mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false)
                mv.visitVarInsn(LLOAD, slotIndex)
                mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(J)Ljava/lang/StringBuilder;", false)
                mv.visitLdcInsn("ms)")
                mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "append", "(Ljava/lang/String;)Ljava/lang/StringBuilder;", false)
                mv.visitMethodInsn(INVOKEVIRTUAL, "java/lang/StringBuilder", "toString", "()Ljava/lang/String;", false)
                mv.visitMethodInsn(INVOKEVIRTUAL, "java/io/PrintStream", "println", "(Ljava/lang/String;)V", false)
                mv.visitLabel(label0)
            }
        }
        super.onMethodExit(opcode)
    }

}

---這里畫個(gè)重點(diǎn)---

局部變量表(Local Variable Table) 是一組變量值存儲空間，用于存放方法參數(shù)和方法內(nèi)定義的局部變量剑鞍。具體的順序是 this-方法接收的參數(shù)－方法內(nèi)定義的局部變量 昨凡。而我們通過 ASM Bytecode Viewer 生成的ASM代碼是1，2蚁署，3按順序?qū)懰赖谋慵梗晕覀兺ㄟ^ newLocal(type) 來重新獲取壓入的位置 slotIndex 把參數(shù)壓入到局部變量表中。

5光戈、 如何使用哪痰？

5.1、 先打包插件到本地倉庫進(jìn)行引用

5.2久妆、 在項(xiàng)目的根build.gradle加入插件的依賴

    repositories {
        google()
        mavenCentral()
        jcenter()
        maven{
            url uri('repos')
        }
    }
    dependencies {
        classpath "com.android.tools.build:gradle:$gradle_version"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.meituan.android.walle:plugin:1.1.7'
        // 使用自定義插件
        classpath 'com.example.plugin:statistic:1.0.0'
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }

5.3晌杰、 在app的build.gradle中使用并配置參數(shù)

plugins {
    id 'com.android.application'
    id 'statistic'
}

statistic {
        methodTimer = [
            [
                    // 打印大于time的方法
                    'time'  : 500L,
                    // 需要打印方法的范圍
                    'owner': 'com/example/fragment',
            ],
            [
                    'time'  : 5000L,
                    'owner': 'com/google',
            ]
    ]
}

6、 運(yùn)行項(xiàng)目查看輸出日志

2021-07-20 11:31:51.915 12028-12060/com.example.fragment.project.debug I/System.out: com/example/fragment/library/base/http/SimpleHttp$get$2/invokeSuspend --> execution time : (2066ms)
2021-07-20 11:31:52.565 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/library/common/utils/WanHelper/setTreeList --> execution time : (1184ms)
2021-07-20 11:31:52.565 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/project/model/MainViewModel$getTree$1/invokeSuspend --> execution time : (1184ms)
2021-07-20 11:31:53.768 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/library/common/utils/WanHelper/setTreeList --> execution time : (1186ms)
2021-07-20 11:31:53.768 12028-12028/com.example.fragment.project.debug I/System.out: com/example/fragment/module/system/model/SystemViewModel$getTree$1/invokeSuspend --> execution time : (1186ms)

Thanks

以上就是本篇文章的全部內(nèi)容筷弦，如有問題歡迎指出肋演，我們一起進(jìn)步。
如果喜歡的話希望點(diǎn)個(gè)贊吧烂琴，您的鼓勵(lì)是我前進(jìn)的動力爹殊。
謝謝~~

項(xiàng)目地址

• github： https://github.com/miaowmiaow