Android利用FreeMarker自動(dòng)生成文件

1. 準(zhǔn)備工作

利用android studio新建一個(gè)項(xiàng)目,并新建一個(gè)Java Lib的Module,如圖


創(chuàng)建groovy和java包

我這里新建的Module如圖叫FreeMarkerLib。

然后將FreeMarkerLib中引入freemarker的庫:

compile 'org.freemarker:freemarker:2.3.23'

2. 代碼部分

在mian里面新建一個(gè)文件夾resources,用來存儲(chǔ)我們的freemarker模板文件,之后新建一個(gè)模板文件,模板文件是以.ftl后綴結(jié)尾,我們創(chuàng)建一個(gè)簡(jiǎn)單的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;
    }
}

模板創(chuàng)建完成后,剩下的就是我們針對(duì)模板文件實(shí)現(xiàn)文件創(chuàng)建的代碼部分了。如下是對(duì)模板的實(shí)現(xiàn)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(""));
        //這里要設(shè)置取消使用Local語言環(huán)境
        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 {
        // 創(chuàng)建數(shù)據(jù)模型
        Map<String, Object> root = new HashMap<>();
        TestBean testBean = new TestBean();
        testBean.setPackageName(packageName);
        testBean.setClazzName(clazzName);
        testBean.setId(id);
        testBean.setSex(sex);
        testBean.setName(name);
        //這里的key的名稱要與模板里的名稱一致,否則無法進(jìn)行映射
        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");
    }
}

針對(duì)要設(shè)置config.setLocalizedLookup(false);的原因,我這里說明一下,由于調(diào)試的時(shí)候發(fā)現(xiàn)config.getTemplate(template)中,會(huì)將template的名稱改成myJavaFile_zh_CN.ftl,結(jié)構(gòu)導(dǎo)致無法通過getTemplate方法獲取到模板文件,究其原因就是內(nèi)部會(huì)根據(jù)語言環(huán)境對(duì)文件名改造,但也不是絕對(duì)的,后來重新創(chuàng)建的工程并沒有這樣的問題,所以這里僅供參考。

TestBean的變量名要與模板文件中引用的名稱一致,TestBean.java的實(shí)現(xiàn):

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;
    }
}

如此,我們的根據(jù)模板生成文件的工具類就實(shí)現(xiàn)好了,我們可以使用這個(gè)模板方法配置一個(gè)Gradle插件,通過gradle的配置的形式來實(shí)現(xiàn)自定義的文件。

3、結(jié)語

根據(jù)上述配置,我們可以實(shí)現(xiàn)一個(gè)簡(jiǎn)單的模板生成文件的工具方法。當(dāng)然這只是個(gè)demo,我們可以利用FreeMarker來根據(jù)自定義的ftl模板生成自己需要的文件。

傳送門

FreeMarkerDemo?

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 視頻鏈接 0 背景 我們網(wǎng)易前端技術(shù)部 - 移動(dòng)技術(shù)組作為公司的移動(dòng)端基礎(chǔ)技術(shù)部門,主要為其他部門提供解決方案、技...
    zyl06閱讀 2,826評(píng)論 0 17
  • 由于項(xiàng)目用上了 mvp 架構(gòu),基本上一個(gè)頁面就至少需要新創(chuàng)建6個(gè)類,分別是 model view presente...
    大空ts翼閱讀 2,119評(píng)論 0 4
  • 近天來我思想有點(diǎn)懶惰,回想起來太多關(guān)于我們的故事,從初中、高中、大學(xué)、結(jié)婚到有孩子這些年有美好有悲傷,但美...
    雁柏語藝閱讀 398評(píng)論 0 0
  • 五絕?雨寺 濛濛籠古寺,微雨潤(rùn)檐鈴。 鐘響青梢動(dòng),經(jīng)吟百念空。
    青山野渡閱讀 344評(píng)論 7 13
  • 1.【說話技巧】人設(shè)不對(duì),說什么都不對(duì)。 什么意思?比如,你爸媽催你早點(diǎn)結(jié)婚,如果人設(shè)是你叔叔輩,也就是和你爸媽是...
    易小六閱讀 939評(píng)論 0 0

友情鏈接更多精彩內(nèi)容