Java執行時動態生成類實現過程詳解
最近一個專案中利用規則引擎,提供使用者拖拽式的靈活定義規則。這就要求根據資料庫資料動態生成物件處理特定規則的邏輯。如果手寫不僅每次都要修改程式碼,還要每次測試發版,而且無法靈活根據使用者定義的規則動態處理邏輯。所以想到將公共邏輯寫到父類實現,將特定邏輯根據字串動態生成子類處理。這就可以一勞永逸解決這個問題。
那就著手從Java如何根據字串模板在執行時動態生成物件。
Java是一門靜態語言,通常,我們需要的class在編譯的時候就已經生成了,為什麼有時候我們還想在執行時動態生成class呢?
經過一番網上資料查詢,由繁到簡的方式總結如下:
一、利用JDK自帶工具類實現
現在問題來了,動態生成位元組碼,難度有多大?
如果我們要自己直接輸出二進位制格式的位元組碼,在完成這個任務前,必須先認真閱讀JVM規範第4章,詳細瞭解class檔案結構。估計讀完規範後,兩個月過去了。
所以,第一種方法,自己動手,從零開始建立位元組碼,理論上可行,實際上很難。
第二種方法,使用已有的一些能操作位元組碼的庫,幫助我們建立class。
目前,能夠操作位元組碼的開源庫主要有CGLib和Javassist兩種,它們都提供了比較高階的API來操作位元組碼,最後輸出為class檔案。
比如CGLib,典型的用法如下:
Enhancer e = new Enhancer(); e.setSuperclass(...); e.setStrategy(new DefaultGeneratorStrategy() { protected ClassGenerator transform(ClassGenerator cg) { return new TransformingGenerator(cg,new AddPropertyTransformer(new String[]{ "foo" },new Class[] { Integer.TYPE })); }}); Object obj = e.create();
比自己生成class要簡單,但是,要學會它的API還是得花大量的時間,並且,上面的程式碼很難看懂對不對?
有木有更簡單的方法?
有!
Java的編譯器是javac,但是,在很早很早的時候,Java的編譯器就已經用純Java重寫了,自己能編譯自己,行業黑話叫“自舉”。從Java 1.6開始,編譯器介面正式放到JDK的公開API中,於是,我們不需要建立新的程序來呼叫javac,而是直接使用編譯器API來編譯原始碼。
使用起來也很簡單:
JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
int compilationResult = compiler.run(null,null,'/path/Test.java');
這麼寫編譯是沒啥問題,問題是我們在記憶體中建立了Java程式碼後,必須先寫到檔案,再編譯,最後還要手動讀取class檔案內容並用一個ClassLoader載入。
有木有更簡單的方法?
有!
其實Java編譯器根本不關心原始碼的內容是從哪來的,你給它一個String當作原始碼,它就可以輸出byte[]作為class的內容。
所以,我們需要參考Java Compiler API的文件,讓Compiler直接在記憶體中完成編譯,輸出的class內容就是byte[]。
Map<String,byte[]> results; JavaCompiler compiler = ToolProvider.getSystemJavaCompiler(); StandardJavaFileManager stdManager = compiler.getStandardFileManager(null,null); try (MemoryJavaFileManager manager = new MemoryJavaFileManager(stdManager)) { JavaFileObject javaFileObject = manager.makeStringSource(fileName,source); CompilationTask task = compiler.getTask(null,manager,Arrays.asList(javaFileObject)); if (task.call()) { results = manager.getClassBytes(); } }
上述程式碼的幾個關鍵在於:
用MemoryJavaFileManager替換JDK預設的StandardJavaFileManager,以便在編譯器請求原始碼內容時,不是從檔案讀取,而是直接返回String;
用MemoryOutputJavaFileObject替換JDK預設的SimpleJavaFileObject,以便在接收到編譯器生成的byte[]內容時,不寫入class檔案,而是直接儲存在記憶體中。
最後,編譯的結果放在Map<String,byte[]>中,Key是類名,對應的byte[]是class的二進位制內容。
為什麼編譯後不是一個byte[]呢?
因為一個.java的原始檔編譯後可能有多個.class檔案!只要包含了靜態類、匿名類等,編譯出的class肯定多於一個。
如何載入編譯後的class呢?
載入class相對而言就容易多了,我們只需要建立一個ClassLoader,覆寫findClass()方法:
class MemoryClassLoader extends URLClassLoader { Map<String,byte[]> classBytes = new HashMap<String,byte[]>(); public MemoryClassLoader(Map<String,byte[]> classBytes) { super(new URL[0],MemoryClassLoader.class.getClassLoader()); this.classBytes.putAll(classBytes); } @Override protected Class<?> findClass(String name) throws ClassNotFoundException { byte[] buf = classBytes.get(name); if (buf == null) { return super.findClass(name); } classBytes.remove(name); return defineClass(name,buf,buf.length); } }
總結以上,那麼我們來編寫一個Java指令碼引擎吧:
https://github.com/barrywang88/compiler
https://github.com/barrywang88/compiler.git
二、利用三方Jar包實現
利用三方包com.itranswarp.compiler來實現:
1. 引入Maven依賴包:
<dependency> <groupId>com.itranswarp</groupId> <artifactId>compiler</artifactId> <version>1.0</version> </dependency>
2. 編寫工具類
public class StringCompiler { public static Object run(String source,String...args) throws Exception { // 宣告類名 String className = "Main"; String packageName = "top.fomeiherz"; // 宣告包名:package top.fomeiherz; String prefix = String.format("package %s;",packageName); // 全類名:top.fomeiherz.Main String fullName = String.format("%s.%s",packageName,className); // 編譯器 JavaStringCompiler compiler = new JavaStringCompiler(); // 編譯:compiler.compile("Main.java",source) Map<String,byte[]> results = compiler.compile(className + ".java",prefix + source); // 載入記憶體中byte到Class<?>物件 Class<?> clazz = compiler.loadClass(fullName,results); // 建立例項 Object instance = clazz.newInstance(); Method mainMethod = clazz.getMethod("main",String[].class); // String[]陣列時必須使用Object[]封裝 // 否則會報錯:java.lang.IllegalArgumentException: wrong number of arguments return mainMethod.invoke(instance,new Object[]{args}); } }
3. 測試執行
public class StringCompilerTest { public static void main(String[] args) throws Exception { // 傳入String型別的程式碼 String source = "import java.util.Arrays;public class Main" + "{" + "public static void main(String[] args) {" + "System.out.println(Arrays.toString(args));" + "}" + "}"; StringCompiler.run(source,"1","2"); } }
三、利用Groovy指令碼實現
以上兩種方式嘗試過,後來發現Groovy原生就支援指令碼動態生成物件。
1. 引入Groovy maven依賴
<dependency> <groupId>org.codehaus.groovy</groupId> <artifactId>groovy-all</artifactId> <version>2.4.13</version> </dependency>
2. 直接上測試程式碼
@Test public void testGroovyClasses() throws Exception { //groovy提供了一種將字串文字程式碼直接轉換成Java Class物件的功能 GroovyClassLoader groovyClassLoader = new GroovyClassLoader(); //裡面的文字是Java程式碼,但是我們可以看到這是一個字串我們可以直接生成對應的Class<?>物件,而不需要我們寫一個.java檔案 Class<?> clazz = groovyClassLoader.parseClass("package com.xxl.job.core.glue;\n" + "\n" + "public class Main {\n" + "\n" + " public int age = 22;\n" + " \n" + " public void sayHello() {\n" + " System.out.println(\"年齡是:\" + age);\n" + " }\n" + "}\n"); Object obj = clazz.newInstance(); Method method = clazz.getDeclaredMethod("sayHello"); method.invoke(obj); Object val = method.getDefaultValue(); System.out.println(val); }
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。