Android字节码插桩优化双击

背景

产品想对多次快速点击做一下优化,想要的效果就是双击不会打开多次。
但是从开发角度来说,我可以用kotlin的拓展方法来调整这个,但是之前的历史债务可能会把我让我有点手足无措,同时java代码也会有问题。
有没有什么方法可以让开发可以投机取巧呢,我想到了去年项目里写到的插桩埋点的方式,是不是我只要在编译的时候编织插入字节码就可以解决这个问题了。

transform简介

在打包流程中,我们知道生成.class文件后,利用dx工具生成.dex文件,而利用Transform API可以在生成.class文件后修改.class文件,从而修改源码。我们将Transform注册到AppExtension中,在java compile Task执行后会执行Tramsform类型的task。

具体开发

初始化

首先先创建一个groovy的module,然后初始化一个gradle插件。

声明一个gradle-plugins 这个基础
https://blog.csdn.net/a296777513/article/details/90665134 这个博客内有基础的流程操作

构建transform

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class DoubleTabTransform extends Transform {

Project project

DoubleTabTransform(Project project) {
this.project = project
}

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

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

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

@Override
boolean isIncremental() {
return false
}

@Override
void transform(TransformInvocation transformInvocation) throws TransformException, InterruptedException, IOException {
final DoubleTapDelegate injectHelper = new DoubleTapDelegate()
BaseTransform baseTransform = new BaseTransform(transformInvocation, new TransformCallBack() {

@Override
byte[] processJarClass(String className, byte[] classBytes, BaseTransform transform) {
if (ClassUtils.checkClassName(className)) {
return injectHelper.transformByte(classBytes)
} else {
return null
}
}

@Override
File processClass(File dir, File classFile, File tempDir, BaseTransform transform) {
String absolutePath = classFile.absolutePath.replace(dir.absolutePath + File.separator, "")
String className = ClassUtils.path2Classname(absolutePath)
if (ClassUtils.checkClassName(className)) {
return injectHelper.beginTransform(className, classFile, transform.context.getTemporaryDir())
} else {
return null
}
}
})
baseTransform.startTransform()
}
}

上述代码对transform 以及classvisitor代码进行了一次抽象封装,方便后续如果有类似的插入逻辑可以快速接入开发。
主要的逻辑代码是对jar包以及.class文件进行扫描,当文件符合修改标砖的情况下会回调文件修改的方法,然后基于asm的classvisitor 对文件进行访问操作。

ClassVisitor机制

这个可以看下网上的资料,我这边就不多过于简述了, 简单的说就是构造了一个类访问器,然后顺序的读取类的所以属性,方法,以及方法的每一行。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class ClassFilterVisitor extends ClassVisitor {

private String[] interfaces
boolean visitedStaticBlock = false
private String owner

ClassFilterVisitor(ClassVisitor classVisitor) {
super(Opcodes.ASM5, classVisitor)
}

@Override
void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
super.visit(version, access, name, signature, superName, interfaces)
this.interfaces = interfaces
if (interfaces != null && interfaces.length > 0) {
for (Map.Entry<String, MethodCell> entry : MethodHelper.sInterfaceMethods.entrySet()) {
MethodCell cell = entry.value
if (cell != null && interfaces.contains(cell.parent)) {
visitedStaticBlock = true
this.owner = name
cv.visitField(Opcodes.ACC_PRIVATE + Opcodes.ACC_FINAL, "doubleTap",
"Lcom/hellobike/doubleclickplugin/sample/test/DoubleTapCheck;",
signature, null)
}
}
}
}

@Override
FieldVisitor visitField(int access, String name, String descriptor, String signature, Object value) {
return super.visitField(access, name, descriptor, signature, value)
}

@Override
MethodVisitor visitMethod(int access, String name,
String desc, String signature, String[] exceptions) {
if (interfaces != null && interfaces.length > 0) {
try {
if (visitedStaticBlock && name == "<init>") {
MethodVisitor methodVisitor = cv.visitMethod(access, name, desc, signature, exceptions)
return new InitBlockVisitor(methodVisitor, owner)
}
MethodCell cell = MethodHelper.sInterfaceMethods.get(name + desc)
if (cell != null && interfaces.contains(cell.parent)) {
MethodVisitor methodVisitor = cv.visitMethod(access, name, desc, signature, exceptions)
CheckVisitor mv = new CheckVisitor(methodVisitor, owner)
return mv
}
} catch (Exception e) {
e.printStackTrace()
}
}
return super.visitMethod(access, name, desc, signature, exceptions)
}

}

修改前的类

1
2
3
4
5
6
7
8
9
public class TestJavaClickListener implements View.OnClickListener {
@Override
public void onClick(View v) {
Log.i("onClick", "1");
Log.i("onClick", "2");
Log.i("onClick", "3");
Log.i("onClick", "4");
}
}

修改后的类

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
public class TestJavaClickListener implements OnClickListener {
private final DoubleTapCheck doubleTap = new DoubleTapCheck();

public TestJavaClickListener() {
}

public void onClick(View var1) {
if (this.doubleTap.isNotDoubleTap()) {
Log.i("onClick", "1");
Log.i("onClick", "2");
Log.i("onClick", "3");
Log.i("onClick", "4");
}
}
}

这个就是项目内的类访问器,其中visit方法代表类被访问了,会返回这个类继承的接口等等基础参数。
我在这个方法插入了一个引用的索引,简单的说声明了一个 DoubleTapCheck doubleTap;
然后就是classvistior的visitMethod,这个是我们主要要调整的地方,其中一个关键点是我们需要修改两个地方,一个类的初始化,另外一个onClick方法。

