詳解Java中Javassist的使用

Posted on by

開篇

說起 AOP 小夥伴們肯定很熟悉，無論是 JDK 動態代理或者是 CGLIB 等，其底層都是通過操作 Java 字節碼來實現代理。常用的一些操作字節碼的技術有 ASM、AspectJ、Javassist 等。

ASM 其設計和實現是盡可能小而且快，更專註於性能。它在指令的層面來操作，所以使用它需要對 JVM 的指令有所瞭解，門檻較高，CGLIB 就使用瞭 ASM 技術。

AspectJ 擴展瞭 Java 語言，定義瞭一系列 AOP 語法，在 JVM 中運行需要使用特定的編譯器生成遵守 Java 字節碼規范的 Class 文件，Spring AOP 使用瞭 AspectJ 。

Javassist 直接使用 Java 編碼的形式操作字節碼，簡單易上手，性能高於反射，相比於 ASM 稍低。

Javassist 常用類

Javassist 抽象出一個 ClassPool 對象來操作 Java 類，可以通過 ClassPool.getDefault() 來獲取默認的 ClassPool 。常用的對象：

CtClass：代表一個 Class 的實例，可以通過類的全限定名來獲取 CtClass 對象，其中包含瞭對 Class 的各種操作。

ClassPool：通過 HashTable 保存瞭路徑下的 CtClass 信息，key為類的全限定名稱，value 為類名對應的 CtClass 對象。

CtMethod、CtField：抽象出類的方法和屬性，可以用於定義或修改方法和字段。

Javassist 的使用

依賴

<dependency>
  <groupId>org.javassist</groupId>
  <artifactId>javassist</artifactId>
  <version>3.27.0-GA</version>
</dependency>

代碼示例

// 獲取默認類池
  ClassPool classPool = ClassPool.getDefault();
  // 1. 創建空類
  CtClass ctClass = classPool.makeClass("com.aysaml.demo.javassist.User");

  // 2. 創建 String 類型的 name 字段
  CtField field = new CtField(classPool.get("java.lang.String"), "name", ctClass);
  // 設置字段訪問級別 private
  field.setModifiers(Modifier.PRIVATE);
  // 增加字段
  ctClass.addField(field);

  // 3. 增加 getter & setter 方法
  ctClass.addMethod(CtNewMethod.getter("getName", field));
  ctClass.addMethod(CtNewMethod.setter("setName", field));

  // 4. 增加無參構造方法：其中 $0 表示 this，$1 表示參數
  CtConstructor noArgsCons = new CtConstructor(new CtClass[] {}, ctClass);
  noArgsCons.setBody("{$0.name=\"mark\";}");
  ctClass.addConstructor(noArgsCons);

  // 5. 增加有參構造方法
  CtConstructor hasArgsCons =
    new CtConstructor(new CtClass[] {classPool.get("java.lang.String")}, ctClass);
  hasArgsCons.setBody("{$0.name=$1;}");
  ctClass.addConstructor(hasArgsCons);

  // 6. 創建方法
  CtMethod method = new CtMethod(CtClass.voidType, "printName", new CtClass[] {}, ctClass);
  method.setBody("{System.out.println($0.name);}");
  ctClass.addMethod(method);

  // 7. 生成類文件：可指定路徑，默認為當前項目根目錄
  ctClass.writeFile();

  // 8. 創建類實例
  Object person = ctClass.toClass().newInstance();

如何實現類似 AOP 的功能

javassist 對於編程化的操作字節碼是很簡單易懂的，我們以在方法的開頭結尾打印信息為例：

public class Cat {

 /** 記錄喵喵喵的次數 */
 private int num;

 public void miao() {
  this.num++;
 }
}

我們要在 miao( ) 方法的前增加聲音輸出：

public static void main(String[] args) throws NotFoundException, CannotCompileException {
  ClassPool classPool = ClassPool.getDefault();
  // 獲取 Cat 類的 CtClass 對象
  CtClass catClass = classPool.get("com.aysaml.demo.javassist.Cat");
  // 獲取 miao( ) 方法
  CtMethod method = catClass.getDeclaredMethod("miao");
  method.insertBefore("System.out.println(\"miao~\");");
  // 加載修改過的類，註意必須要保證調用前這個類沒有被加載過
  catClass.toClass();
  //測試
  Cat cat = new Cat();
  cat.miao();
 }

註意到，在使用 catClass.toClass() 加載被修改過的類時，強調必須保證在調用前這個類沒有被加載過，否則會報 attempted duplicate class definition for name 異常。

我們知道一個類是不能被一個類加載器加載兩次的，所以為瞭解決這個問題，需要制定一個沒有加載過該類的 Classloader，Javassist 提供瞭一個 ClassLoader ，如下：

public class Cat {

 /** 記錄喵喵喵的次數 */
 private int num;

 public void miao() {
  System.out.println("調用瞭 miao 方法");
  this.num++;
 }

 public static void main(String[] args) throws Exception{
  ClassPool classPool = ClassPool.getDefault();
  // 獲取 Cat 類的 CtClass 對象
  CtClass catClass = classPool.get("com.aysaml.demo.javassist.Cat");
  // 獲取 miao( ) 方法
  CtMethod method = catClass.getDeclaredMethod("miao");
  method.insertBefore("System.out.println(\"miao~\");");
  // 重新設置一個 Classloader
  Loader classLoader = new Loader(classPool);
  Class clazz = classLoader.loadClass("com.aysaml.demo.javassist.Cat");
  // 調用修改過的類的方法
  clazz.getDeclaredMethod("miao").invoke(clazz.newInstance());
 }
}

執行結果為：

到此這篇關於詳解Java中Javassist的使用的文章就介紹到這瞭,更多相關Java Javassist內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：