改善Java代碼之慎用java動態編譯

Posted on by

動態編譯一直是Java的夢想，從Java 6版本它開始支持動態編譯瞭，可以在運行期直接編譯.java文件，執行.class，並且能夠獲得相關的輸入輸出，甚至還能監聽相關的事件。不過，我們最期望的還是給定一段代碼，直接編譯，然後運行，也就是空中編譯執行（on-the-fly），來看如下代碼：

public class Client {
     public static void main(String[] args) throws Exception {
         //Java源代碼
         String sourceStr = "public class Hello{    public String sayHello (String name) {return \"Hello,\" + name + \"!\";}}";
         //類名及文件名
         String clsName = "Hello";
         //方法名
         String methodName = "sayHello";
         //當前編譯器
         JavaCompiler cmp = ToolProvider.getSystemJavaCompiler();
         //Java標準文件管理器
         StandardJavaFileManager fm = cmp.getStandardFileManager(null,null,null);
         //Java文件對象
         JavaFileObject jfo = new StringJavaObject(clsName,sourceStr);
         //編譯參數，類似於javac <options>中的options
         List<String> optionsList = new ArrayList<String>();
         //編譯文件的存放地方，註意：此處是為Eclipse工具特設的
         optionsList.addAll(Arrays.asList("-d","./bin"));
         //要編譯的單元
         List<JavaFileObject> jfos = Arrays.asList(jfo);
         //設置編譯環境
         JavaCompiler.CompilationTask task = cmp.getTask(null, fm, null, optionsList,null,jfos);
         //編譯成功
         if(task.call()){
             //生成對象
             Object obj = Class.forName(clsName).newInstance();
             Class<? extends Object> cls = obj.getClass();
             //調用sayHello方法
             Method m = cls.getMethod(methodName, String.class);
             String str = (String) m.invoke(obj, "Dynamic Compilation");
             System.out.println(str);
        }
    }
}
//文本中的Java對象
class StringJavaObject extends SimpleJavaFileObject{
     //源代碼
     private String content = "";
     //遵循Java規范的類名及文件
     public StringJavaObject(String _javaFileName,String _content){
           super(_createStringJavaObjectUri(_javaFileName),Kind.SOURCE);
           content = _content;
     }
     //產生一個URL資源路徑
     private static URI _createStringJavaObjectUri(String name){
        //註意此處沒有設置包名
        return URI.create("String:///" + name + Kind.SOURCE.extension);
     }
     //文本文件代碼
     @Override
     public CharSequence getCharContent(boolean ignoreEncodingErrors)
            throws IOException {
        return content;
    }
}

上面的代碼較多，這是一個動態編譯的模板程序，讀者可以拷貝到項目中使用，代碼中的中文註釋也較多，相信讀者看得懂，不多解釋，讀者隻要明白一件事：隻要是在本地靜態編譯能夠實現的任務，比如編譯參數、輸入輸出、錯誤監控等，動態編譯就都能實現。

Java的動態編譯對源提供瞭多個渠道。比如，可以是字符串（例子中就是字符串），可以是文本文件，也可以是編譯過的字節碼文件（.class文件），甚至可以是存放在數據庫中的明文代碼或是字節碼。匯總成一句話，隻要是符合Java規范的就都可以在運行期動態加載，其實現方式就是實現JavaFileObject接口，重寫getCharContent、openInputStream、openOutputStream，或者實現JDK已經提供的兩個SimpleJavaFileObject、ForwardingJavaFileObject，具體代碼可以參考上個例子。

動態編譯雖然是很好的工具，讓我們可以更加自如地控制編譯過程，但是在我目前所接觸的項目中還是使用得較少。原因很簡單，靜態編譯已經能夠幫我們處理大部分的工作，甚至是全部的工作，即使真的需要動態編譯，也有很好的替代方案，比如JRuby、Groovy等無縫的腳本語言。

另外，我們在使用動態編譯時，需要註意以下幾點：

（1）在框架中謹慎使用

比如要在Struts中使用動態編譯，動態實現一個類，它若繼承自ActionSupport就希望它成為一個Action。能做到，但是debug很困難；再比如在Spring中，寫一個動態類，要讓它動態註入到Spring容器中，這是需要花費老大功夫的。

（2）不要在要求高性能的項目使用

動態編譯畢竟需要一個編譯過程，與靜態編譯相比多瞭一個執行環節，因此在高性能項目中不要使用動態編譯。不過，如果是在工具類項目中它則可以很好地發揮其優越性，比如在Eclipse工具中寫一個插件，就可以很好地使用動態編譯，不用重啟即可實現運行、調試功能，非常方便。

（3）動態編譯要考慮安全問題

如果你在Web界面上提供瞭一個功能，允許上傳一個Java文件然後運行，那就等於說：“我的機器沒有密碼，大傢都來看我的隱私吧”，這是非常典型的註入漏洞，隻要上傳一個惡意Java程序就可以讓你所有的安全工作毀於一旦。

（4）記錄動態編譯過程

建議記錄源文件、目標文件、編譯過程、執行過程等日志，不僅僅是為瞭診斷，還是為瞭安全和審計，對Java項目來說，空中編譯和運行是很不讓人放心的，留下這些依據可以更好地優化程序。

推薦閱讀：

    None Found