詳解Java中Javassist的使用

2023-04-04 06:00:39

開篇

說起 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內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

詳解Java中Javassist的使用

目錄

開篇

Javassist 常用類

Javassist 的使用

依賴

程式碼範例

如何實現類似 AOP 的功能

熱門文章