最近由于项目需求,需要根据一些文件的信息,在编译时动态生成Java代码。

解决方案很简单,就是在build.gradle中建立一个编译前运行的Task,例如:

task genFile() {
    doLast {
        genJavaFile()
    }
}

//preBuild是编译前的Task
//让preBuild dependsOn genFile
//那么genFile肯定运行在编译前
preBuild.dependsOn genFile

在genFile Task中获取必要的信息,然后生成Java文件,再进行整体编译。

那么现在的问题就是:如何动态生成一个Java文件?
由于项目需要生成的Java文件及其简单,最初我想直接通过写文件的方式进行实现。
不过这样的弊端很明显,一旦需求变得复杂,这个方法的复杂度将直线上升。
好在查了一下资料,发现已经有现成的生成Java文件的工具了,即CodeModel。

简单来讲,CodeModel是一个Java库,使用它能通过Java代码生成Java类。
我是利用Java代码写出一个Jar包,然后在build.gradle中调用Jar包完成功能的。
在Java工程中引用com.sun.codemodel:codemodel:2.6的Jar包后,就可以使用CodeModel的功能了。

个人感觉CodeModel还是比较简单好用的,大家看看我的例子就知道了:

//我的目标是生成一个Jar包,参数中携带了文件信息
    public static void main(String[] args) {
        int len = args.length;

        if (len <= 2) {
            System.out.println(
                    "error: must give the file store path, flag file path and parameters");
            return;
        }

        String path = args[0];
        String flagFilePath = args[1];

        try {
            //实例化JCodeModel对象,生成Java文件就靠它了
            JCodeModel jCodeModel = new JCodeModel();

            //这里指定包名, 由jCodeModel生成包对象
            JPackage jPackage = jCodeModel._package("com.test.demo");

            //这里指定类名, 由jPackage生成类对象
            JDefinedClass jDefinedClass = jPackage._class("VersionInfo");

            //这里是解析传入参数,与功能强相关,不用管
            for (int i = 2; i < args.length; ++i) {
                String[] varArray = args[i].split("_");
                if (varArray.length > 0) {
                    String varName = varArray[0].toUpperCase();
                    String varValue = args[i].replaceAll("\\.", "_");
                    //指定类对象的变量,这里生成的公有静态常量
                    //指定变量的类型和值
                    jDefinedClass.field(JMod.PUBLIC + JMod.STATIC + JMod.FINAL,
                            String.class, varName, JExpr.lit(varValue));
                } else {
                    System.out.println("error: so name not right" + args[i]);
                }
            }

            //这里创建了类的构造函数
            JMethod onCreateMethod = jDefinedClass.constructor(JMod.PRIVATE);

            //得到函数体
            JBlock methodBody = onCreateMethod.body();
            //这里仅加了条描述
            //还可以按需进行其它操作,例如定义语句、变量等
            methodBody.directStatement("//private constructor for utility class");

            //生成Java文件,文件路径由path指定
            jCodeModel.build(new File(path));

            //功能独有,不用管
            new File(flagFilePath).createNewFile();
        } catch (JClassAlreadyExistsException | IOException e) {
            System.out.println(e);
        }
    }

以上就是CodeModel的使用示例,应该还是比较容易看懂的。
实际上就是不断创建出需要的对象,然后填充特定域的过程。

JCodeModel -> JPackage -> JDefinedClass -> field  (类变量)
                               |
                             JMethod    -> JBlock (继续填充函数内容)

更详细的使用方法,可以参考CodeModel中文指导手册:
https://www.ibm.com/developerworks/cn/java/j-lo-codemodel/