Java運行時動態生成對象的方法小結

Posted on by

最近一個項目中利用規則引擎，提供用戶拖拽式的靈活定義規則。這就要求根據數據庫數據動態生成對象處理特定規則的邏輯。如果手寫不僅每次都要修改代碼，還要每次測試發版，而且無法靈活根據用戶定義的規則動態處理邏輯。所以想到將公共邏輯寫到父類實現，將特定邏輯根據字符串動態生成子類處理。這就可以一勞永逸解決這個問題。

　　那就著手從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, 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, null);
try (MemoryJavaFileManager manager = new MemoryJavaFileManager(stdManager)) {
    JavaFileObject javaFileObject = manager.makeStringSource(fileName, source);
    CompilationTask task = compiler.getTask(null, manager, null, null, null, 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, 0, 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);
    }

到此這篇關於Java運行時動態生成對象幾種方式的文章就介紹到這瞭,更多相關Java運行時生成對象內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：