Javassist基础与实践

概述

对于Javassist可理解成在java语言层面上来操纵java字节码的一种工具。经典应用场景是在构建java代码阶段直接修改字节码，如代码插桩。

特点：

• 更改原有class：增、删和修改class中的字段或方法；修改类的继承结构
• 新增class：增加字段、方法、构造方法；注意不能新增接口。
• 新增接口：只适用于接口
• 新增注解：用于创建注解

核心基础

1. CtClass：Javassist并不是直接操纵java字节码文件（class），而是将class封装抽象成CtClass，再使用CtClass来完成class的修改。

   • 获取CtClass：借助于ClassPool.get(String classname)方法，classname必须是全限定类名。
   • 输出文件：对于CtClass的修改仅是内存上的，如果需要持久化的修改则需要借助于CtClass.writeFile方法，输出路径：rootProject/包名/类.class
   • CtClass状态：分为冻结与解冻状态，当CtClass执行了writeFile、toClass或 toBytecode方法后CtClass会进入冻结状态，处于冻结状态的CtClass不能被修改。
   • 冻结与解冻：使用freeze方法对CtClass冻结，使用defrost方法对CtClass解冻。
   • 继承与实现：修改类继承结构，extend使用setSuperclass方法，implements则使用setInterfaces方法。

2. ClassPool：专门用于存放CtClass容器，所有的CtClass对象实例必须使用ClassPool来获取。

   • 获取CtClass范围：默认ClassPool所获取到的CtClass范围除了本工程代码，还包括java、javax以及classpath配置中的路径，至于远程路径则需要额外的配置。
   • 新增CtClass：makeClass用于创建新的字节码文件，注意不能创建接口，但能创建抽象类。
   • 新增接口：makeInterface专门用于创建新的接口，注意接口方法只能通过CtNewMethod.abstractMethod来创建。

3. CtField：Javassist将class中的成员变量抽象成CtField，借助于CtField来实现对class中的成员变量的操纵。

   • 新建CtField：使用CtField.make方法完成CtField对象的创建，注意创建的语句必须以分号结尾，否则抛CannotCompileException异常。
   • CtField与CtClass关系：新建好的CtField通过CtClass.addField添加到CtClass。

4. CtMethod：Javassist将class中除了构造方法以外的其它方法抽象成CtMethod，借助于CtMethod来实现对class中的这些方法的操纵。

   • 新建CtMethod：CtMethod提供了几个静态make方法，也可使用专门构造CtMethod实例的CtNewMethod类来实现。
   • CtNewMethod：简单理解就是一个工厂类，执行创建普通方法、抽象方法、setter/getter等方法。
   • CtMethod与CtClass关系：新建好的CtField通过CtClass.addMethod添加到CtClass。

5. CtConstructor：Javassist单独将class中的构造方法抽象成CtConstructor，借助于CtConstructor来实现对class中的构造方法的操纵。

   • 新建CtConstructor：使用几个重载的CtConstructor方法，也可使用专门构造CtConstructor实例的CtNewConstructor类来实现。
   • 修改方法体：CtConstructor.setBody，注意方法体是必须包含在{}中。
   • CtConstructor与CtClass关系：新建好的CtField通过CtClass.addConstructor添加到CtClass。

代码注入

1. 对于CtMethod，Javassist提供了简洁的代码注入方式以实现对现有的方法的变更：

   • 方法执行前：CtMethod的insertBefore能将代码直接注入到方法体的最前方，借助于此方法可以实现对方法执行流程的拦截。
   • 方法执行后：CtMethod的insertBefore能将代码直接注入到方法体执行完毕返回之前，借助于此方法可以实现对方法返回值的拦截。
   • 字节码某处注入：CtMethod的insertAt能将代码直接注入到字节码的某一行处。

2. 对于CtConstructor，除了支持上述CtMethod的几种注入方式之外，还支持以下方式：

   • insertBeforeBody：相比insertBefore，insertBeforeBody更适合构造方法包含super或this的注入
   • setBody：可以直接重写方法体代码。

3. 注入语法：Javassist的注入的代码其实只是一段字符串，要想与方法的参数、返回值、类实例（this）等建立关系就必须规定相关的语法规则：
   

   $0：代表的方法所在的类实例this，即在注入字符串中使用$0将会被翻译成this对象；$1，$2，...：方法参数列表，顺序是一一对应的； $r，$w：用于类型转换表达式里，否则转换不生效而编译失败$_：返回值

Android项目实践

1. 目标：新建一个Device类，并实现一个EventListener接口，最后将Device插入到MainActivity字节码文件里。

2. 新建一个普通的Android项目，如下图
   

3. 在上述新建好的Android项目上再新建一个Gradle插件模块buildSrc，此处不再赘述，具体看自定义Gradle插件，如下图：
   