其中init方法我们回去给doubletap 完成初始化操作,下面我们来讲下InitBlockVisitor。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class InitBlockVisitor extends MethodVisitor {
private String owner;

InitBlockVisitor(MethodVisitor mv, String owner) {
super(Opcodes.ASM5, mv);
this.owner = owner;
}

@Override
public void visitInsn(int opcode) {
if ((opcode >= Opcodes.IRETURN && opcode <= Opcodes.RETURN)
|| opcode == Opcodes.ATHROW) {
mv.visitVarInsn(Opcodes.ALOAD, 0);
mv.visitTypeInsn(Opcodes.NEW, "com/hellobike/doubleclickplugin/sample/test/DoubleTapCheck");
mv.visitInsn(Opcodes.DUP);
mv.visitMethodInsn(Opcodes.INVOKESPECIAL, "com/hellobike/doubleclickplugin/sample/test/DoubleTapCheck",
"<init>", "()V", false);
mv.visitFieldInsn(Opcodes.PUTFIELD, owner, "doubleTap",
"Lcom/hellobike/doubleclickplugin/sample/test/DoubleTapCheck;");
}
super.visitInsn(opcode);
}

}

上述代码只完成了一件事情,就是在init 之后执行new DoubleTapCheck();这个操作。
这边我使用了asm的一个idea的插件 ASM ByteCode Viewer ,借助这个类你可以简单的把你想插入的代码的字节码都观察出来,之后再去用asm插入你想要的代码。

最后我们修改了onClick方法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

public class CheckVisitor extends MethodVisitor {
private String owner;

CheckVisitor(MethodVisitor mv, String owner) {
super(Opcodes.ASM5, mv);
this.owner = owner;
}

@Override
public void visitCode() {
mv.visitVarInsn(Opcodes.ALOAD, 0);
mv.visitFieldInsn(Opcodes.GETFIELD, owner, "doubleTap",
"Lcom/hellobike/doubleclickplugin/sample/test/DoubleTapCheck;");
mv.visitMethodInsn(Opcodes.INVOKEVIRTUAL, "com/hellobike/doubleclickplugin/sample/test/DoubleTapCheck",
"isNotDoubleTap", "()Z", false);
Label label = new Label();
mv.visitJumpInsn(Opcodes.IFNE, label);
mv.visitInsn(Opcodes.RETURN);
mv.visitLabel(label);
super.visitCode();
}
}

这个代码就比较少了,他只做了一件事情,就是在onClick方法的最前面插入doubleTap.isNotDoubleTap()的逻辑判断。

条件语句与label分析

下面是一个OnClickListener 的插桩字节码,我们会通过分析这个类了解label的用法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
public class com/hellobike/doubleclickplugin/sample/TestJavaClickListener implements android/view/View$OnClickListener {

// access flags 0x609
public static abstract INNERCLASS android/view/View$OnClickListener android/view/View OnClickListener

// access flags 0x12
private final Lcom/hellobike/doubleclickplugin/sample/test/DoubleTapCheck; doubleTap

// access flags 0x1
public <init>()V
ALOAD 0
INVOKESPECIAL java/lang/Object.<init> ()V
ALOAD 0
NEW com/hellobike/doubleclickplugin/sample/test/DoubleTapCheck
DUP
INVOKESPECIAL com/hellobike/doubleclickplugin/sample/test/DoubleTapCheck.<init> ()V
PUTFIELD com/hellobike/doubleclickplugin/sample/TestJavaClickListener.doubleTap : Lcom/hellobike/doubleclickplugin/sample/test/DoubleTapCheck;
RETURN
MAXSTACK = 3
MAXLOCALS = 1

// access flags 0x1
public onClick(Landroid/view/View;)V
ALOAD 0
GETFIELD com/hellobike/doubleclickplugin/sample/TestJavaClickListener.doubleTap : Lcom/hellobike/doubleclickplugin/sample/test/DoubleTapCheck;
INVOKEVIRTUAL com/hellobike/doubleclickplugin/sample/test/DoubleTapCheck.isNotDoubleTap ()Z
IFNE L0
RETURN
L0
LDC "onClick"
LDC "1"
INVOKESTATIC android/util/Log.i (Ljava/lang/String;Ljava/lang/String;)I
POP
LDC "onClick"
LDC "2"
INVOKESTATIC android/util/Log.i (Ljava/lang/String;Ljava/lang/String;)I
POP
LDC "onClick"
LDC "3"
INVOKESTATIC android/util/Log.i (Ljava/lang/String;Ljava/lang/String;)I
POP
LDC "onClick"
LDC "4"
INVOKESTATIC android/util/Log.i (Ljava/lang/String;Ljava/lang/String;)I
POP
RETURN
MAXSTACK = 2
MAXLOCALS = 2
}

我们从第24行开始观察起。首先我们获取了0位置就是view,然后我们获取了doubleTap 的实例,调用了doubleTab.isNotDoubleTap 的方法。
27行是关键,这里判断的isNotDoubleTap的结果然后跳转到下面的方法块。其中最后有个L0,我一开始也不能理解这个是什么意思,最后用javap解析了字节码之后发现其实这个L0其实映射到的是下面的方法块的L0,而在真实的字节码中,这个就是对应的行数。而这个地方就是我们使用的Label标签,那么label标签顾名思义,就是标记一个方法块的行数。就是两个label之间的代码行数。