使用 Javassist 動態生成 Hello World
大家好,我是冰河~~
字節碼編程在實際的業務開發(CRUD)中并不常用,但是隨著網絡編程,RPC、動態字節碼增強技術和自動化測試以及零侵入APM監控的不斷發展與大量使用,越來越多的技術需要使用到字節碼編程。
好了,我們今天就使用Javassist動態生成一個HelloWorld案例,相關的程序案例代碼可以關注公眾號:冰河技術 獲取,也可以直接到Github和Gitee獲取。
Github:https://github.com/sunshinelyz/bytecode
Gitee:https://gitee.com/binghe001/bytecode
開發環境
- JDK 1.8
- IDEA 2018.03
- Maven 3.6.0
Maven依賴
在項目的pom.xml文件中添加如下環境依賴。
- <properties>
- <javassist.version>3.20.0-GA</javassist.version>
- </properties>
- <dependencies>
- <dependency>
- <groupId>org.javassist</groupId>
- <artifactId>javassist</artifactId>
- <version>${javassist.version}</version>
- </dependency>
- </dependencies>
案例效果
整體案例效果其實也是很簡單的,學習Java語言時,我們會在命令行打印第一個Hello World程序。今天,我們學習Javassist字節碼編程時,也來實現一個HelloWorld程序。
案例的效果就是要生成如下的程序代碼。
- package io.binghe.bytecode.javassist.test;
- public class HelloWorld {
- public static void main(String[] var0) {
- System.out.println("Javassist Hello World by 冰河(公眾號:冰河技術)");
- }
- public HelloWorld() {
- }
- }
看看這個效果,像不像我們自己在IDEA中寫的Java代碼呢?就讓我們一起使用Javassist來實現它吧。
案例實現
這個案例其實還是蠻簡單的,這里就先直接給出源代碼了。
- /**
- * @author binghe (公眾號:冰河技術)
- * @version 1.0.0
- * @description 測試使用Javassist生成第一個類HelloWorld
- */
- public class GenerateHelloWorldClass {
- /**
- * 創建HelloWorld的類,并返回HelloWorld的Class實例
- */
- public static Class createHelloWorld()throws Exception{
- //使用默認的ClassPool
- ClassPool pool = ClassPool.getDefault();
- //創建一個空類
- CtClass ctClass = pool.makeClass("io.binghe.bytecode.javassist.test.HelloWorld");
- //添加一個main方法
- CtMethod ctMethod = new CtMethod(CtClass.voidType, "main", new CtClass[]{pool.get(String[].class.getName())}, ctClass);
- //將main方法聲明為public static類型
- ctMethod.setModifiers(Modifier.PUBLIC + Modifier.STATIC);
- //設置方法體
- ctMethod.setBody("{" +
- "System.out.println(\"Javassist Hello World by 冰河(公眾號:冰河技術)\");" +
- "}");
- ctClass.addMethod(ctMethod);
- //將生成的類的class文件輸出的磁盤
- ctClass.writeFile();
- //返回HelloWorld的Class實例
- return ctClass.toClass();
- }
- public static void main(String[] args) throws Exception {
- Class clazz = createHelloWorld();
- Object obj = clazz.newInstance();
- Method mainMethod = clazz.getMethod("main", new Class[]{String[].class});
- mainMethod.invoke(obj, new String[1]);
- }
- }
接下來,我們根據上述代碼來看看Javassist是如何生成完整字節碼的。
(1) 在createHelloWorld()方法中創建一個ClassPool,ClassPool本質上就是個CtClass對象容器。
(2) 調用ClassPool的makeClass()方法,傳入完整的包名+類名生成一個空的類信息。這里傳入的完整的包名+類名是io.binghe.bytecode.javassist.test.HelloWorld。
(3) 給類添加方法,并設置方法的返回類型、方法名稱、參數名(入參和出參)、訪問修飾符以及方法體。這里設置的完整方法體如下:
- public static void main(String[] var0) {
- System.out.println("Javassist Hello World by 冰河(公眾號:冰河技術)");
- }
(4) 盡管我們在上述代碼中沒有顯示的創建無參構造函數,但是在編譯時,Javassist會自動創建一個HelloWorld類的無參構造函數。
(5) 通過 CtClass的writeFile()方法將內存中的類信息輸出到磁盤,這樣我們就可以通過IDEA清晰的看到Javassist生成的HelloWorld類了。
(6) 最終在createHelloWorld()方法中調用CtClass的toClass()方法返回Class對象。
(7) 在main()方法中調用createHelloWorld()方法獲取Class對象。
(8) 通過反射實例化對象,并通過反射調用生成的HelloWorld類的main()方法。
效果演示
運行GenerateHelloWorldClass類的main()方法,會在頂級工程目錄下的io/binghe/bytecode/javassist/test 目錄下生成HelloWorld.class文件,具體如下所示。
查看IDEA的輸出信息時,發現會輸出如下內容。
- Javassist Hello World by 冰河(公眾號:冰河技術)
- Process finished with exit code 0
案例總結
我們使用Javassist實現了創建一個HelloWorld類的功能,字節碼編程聽起來貌似挺難的,但是在Javassist強大的API下,實現起來還是蠻簡單的。
在接下來的一段時間里,冰河會持續輸出關于字節碼編程的文章,讓我們一起精通字節碼編程。
好了,今天就到這兒吧,我是冰河,我們下期見~~
本文轉載自微信公眾號「冰河技術」,可以通過以下二維碼關注。轉載本文請聯系冰河技術公眾號。