private int m = 1;
public int add() {
int j = 2;
int k = m + j;
return k;
}
}
然后我们通过 javac Test.java -g来编译为Test.class,用文本编辑器打开如下:
可以看到是一堆十六进制数,但是其实这一堆十六进制数是按严格的结构拼接在一起的,按顺序分别是:魔数(cafe babe)、java版本号、常量池、访问权限标志、当前类索引、父类索引、接口索引、字段表、方法表、附加属性等十个部分,这些部分以十六进制的形式表达出来并紧凑的拼接在一起,就是上面看到的class字节码文件。
当然上面的十六进制文件显然不具备可阅读性,所以我们可以通过 javap -verbose Test来反编译,有兴趣的可以自己试一试,就可以看到上面说的十个部分,由于我们做字节码插桩一般和方法表关联比较大,所以我们下面着重看一下方法表,下面是反编译后的add()方法:
可以看到包括三部分:
**1. Code:**这里部分就是方法里的JVM指令操作码,也是最重要的一部分,因为我们方法里的逻辑实际上就是一条一条的指令操作码来完成的。
这里可以看到我们的add方法是通过9条指令操作码完成的。当然插桩重点操作的也是这一块,只要能修改指令,也就能操控任何代码了。
**2. LineNumberTable:**这个是表示行号表。是我们的java源码与指令行的行号对应。比如我们上面的add方法java源码里总共有三行,也就是上图中的line10、line11、line12,这三行对应的JVM指令行数。
有了这样的对应关系后,就可以实现比如Debug调试的功能,指令执行的时候,我们就可以定位到该指令对应的源码所在的位置。
**3. LocalVariableTable:**本地变量表,主要包括This和方法里的局部变量。从上图可以看到add方法里有this、j、k三个局部变量。
由于JVM指令集是基于栈的,上面我们已经了解到了add方法的逻辑编译为class文件后变成了9个指令操作码,下面我们简单看看这些指令操作码是如何配合操作数栈+本地变量表+常量池来执行add方法的逻辑的:
按顺序执行9条指令操作码:
0:把数字2入栈
1:将2赋值给本地变量表中的j
2、3:获取常量池中的m入栈
6:将本地变量表中的j入栈
7、8:将m和j相加,然后赋值给本地变量表中的k
9、10:将本地变量表中的k入栈,并return
好的,关于java字节码的暂时就简单介绍这些,主要是让我们基本了解字节码文件的结构,以及编译后代码时如何运行的。而ASM可以通过操作指令码来生成字节码或者插桩,当你可以利用ASM来接触到字节码,并且可以利用ASM的api来操控字节码时,就有很大的自由度来进行各种字节码的生成、修改、操作等等,也就能产生很强大的功能。
三、Gradle plugin + Transform
上面对于插桩框架的选择,我们通过对比最终选择了ASM,但是ASM只负责操作字节码,我们还需要通过自定义gradle plugin的形式来干预编译过程,在编译过程中获取到所有的class文件和jar包,然后遍历他们,利用ASM来修改字节码,达到插桩的目的。
那么干预编译的过程,我们的第一个念头可能就是,对class转为dex的任务进行hook,在class转为dex之前拿到所有的class文件,然后利用ASM对这些字节码文件进行插桩,然后再把处理过的字节码文件作为transformClassesWithDex任务的输入即可。
这种方案的好处是易于控制,我们明确的知道操作的字节码文件是最终的字节码,因为我们是在transformClassesWithDex任务的前一刻拿到字节码文件的。
缺点就是,如果项目开启了混淆,那么在transformClassesWithDex任务的前一刻拿到的字节码文件显然是经过了混淆了的,所以利用ASM操作字节码的时候还需要mapping文件进行配合才能找到正确的插桩点,这一点比较麻烦。
幸亏gradle还为我们提供了另一种干预编译转换过程的方法:Transform.其实我们稍微翻一下gradle编译过程的源码,就会发现一些我们熟知的功能都是通过Transform来实现的。
还有一点,就是关于混淆的问题,上面我们说了如果通过hook transformClassesWithDex任务的方式来实现插桩,开启混淆的情况下会出现问题,那么利用Transform的方式会不会有混淆的问题呢?
下面我们从gradle源码上面找一下答案:
我们从com.android.build.gradle.internal.TaskManager类里的createCompileTask()方法看起,显然这是一个创建编译任务的方法:
protected void createCompileTask(@NonNull VariantScope variantScope) {
//创建一个将java文件编译为class文件的任务
JavaCompile javacTask = createJavacTask(variantScope);
addJavacClassesStream(variantScope);
setJavaCompilerTask(javacTask, variantScope);
//创建一些在编译为class文件后执行的额外任务,比如一些Transform等
createPostCompilationTasks(variantScope);
}
接下来我们看看createPostCompilationTasks()方法,这个方法比较长,下面只保留重要的几个代码:
public void createPostCompilationTasks(@NonNull final VariantScope variantScope) {
、、、、、、
TransformManager transformManager = variantScope.getTransformManager();
、、、、、
// ----- External Transforms 这个就是我们自定义注册进来的Transform-----
// apply all the external transforms.
List customTransforms = extension.getTransforms();
List<List> customTransformsDependencies = extension.getTransformsDependencies();
、、、、、、
、、、、、、
// ----- Minify next 这个就是混淆代码的Transform-----
CodeShrinker shrinker = maybeCreateJavaCodeShrinkerTransform(variantScope);
、、、、、、
、、、、、、
}
其实这个方法里有很多其他Transform,这里都省略了,我们重点只看我们自定义注册的Transform和混淆代码的Transform,从上面的代码上我们自定义的Transform是在混淆Transform之前添加进TransformManager,所以执行的时候我们自定义的Transform也会在混淆之前执行的,也就是说我们利用自定义Transform的方式对代码进行插桩是不受混淆影响的。
所以我们最终确定的方案就是 Gradle plugin + Transform +ASM的技术方案。下面我们正式说说利用该技术方案进行具体实现。
3、具体实现
这里具体实现只挑重点实现步骤讲,详细的可以看具体源码,文章结尾提供了项目的github地址。
一、自定义gradle plugin
关于如何创建一个自定义gradle plugin的项目,这边就不细说了,可以网上搜索,或者直接看MethodTraceMan项目的源码也行,自定义gradle plgin继承自Plugin类,入口是apply方法,我们的apply方法里很简单,就是创建一个自定义扩展配置,然后就是注册一下我们自定义的Transform:
@Override
void apply(Project project) {
project.extensions.create(“traceMan”, TraceManConfig)
def android = project.extensions.getByType(AppExtension)
android.registerTransform(new TraceManTransform(project))
}
二、自定义Transform实现
这里我们创建了一个名叫traceMan的扩展,这样我们可以再使用这个plugin的时候进行一些配置,比如配置插桩的范围,配置是否开启插桩等,这样我们就可以根据自己的需要来配置。
接下来我们看一下TraceManTransform的实现:
public void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
println ‘[MethodTraceMan]: transform()’
def traceManConfig = project.traceMan
String output = traceManConfig.output
if (output == null || output.isEmpty()) {
traceManConfig.output = project.getBuildDir().getAbsolutePath() + File.separator + “traceman_output”
}
if (traceManConfig.open) {
//读取配置
Config traceConfig = initConfig()
traceConfig.parseTraceConfigFile()
Collection inputs = transformInvocation.inputs
TransformOutputProvider outputProvider = transformInvocation.outputProvider
if (outputProvider != null) {
outputProvider.deleteAll()
}
//遍历,分为class文件变量和jar包的遍历
inputs.each { TransformInput input ->
input.directoryInputs.each { DirectoryInput directoryInput ->
traceSrcFiles(directoryInput, outputProvider, traceConfig)
}
input.jarInputs.each { JarInput jarInput ->
traceJarFiles(jarInput, outputProvider, traceConfig)
}
}
}
}
三、利用ASM进行插桩
接下来看看遍历class文件后如何利用ASM的访问者模式进行插桩:
static void traceSrcFiles(DirectoryInput directoryInput, TransformOutputProvider outputProvider, Config traceConfig) {
if (directoryInput.file.isDirectory()) {
directoryInput.file.eachFileRecurse { File file ->
def name = file.name
//根据配置的插桩范围决定要对某个class文件进行处理
if (traceConfig.isNeedTraceClass(name)) {
//利用ASM的api对class文件进行访问
ClassReader classReader = new ClassReader(file.bytes)
ClassWriter classWriter = new ClassWriter(classReader, ClassWriter.COMPUTE_MAXS)
ClassVisitor cv = new TraceClassVisitor(Opcodes.ASM5, classWriter, traceConfig)
classReader.accept(cv, EXPAND_FRAMES)
byte[] code = classWriter.toByteArray()
FileOutputStream fos = new FileOutputStream(
file.parentFile.absolutePath + File.separator + n
《Android学习笔记总结+最新移动架构视频+大厂安卓面试真题+项目实战源码讲义》
【docs.qq.com/doc/DSkNLaERkbnFoS0ZF】 完整内容开源分享
ame)
fos.write(code)
fos.close()
}
}
}
//处理完输出给下一任务作为输入
def dest = outputProvider.getContentLocation(directoryInput.name,
directoryInput.contentTypes, directoryInput.scopes,
Format.DIRECTORY)
FileUtils.copyDirectory(directoryInput.file, dest)
}
可以看到,最终是TraceClassVisitor类里对class文件进行处理的,我们看一下
TraceClassVisitor:
class TraceClassVisitor(api: Int, cv: ClassVisitor?, var traceConfig: Config) : ClassVisitor(api, cv) {
private var className: String? = null
private var isABSClass = false
private var isBeatClass = false
private var isConfigTraceClass = false
override fun visit(
version: Int,
access: Int,
name: String?,
signature: String?,
superName: String?,
interfaces: Array?
) {
super.visit(version, access, name, signature, superName, interfaces)
this.className = name
//抽象方法或者接口
if (access and Opcodes.ACC_ABSTRACT > 0 || access and Opcodes.ACC_INTERFACE > 0) {
this.isABSClass = true
}
//插桩代码所属类
val resultClassName = name?.replace(".", “/”)
if (resultClassName == traceConfig.mBeatClass) {
this.isBeatClass = true
}
//是否是配置的需要插桩的类
name?.let { className ->
isConfigTraceClass = traceConfig.isConfigTraceClass(className)
}
}
override fun visitMethod(
access: Int,
name: String?,
desc: String?,
signature: String?,
exceptions: Array?
): MethodVisitor {
val isConstructor = MethodFilter.isConstructor(name)
//抽象方法、构造方法、不是插桩范围内的方法,则不进行插桩
return if (isABSClass || isBeatClass || !isConfigTraceClass || isConstructor) {
super.visitMethod(access, name, desc, signature, exceptions)
} else {
//TraceMethodVisitor中对方法进行插桩
val mv = cv.visitMethod(access, name, desc, signature, exceptions)
TraceMethodVisitor(api, mv, access, name, desc, className, traceConfig)
}
}
}
再来看看TraceMethodVisitor:
override fun onMethodEnter() {
super.onMethodEnter()
//利用ASM在方法进入的时候 通过插入指令调用耗时统计的方法:start()
mv.visitLdcInsn(generatorMethodName())
mv.visitMethodInsn(INVOKESTATIC, traceConfig.mBeatClass, “start”, “(Ljava/lang/String;)V”, false)
}
override fun onMethodExit(opcode: Int) {
//利用ASM在方法进入的时候 通过插入指令调用耗时统计的方法:end()
mv.visitLdcInsn(generatorMethodName())
mv.visitMethodInsn(INVOKESTATIC, traceConfig.mBeatClass, “end”, “(Ljava/lang/String;)V”, false)
}
这样,我们就可以在所有配置的在插桩范围内的方法都在方法进入的时候调用TraceMan.start()方法,在方法退出的时候调用TraceMan.end()方法进行耗时统计。
而TraceMan这个类也是可配置的,也就是你可以通过配置决定在方法进入和退出的时候调用哪个类的哪个方法。
至于TraceMan.start()和TraceMan.end()是如何实现对一个方法的耗时统计,如何输出所有方法的耗时,可以具体看源码里TraceMan类的具体实现,这里就不具体展开了。
4、UI界面展示