字节码插桩实战 javassit + gradle transform + annotation 统计方法耗时

前言：上一篇我们简单介绍了下字节码插桩过程，这里主要介绍如何通过一行注解来实现统计方法耗时。
在做app启动耗时优化的时候，我们是有这个需求的，虽然可以通过profile来查看。

javassit

介绍：Javassist是一个动态类库，可以用来检查、”动态”修改以及创建 Java类。其功能与jdk自带的反射功能类似，但比反射功能更强大。

常用类：

• ClassPool：javassist的类池，使用ClassPool类可以跟踪和控制所操作的类,它的工作方式与 JVM类装载器非常相似，

• CtClass： CtClass提供了检查类数据（如字段和方法）以及在类中添加新字段、方法和构造函数、以及改变类、父类和接口的方法。不过Javassist 并未提供删除类中字段、方法或者构造函数的任何方法。

• CtField：用来访问域

• CtMethod ：用来访问方法

• CtConstructor：用来访问构造器

gradle transform

transform.png

getName：用于指明本Transform的名字，这个 name 并不是最终的名字，在TransformManager 中会对名字再处理

getInputTypes：用于指明Transform的输入类型，可以作为输入过滤的手段

–CLASSES表示要处理编译后的字节码，可能是 jar 包也可能是目录

 –RESOURCES表示处理标准的 java 资源

getScopes：用于指明Transform的作用域

–PROJECT                         只处理当前项目

–SUB_PROJECTS  只处理子项目

–PROJECT_LOCAL_DEPS  只处理当前项目的本地依赖,例如jar, aar

–EXTERNAL_LIBRARIES  只处理外部的依赖库

–PROVIDED_ONLY  只处理本地或远程以provided形式引入的依赖库

–TESTED_CODE                         只处理测试代码

isIncremental：用于指明是否是增量构建。

transform：核心方法，用于自定义处理,在这个方法中我们可以拿到要处理的.class文件路径、jar包路径、输出文件路径等，拿到文件之后就可以对他们进行操作

inputs.each { TransformInput input ->
            input.directoryInputs.each { DirectoryInput directoryInput ->
                if (directoryInput.file.isDirectory()) {
                    println "==== directoryInput.file = " + directoryInput.file
                    directoryInput.file.eachFileRecurse { File file ->
                        // ...对目录进行插入字节码
                    }
                }
                //处理完输入文件之后，要把输出给下一个任务
                def dest = outputProvider.getContentLocation(directoryInput.name, directoryInput.contentTypes, directoryInput.scopes, Format.DIRECTORY)
                FileUtils.copyDirectory(directoryInput.file, dest)
            }

input.jarInputs.each { JarInput jarInput ->
                println "------=== jarInput.file === " + jarInput.file.getAbsolutePath()
                File tempFile = null
                if (jarInput.file.getAbsolutePath().endsWith(".jar")) {
                    // ...对jar进行插入字节码
                }
                /**
                 * 重名输出文件,因为可能同名,会覆盖
                 */
                def jarName = jarInput.name
                def md5Name = DigestUtils.md5Hex(jarInput.file.getAbsolutePath())
                if (jarName.endsWith(".jar")) {
                    jarName = jarName.substring(0, jarName.length() - 4)
                }
                //处理jar进行字节码注入处理
                def dest = outputProvider.getContentLocation(jarName + md5Name, jarInput.contentTypes, jarInput.scopes, Format.JAR)
                FileUtils.copyFile(jarInput.file, dest)
            }
        }

实现步骤

1. 注解类

annatation.png

2. gradle插件去注册transform

gradle插件的使用请移步 gradle插件

plugin.png

3. transform 操作文件的实现步骤

transformImpl.png

4. 拿到文件后使用javassit操作

ssit1.png

ssit2.png

ssit3.png

5. 将gradle插件 和 注解lib 上传maven 供app依赖引用

gradle插件上传maven
Android lib 上传maven

depend.png

test.png

6. 重新rebuild一下

compileresult.png

可见class文件中test方法已经被插入了我们想要的代码

7. run下看看结果

clickcosttime.png

后记

这里只是提供了一种启动优化做耗时检测的场景，还有可以根据注解去做无痕埋点，用户的一些主流程操作链路分析等等。

代码地址

源码