Android利用FreeMarker自动生成文件

1. 准备工作

利用android studio新建一个项目，并新建一个Java Lib的Module，如图

创建groovy和java包

我这里新建的Module如图叫FreeMarkerLib。

然后将FreeMarkerLib中引入freemarker的库：

compile 'org.freemarker:freemarker:2.3.23'

2. 代码部分

在mian里面新建一个文件夹resources，用来存储我们的freemarker模板文件，之后新建一个模板文件，模板文件是以.ftl后缀结尾，我们创建一个简单的bean模板文件myJavaFile.ftl，为了能够显示模板的作用，在模板文件中，我为变量赋了值，代码如下：

package ${bean.packageName};

import java.util.Date;

public class ${bean.clazzName} {
    private Integer id = ${bean.id};
    private String name = ${bean.name};
    private String sex = ${bean.sex};

    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
}

模板创建完成后，剩下的就是我们针对模板文件实现文件创建的代码部分了。如下是对模板的实现Generator .java：

package com.hu.freemarkerlib;

import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.HashMap;
import java.util.Map;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateNotFoundException;

public class Generator {
    private static final String BEAN_KEY = "bean";
    private final Template myJavaFileFtl;

    public Generator() throws IOException {
        Configuration config = getConfiguration("myJavaFile.ftl");
        myJavaFileFtl = config.getTemplate("myJavaFile.ftl");
    }

    private Configuration getConfiguration(String template) throws IOException {
        Configuration config = new Configuration(Configuration.VERSION_2_3_23);
        config.setClassForTemplateLoading(getClass(), "/");
        System.out.println(getClass().getResource(""));
        //这里要设置取消使用Local语言环境
        config.setLocalizedLookup(false);
        try {
            config.getTemplate(template);
        } catch (TemplateNotFoundException e) {
            File dir = new File("src/main/resources/");

            if (dir.exists() && new File(dir, template).exists()) {
                config.setDirectoryForTemplateLoading(dir);
                config.getTemplate(template);
            } else {
                throw e;
            }
        }
        return config;
    }

    public void generate(File outDirFile, String packageName,String clazzName,int id,String sex,String name) throws Exception {
        // 创建数据模型
        Map root = new HashMap<>();
        TestBean testBean = new TestBean();
        testBean.setPackageName(packageName);
        testBean.setClazzName(clazzName);
        testBean.setId(id);
        testBean.setSex(sex);
        testBean.setName(name);
        //这里的key的名称要与模板里的名称一致，否则无法进行映射
        root.put(BEAN_KEY, testBean);

            File file = toJavaFilename(outDirFile, testBean.getPackageName(), testBean.getClazzName());
            //noinspection ResultOfMethodCallIgnored
            file.getParentFile().mkdirs();

            Writer writer = new FileWriter(file);
            try {
                myJavaFileFtl.process(root, writer);
                writer.flush();
                System.out.println("Written " + file.getCanonicalPath());
            } finally {
                writer.close();
            }
    }

    private File toJavaFilename(File outDirFile, String javaPackage, String javaClassName) {
        String packageSubPath = javaPackage.replace('.', '/');
        File packagePath = new File(outDirFile, packageSubPath);
        return new File(packagePath, javaClassName + ".java");
    }
}

针对要设置config.setLocalizedLookup(false);的原因，我这里说明一下，由于调试的时候发现config.getTemplate(template)中，会将template的名称改成myJavaFile_zh_CN.ftl,结构导致无法通过getTemplate方法获取到模板文件，究其原因就是内部会根据语言环境对文件名改造，但也不是绝对的，后来重新创建的工程并没有这样的问题，所以这里仅供参考。

TestBean的变量名要与模板文件中引用的名称一致，TestBean.java的实现：

package com.hu.freemarkerlib;

public class TestBean {
    private Integer id;
    private String name;
    private String sex;
    private String clazzName;
    private String packageName;

    public String getClazzName() {
        return clazzName;
    }
    public void setClazzName(String className) {
        this.clazzName = className;
    }
    public String getPackageName() {
        return packageName;
    }
    public void setPackageName(String beanUrl) {
        this.packageName = beanUrl;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
}

如此，我们的根据模板生成文件的工具类就实现好了，我们可以使用这个模板方法配置一个Gradle插件，通过gradle的配置的形式来实现自定义的文件。

3、结语

根据上述配置，我们可以实现一个简单的模板生成文件的工具方法。当然这只是个demo，我们可以利用FreeMarker来根据自定义的ftl模板生成自己需要的文件。

传送门

FreeMarkerDemo​