插件库
因为jcenter的关停, 迁移到了jitpack, 统一到一个项目中(AndroidZ)
// 根目录build.gradle
buildscript {
dependencies {
classpath "cn.com.lasong:plugin:latest_version"
}
}
在生成最终应用包前可以对本地jar/aar包、implementation方式引入的三方库、源码进行字节码的修改
包括新增方法、新增属性、修改方法。
本插件基于javassist以及Transform实现
| java类型 | 类型签名 |
|---|---|
| byte | B |
| short | S |
| int | I |
| long | J |
| float | F |
| double | D |
| char | C |
| boolean | Z |
| void | V |
| 数组 | 例如：int[]签名为：[I |
| 类 | L全限定名;，比如String, 其签名为Ljava/lang/String;(注意后面有个分号) |
| _ | _1 |
| / | _ |
| ; | _2 |
| [ | _3 |
- 默认自动导入所有的包名, 避免繁复的加入包名的问题
-
去除 addFields 和 addMethods 属性, 统一都在 modifyMethods 数组中。
-
新增action配置, 值如下, 默认值是 修改(MODIFY) 行为
public static final String ACTION_MODIFY = "MODIFY"; public static final String ACTION_ADD_FIELD = "ADD_FIELD"; public static final String ACTION_ADD_METHOD = "ADD_METHOD"; public static final String ACTION_DEFAULT = ACTION_MODIFY;主要是考虑修改是一环扣一环的, 如果分开可能无法实现后面的修改依赖之前的修改。
按照数组的顺序执行, 可以实现后面的代码应用之前的修改。
-
修改类的修饰符
扩展参数:
modifiers: 类修饰符
-
添加type类型 deleteAt 用于删除代码
扩展参数:
type: "deleteAt" lineRange : 删除的范围, 起始行0#删除行数0
使用方式如下
[ name : "destroyItem", params : "(Landroid.view.ViewGroup;ILjava.lang.Object;)", type : "deleteAt", lineRange: "0,2" ]lineRange定义:
起始行0#删除行数0,起始行1#删除行数2
Tips:
起始行 相对于方法, 第一行是0
不加删除行数, 默认一行, 如下
起始行0,起始行1 = 起始行0#1,起始行1#1
-
添加修改变量的修饰符、变量名
扩展参数:
fieldName : 变量名 newFieldName : 修改的变量名 fieldModifiers : 变量的修饰符
使用方式如下
[ fieldName:"INDEX_NAME", newFieldName:"INDEX_NAME_2", fieldModifiers:"public static final" ] -
修改注入列表名 modifyMethods 为 injectList
-
扩展支持构造方法修改
扩展参数:
isConstructor : 是否是构造方法, true/false
使用方式如下
[ isConstructor : true, params: "(Landroid/content/Context;Landroid/util/AttributeSet;I)", type: "insertAt", lineNum:6, content: """selectedColor = Color.parseColor("#999999");""" ]
-
新增捕获异常
扩展参数:
catchType : 捕获的异常 catchContent : 异常捕获内的代码块, 必须以throw或者return结尾
使用方式如下
[ name : "run", params : "()", catchType : "java.lang.Exception", catchContent : "{ System.out.println($e); throw $e; }" ]
// 应用插件
apply plugin: 'cn.com.lasong.inject'
allInjects {
// 是否开启debug
// 打印日志 & 输出修改之后的类
// 在tmp下的transform目录下查看修改的类以及最终的jar包
injectDebug true
// 注入的节点, 区分注入的对象
injectDomains {
// 远程库, 用于标志更改的库, 名称自定义
LibraryName {
// 注入的库名
// 主要减少性能消耗, 有针对性的进行处理
// 1.implementation方式的使用[具体的引入库], 如 cn.com.lasong:widget:0.0.2
// 2.本地的jar或者aar使用[文件名, 不用后缀], 如 agora-rtc-sdk
// 3.项目源码使用[:项目名称:子项目名称1:子项目名称2],
// 3.1.如应用模块叫app, 就使用:app
// 3.2.app模块下的子模块sub, 就使用 :app:sub
group "agora-rtc-sdk"
// 新增字节码文件夹路径
clzNewDir "classes/agora"
clzNewDir "classes/base"
// 修改的字节码逻辑
clzModify = [
[
// 注入的类
// 如io.agora.rtc.video.CameraHelper
// 具体到内部类的话需要加上完整包名
// 如io.agora.rtc.video.CameraHelper$Capability
className : 'io.agora.rtc.internal.RtcEngineImpl',
// 是否注入, 默认true, 需要关闭就设置为false
isInject : true,
// 修改类的修饰符
modifiers: "public",
// 代码关联的类需要导入的包, 默认引入的库都会导入, 可根据需要再添加
importPackages: [
"java.io",
"android.util.Log",
"cn.com.lasong",
"io.agora.rtc.internal"
]
// 修改的列表
injectList : [
[
// 当前行为, 默认是MODIFY
// MODIFY : 修改方法与变量
// ADD_FIELD : 添加变量, 结合content使用
// ADD_METHOD : 添加方法, 结合content使用
action : "MODIFY",
// 是否是构造方法, 默认false
isConstructor: false,
// 方法名, 需要修改的方法
name : "checkVoipPermissions",
// 方法/构造方法参数签名
params : "(Landroid.content.Context;I)",
// 方法的内容
// 方法参数的使用跟javassist一致
content: """Log.e("Test", "checkVoipPermissions");""",
// 修改的类型
// insertBefore : 在方法的起始位置插入代码；
// insertAfter : 在方法的所有 return 语句前插入代码以确保语句能够被执行，除非遇到exception；
// insertAt : 在指定的位置插入代码；
// setBody : 将方法的内容设置为要写入的代码，当方法被 abstract修饰时，该修饰符被移除；
// deleteAt : 在方法的指定行删除代码
type : "insertAt",
// 结合insertAt使用
// 相对于方法的行数, 0表示方法开始位置
lineNum : 0
// 结合deleteAt使用
// 起始行0#删除行数0,起始行1#删除行数2
// 用,分割
lineRange: "0#1"
// 变量名
fieldName:"INDEX_NAME",
// 修改的新变量名
newFieldName:"INDEX_NAME_2",
// 变量修饰符
fieldModifiers:"public static final"
]
]
]
]
}
// 可以有多个库的修改
LibraryName2 {
...
}
}
}fix:
- update gradle from 3.5.3 to 3.6.4
- fix ArrayIndexOutOfBoundsException about spilt package name
统计gradle每个任务的耗时情况, 并按照耗时从长到短降序排列
为了找出打包慢的主要原因
// 应用插件
apply plugin: 'cn.com.lasong.time'我想修改其中的一部分代码, 但是局部变量无法重新赋值。
这个javassist不支持修改方法内的局部变量, 我的处理方式有几个。
- 如果方法内代码不多, 直接替换方法内的所有内容。
- 如果是使用返回结果的, 先把原来的方法换个方法名, 比如加个后缀, 然后新建一个跟原来一样的方法名, 调用改过方法的原来的方法。对结果再进行修改。
- 如果代码里有用到匿名类的, javassist不支持。可以在代码最后调用我们自己代码中的方法, 把需要的参数传进来进行二次修改。
匿名内部类如何修改?
匿名内部类在经过编译之后是生成了一个新的class文件, 所以我们只要把className传为匿名内部类的文件即可。
匿名内部类是按照创建的顺序从1开始命名。
比如TransferLayout的transListener动画回调处理, 是第三个创建的, 那我们的className就是 com.hitomi.tilibrary.transfer.TransferLayout$3 , 然后就跟平时修改的方式一样了。
我的项目有混淆, 需要考虑混淆的问题么?
不需要, 这个转换是在混淆之前, 混淆是在这个转换完成之后。所以不需要去管混淆。
setBody设置的方法类型丢失, 比如写的代码是
Log.d("Test", "getImageItem");
FrameLayout parentLayout = containLayoutArray.get(\$1);
if (parentLayout != null && parentLayout.getChildAt(0) instanceof TransferImage) {
return ((TransferImage) parentLayout.getChildAt(0));
}
return null;
但是最后编译之后的代码
Log.d("Test", "getImageItem");
Object object = this.containLayoutArray.get(paramInt);
return (object == null || !(object.getChildAt(0) instanceof TransferImage)) ? null : (TransferImage)object.getChildAt(0);
}
FrameLayout类型丢失了。
https://www.javassist.org/tutorial/tutorial3.html
Note that no type parameters are necessary. Since get returns an Object, an explicit type cast is needed at the caller site if the source code is compiled by Javassist. For example, if the type parameter T is String, then (String) must be inserted as follows:
Wrapper w = ...
String s = (String)w.get();
The type cast is not needed if the source code is compiled by a normal Java compiler because it will automatically insert a type cast.
意思就是源码通过普通java编译器会自动转换, 但是通过 Javassist 只能显式的强制转换 添加上强制转换的代码即可。
Log.d("Test", "getImageItem");
FrameLayout parentLayout = (FrameLayout) containLayoutArray.get(\$1);
if (parentLayout != null && parentLayout.getChildAt(0) instanceof TransferImage) {
return ((TransferImage) parentLayout.getChildAt(0));
}
return null;
出现IncompatibleClassChangeError错误, 信息关键字是
was expected to be of type direct but instead was found to be of type virtual
这是因为之前重命名了原先的方法, 新增了跟原来一样的方法, 但是方法的修饰符改了, 但是原来的方法信息还是原来的修饰符。
比如下面的错误是我把 newParentLayout 通过新增的方式, 修饰符从原来的 private 改为了 public
java.lang.IncompatibleClassChangeError: The method 'android.widget.FrameLayout com.hitomi.tilibrary.transfer.TransferAdapter.newParentLayout(android.view.ViewGroup, int)' was expected to be of type direct but instead was found to be of type virtual (declaration of 'com.hitomi.tilibrary.transfer.TransferAdapter' appears in /data/app/cn.com.lasong-f585zSw-N26AiOoC6yrWkA==/base.apk)
在修改的过程中, 出现奇怪的缺失 )、;等符号
因为javassist内的java编译器的限制, 会导致有些代码编译不过。
In the current implementation, the Java compiler included in Javassist has several limitations with respect to the language that the compiler can accept. Those limitations are:
-
The new syntax introduced by J2SE 5.0 (including enums and generics) has not been supported. Annotations are supported by the low level API of Javassist. See the javassist.bytecode.annotation package (and also getAnnotations() in CtClass and CtBehavior). Generics are also only partly supported. See the latter section for more details.
不支持J2SE 5.0引入的新语法（包括枚举和泛型）。
泛型部分支持, 泛型编译完之后实际上是具体类型。
具体说明 : https://www.javassist.org/tutorial/tutorial3.html#generics
-
Array initializers, a comma-separated list of expressions enclosed by braces { and }, are not available unless the array dimension is one.
用大括号实现的数组初始化不支持, 除非只有一个元素
-
Inner classes or anonymous classes are not supported. Note that this is a limitation of the compiler only. It cannot compile source code including an anonymous-class declaration. Javassist can read and modify a class file of inner/anonymous class.
不支持内部类或匿名类。
请注意，这仅是编译器的限制。
它不能编译包括匿名类声明的源代码。
Javassist可以读取和修改内部/匿名类的类文件。
-
Labeled continue and break statements are not supported.
continue和break不支持
-
The compiler does not correctly implement the Java method dispatch algorithm. The compiler may confuse if methods defined in a class have the same name but take different parameter lists. For example,
class A {} class B extends A {} class C extends B {} class X { void foo(A a) { .. } void foo(B b) { .. } }
If the compiled expression is x.foo(new C()), where x is an instance of X, the compiler may produce a call to foo(A) although the compiler can correctly compile foo((B)new C()).
编译器没有正确地实现Java方法分派算法。
如果类中定义的方法具有相同的名称但具有不同的参数列表，编译器可能会混淆。
如果编译表达式是x.foo(new C())，其中x是x的一个实例，
尽管编译器可以正确地编译foo((B)new C())，
但是编译器可能会产生一个对foo(A)的调用。
-
The users are recommended to use # as the separator between a class name and a static method or field name. For example, in regular Java, javassist.CtClass.intType.getName() calls a method getName() on the object indicated by the static field intType in javassist.CtClass. In Javassist, the users can write the expression shown above but they are recommended to write:
javassist.CtClass#intType.getName() so that the compiler can quickly parse the expression.
建议在静态方法/变量之前使用 # 修饰, 这样编译器可以更快的解析表达式。