4. 在buildSrc的build.gradle配置javassist依赖，如下：

   dependencies {    compile 'org.javassist:javassist:3.20.0-GA'}

5. BytecodePlugin与BytecodeTransform都是普通Gradle插件代码，在BytecodeTransform的transform中调用BytecodeModifier，注意包名的写法，如下

   BytecodeModifier.injectCode(directoryInput.file.absolutePath, "com\\example\\transform")

6. BytecodeModifier代码如下：

   public static void injectCode(String path, String packageName) {    File dir = new File(path)    if (dir.isDirectory()) {        dir.eachFileRecurse { File file ->            String filePath = file.absolutePath            if (filePath.endsWith(".class")                && filePath.contains(packageName)                && filePath.contains('MainActivity')                && !filePath.contains('R$')                && !filePath.contains('R.class')                && !filePath.contains("BuildConfig.class")) {                LogHelper.debug("path:" + path + ",filePath:" + filePath)                // 创建一个Device.class并设置成MainActivity的成员变量                CtClass deviceClass = JavassistManager.createDeviceClass(path)                if (deviceClass != null) {                    JavassistManager.injectToMainActivity(path, deviceClass)                }            }        }    }}

7. 最后所有的字节码操纵都由JavassistManager实现，如下：

   public static void injectToMainActivity(String path, CtClass ctClass) {    ClassPool pool = ClassPool.getDefault();    CtClass mainActivity;    try {        pool.appendClassPath(path);        mainActivity = pool.get("com.example.transform.MainActivity");        if (mainActivity.isFrozen()) {            mainActivity.defrost();        }        CtField ctField = new CtField(ctClass, "device", mainActivity);        mainActivity.addField(ctField);        mainActivity.writeFile(path);    } catch (NotFoundException e) {        e.printStackTrace();    } catch (CannotCompileException e) {        e.printStackTrace();    } catch (IOException e) {        e.printStackTrace();    }}public static CtClass createDeviceClass(String path) {    String className = "com.example.transform.Device";    ClassPool pool = ClassPool.getDefault();    CtClass cc = pool.makeClass(className);    try {        CtField ctField = CtField.make("String deviceId;", cc);        cc.addField(ctField);        CtConstructor con = CtNewConstructor.make(new CtClass[]{pool.get("java.lang.String")}, null, "{this" +            ".deviceId = \"1234567890\";}", cc);        cc.addConstructor(con);        CtMethod ctMethod = CtNewMethod.abstractMethod(CtClass.voidType, "update", null, null, cc);        cc.addMethod(ctMethod);        CtClass eventListener = createEventListener(path);        if (eventListener != null) {            cc.setInterfaces(new CtClass[]{eventListener});        }        cc.writeFile(path);        return cc;    } catch (CannotCompileException e) {        e.printStackTrace();    } catch (NotFoundException e) {        e.printStackTrace();    } catch (IOException e) {        e.printStackTrace();    }    return null;}private static CtClass createEventListener(String path) {    String className = "com.example.transform.EventListener";    ClassPool pool = ClassPool.getDefault();    CtClass cc = pool.makeInterface(className);    try {        CtMethod ctMethod = CtNewMethod.abstractMethod(CtClass.voidType, "onCreate", null, null, cc);        cc.addMethod(ctMethod);        CtMethod ctMethod1 = CtNewMethod.abstractMethod(CtClass.voidType, "onDestroy", null, null, cc);        cc.addMethod(ctMethod1);        cc.writeFile(path);        return cc;    } catch (CannotCompileException e) {        e.printStackTrace();    } catch (NotFoundException e) {        e.printStackTrace();    } catch (IOException e) {        e.printStackTrace();    }    return null;}

8. 编译运行，生成如下class，如下图：
   

   Device.class

   public abstract class Device implements EventListener {    String deviceId = "1234567890";    public Device(String var1) {    }    public abstract void update();}

   EventListener.class

   public interface EventListener {    void onCreate();    void onDestroy();}

   MainActivity.class

   public class MainActivity extends AppCompatActivity {    Device device;    public MainActivity() {    }    protected void onCreate(Bundle savedInstanceState) {        super.onCreate(savedInstanceState);        this.setContentView(2130968603);    }}

9. 注意，如果要操作的是Android.jar相关的字节码，则需要添加如下的classpath，如下代码：

   private static void addAndroidClassPath(Project project) {    String androidClassPath = project.android.bootClasspath[0].toString();    pool = ClassPool.getDefault();    pool.appendClassPath(androidClassPath)    // 导入widget包    pool.importPackage("android.widget")    // 导入app包    pool.importPackage("android.app")    ... ...}

10. 小结：Javassist提供了非常便利的API来实现对class字节码文件的强大的操纵能力。