Java动态编译那些事

jdk1.6中添加了编译API, 我们可以在java代码中调用编译API动态编译JAVA源文件, 也就是运行时编译. 下面对JAVA动态编译API的用法进行简单介绍:

一. 编译API概要

下面是动态编译API相关类的类图:

编译API.png

关键组件介绍:

• JavaCompiler - 表示java编译器, run方法执行编译操作. 还有一种编译方式是先生成编译任务(CompilationTask), 让后调用CompilationTask的call方法执行编译任务
• JavaFileObject - 表示一个java源文件对象
• JavaFileManager - Java源文件管理类, 管理一系列JavaFileObject
• Diagnostic - 表示一个诊断信息
• DiagnosticListener - 诊断信息监听器, 编译过程触发. 生成编译task(JavaCompiler#getTask())或获取FileManager(JavaCompiler#getStandardFileManager())时需要传递DiagnosticListener以便收集诊断信息

二. 用法

• (1) 下面的demo, 先构建一个类的源文件, 再使用流写入到磁盘中, 接着调用编译api, 编译磁盘上的源文件, 最后使用反射调加载并调用编译后的字节码. 代码如下:

package com.example.dynamic_compiler;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

import javax.tools.JavaCompiler;
import javax.tools.ToolProvider;

public class DynamicCompileDemo {

    static void eval(String source) {
        //构建一个类的源代码
        StringBuffer sourceCode = new StringBuffer();
        sourceCode.append("public class Temp {").append("\r\n")
                .append("public static String call(String args) {").append("\r\n")
                .append("System.out.println(\""+source+"\");").append("\r\n")
                .append("return \"Hello, " + source + "\";").append("\r\n")
                .append("}").append("\r\n")
                .append("}");
        try {
            //将源文件写入到磁盘中
            String javaFileName = "Temp.java";
            //生成的Java源文件存放到/build/generated/source/java目录下  (开发工具为Android Studio, java-demo是我的module名称)
            File sourceDir = new File("java-demo/build/generated/source/java");
            if (!sourceDir.exists()) {
                sourceDir.mkdirs();
            }
            File javaFile = new File(sourceDir, javaFileName);
            PrintWriter writer = new PrintWriter(new FileWriter(javaFile));
            writer.write(sourceCode.toString());
            writer.flush();
            writer.close();

            //动态编译磁盘中的代码
            //生成的字节码文件存放到/build/classes/main目录下
            File distDir = new File("java-demo/build/classes/main");
            if (!distDir.exists()) {
                distDir.mkdirs();
            }
            JavaCompiler javac = ToolProvider.getSystemJavaCompiler();
            //JavaCompiler最核心的方法是run, 通过这个方法编译java源文件, 前3个参数传null时, 
            //分别使用标准输入/输出/错误流来 处理输入和编译输出. 使用编译参数-d指定字节码输出目录.
            int compileResult = javac.run(null, null, null, "-d", distDir.getAbsolutePath(), javaFile.getAbsolutePath());
            //run方法的返回值: 0-表示编译成功, 否则表示编译失败
            if(compileResult != 0) {
                System.err.println("编译失败!!");
                return;
            }

            //动态执行 (反射执行)
            Class klass = Class.forName("Temp");
            Method evalMethod = klass.getMethod("call", String.class);
            String result = (String)evalMethod.invoke(klass.newInstance(), source);
            System.out.println("eval(" + source + ") = " + result);
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        } catch (NoSuchMethodException e) {
            e.printStackTrace();
        } catch (InvocationTargetException e) {
            e.printStackTrace();
        } catch (IllegalAccessException e) {
            e.printStackTrace();
        } catch (InstantiationException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static void main(String[] args) {
        eval("Lucy");
    }
}

运行后输出结果如下:

运行结果

• (2) 下面的demo, 使用编译api编译内存中的java源代码. 代码如下:
  a. 自定义一个JavaFileObject对象, 用于表示Java源代码对象, 如下:

package com.example.dynamic_compiler;

import java.net.URI;

import javax.tools.SimpleJavaFileObject;


public class JavaFileObjectFromString extends SimpleJavaFileObject {
    //Uri uri; //uri为源码的资源定位符, 在父类中定义

    /**
     * Java源文件的内容
     */
    final String code;

    /**
     * @param className 类的完整名称
     * @param code
     */
    public JavaFileObjectFromString(String className, String code) {
        //uri为类的资源定位符号, 如: com/stone/generate/Hello.java
        super(URI.create(className.replaceAll("\\.", "/") + Kind.SOURCE.extension), Kind.SOURCE);
        //uri值为com.stone.generate.Hello时, 下面注释的代码导致异常 => com.stone.generate.Hello:1: 错误: 类Hello是公共的, 应在名为 Hello.java 的文件中声明
//        super(URI.create(className), Kind.SOURCE);
        this.code = code;
    }

    @Override
    public CharSequence getCharContent(boolean ignoreEncodingErrors) {
        return code;
    }
}

(b) 使用一个类的源码字符串构造一个JavaFileObject, 让后调用编译API编译此JavaFileObject对象, 并生成字节码, 最后使用放射调用编译结果. 代码如下:

package com.example.dynamic_compiler;

import java.io.File;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.Arrays;

import javax.tools.JavaCompiler;
import javax.tools.JavaFileObject;
import javax.tools.ToolProvider;


public class Demo1 {
    public static void main(String[] args) throws MalformedURLException, ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        //构建java源文件
        StringBuilder sourceCode = new StringBuilder();
        sourceCode.append("package com.stone.generate;")
                .append("public class Hello {")
                .append("public static void main(String[] args) {")
                .append("System.out.println(\"Hello World !\");")
                .append("}")
                .append("}");

//        //将代码写入到内存
//        StringWriter writer = new StringWriter(); //写入到内存中
//        PrintWriter out = new PrintWriter(writer);
//        out.println(sourceCode.toString());
//        out.flush();
//        out.close();

        //动态编译内存中的代码
        File distDir = new File("java-demo/build/classes/main");
        if (!distDir.exists()) {
            distDir.mkdirs();
        }
        JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
//        JavaFileObject javaFileObject = new JavaFileObjectFromString("Hello", writer.toString());
        JavaFileObject javaFileObject = new JavaFileObjectFromString("com.stone.generate.Hello", sourceCode.toString());
        JavaCompiler.CompilationTask task = compiler.getTask(null, null, null,
                Arrays.asList("-d", distDir.getAbsolutePath()), null,
                Arrays.asList(javaFileObject));
        boolean compileSuccess = task.call();
        if (!compileSuccess) {
            System.out.println("编译失败");
        } else {

            //动态执行 (反射执行)
            System.out.println("编译成功");
            URL[] urls = new URL[] {new URL("file:/" + distDir.getAbsolutePath())};
            URLClassLoader classLoader = new URLClassLoader(urls);
            Class dynamicClass = classLoader.loadClass("com.stone.generate.Hello");
            Method method = dynamicClass.getDeclaredMethod("main", String[].class);
            String[] arguments = {null};
            method.invoke(dynamicClass, arguments);
        }
    }
}

运行后输出结果如下:

运行结果

• (3) 编译编译一个错误的Java类. 使用诊断信息监听器手机诊断信息. 代码如下:

package com.example.dynamic_compiler;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Arrays;

import javax.tools.Diagnostic;
import javax.tools.DiagnosticCollector;
import javax.tools.JavaCompiler;
import javax.tools.JavaFileObject;
import javax.tools.StandardJavaFileManager;
import javax.tools.ToolProvider;

/**
 * @author stone
 * @date 16/9/6
 */
public class Demo2 {
    public static void main(String[] args) throws IOException, ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        //构建java源文件
        String javaFileName = "Demo.java";
        StringBuilder sourceCode = new StringBuilder();

        //正常的java源代码
//        sourceCode.append("package com.stone.generate;").append("\r\n")
//                .append("public class Demo {").append("\r\n")
//                .append("public static void main(String[] args) {").append("\r\n")
//                .append("System.out.println(\"Hello World !\");").append("\r\n")
//                .append("}").append("\r\n")
//                .append("}");

        //错误的java源代码
        sourceCode.append("package com.stone.generate;").append("\r\n\n")
                .append("public class Demo ").append("\r\n")  //此处少了一个: `{`
                .append("public static void main(String[] args) {").append("\r\n")
                .append("System.out.println(\"Hello World !\");").append("\r\n")
                .append("}").append("\r\n")
                .append("}");

        //见文件写到磁盘
        File sourceDir = new File("java-demo/build/generated/source/java");
        if (!sourceDir.exists()) {
            sourceDir.mkdirs();
        }
        File javaFile = new File(sourceDir, javaFileName);
        PrintWriter out = new PrintWriter(new FileWriter(javaFile));
        out.write(sourceCode.toString());
        out.flush();
        out.close();


        //获取编译器
        JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();

        //创建诊断信息监听器, 用于手机诊断信息
        DiagnosticCollector diagnosticListeners = new DiagnosticCollector<>();

        //获取FileManager
        StandardJavaFileManager javaFileManager = compiler.getStandardFileManager(diagnosticListeners, null, null);
        Iterable it = javaFileManager.getJavaFileObjects(javaFile);
        File distDir = new File("java-demo/build/classes/main");
        if (!distDir.exists()) {
            distDir.mkdir();
        }

        //生编译任务
        JavaCompiler.CompilationTask task = compiler.getTask(null, javaFileManager, diagnosticListeners,
                Arrays.asList("-d", distDir.getAbsolutePath()), null, it);

        //执行编译任务
        task.call();

        //输出诊断信息
        for(Diagnostic diagnostic : diagnosticListeners.getDiagnostics()) {
            //可以在此处自定义编译诊(错误)断信息的输出格式
            System.out.format("Error on line %d in %s%n",
                    diagnostic.getLineNumber(),
                    diagnostic.getSource().toUri());
        }

        //关闭FileManager
        javaFileManager.close();

        //动态执行
        Class klass = Class.forName("com.stone.generate.Demo");
        Method method = klass.getDeclaredMethod("main", String[].class);
        method.invoke(klass, new String[]{null});
    }
}

运行结果如下:

运行结果