FreeMarker在JAVA中应用入门

在项目中通常有生成XML文件发送到另一个系统的需求,简单的办法可以是用一个XML模板,通过Freemarker替换其中的'Mark'(${}),生成最终的XML文件.

下面记录了一下简单的示例步骤:

1,创建一个XML模板:

<?xml version="1.0" encoding="UTF-8"?>
<people  xmlns:h="http://www.w3.org/TR/html4/">
    <person id="000001" age="20">
        <name>
            <family>${p.fname}</family>
            <given>${p.gname}</given>
        </name>
        <email>${p.email}</email>
        <link manager="${p.manager}" />     
    </person>    
</people>

2,在Java中将mark用值替换掉:下面是JAVA代码

package com.test.xml.freemarker;

public class ValueObject {
    private String fname;
    private String gname;
    private String email;
    private String manager;
    public String getFname() {
        return fname;
    }
    public void setFname(String fname) {
        this.fname = fname;
    }
    public String getGname() {
        return gname;
    }
    public void setGname(String gname) {
        this.gname = gname;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    public String getManager() {
        return manager;
    }
    public void setManager(String manager) {
        this.manager = manager;
    }    
}
public class Test {
    Configuration freeMarkerCfg = new Configuration();
    Template template = null;
    public Test() {
        freeMarkerCfg.setClassForTemplateLoading(getClass(),"");
        freeMarkerCfg.setObjectWrapper(new DefaultObjectWrapper());
        try {
            template = freeMarkerCfg.getTemplate("test.xml");
        } catch (IOException e) {
            // TODO
            e.printStackTrace();
        }
    }

    public void generateRequest(ValueObject obj) {

        String reqFileName = "D:\\temp\\test.xml";
        try {
            Map<String, Object> parameters = new HashMap<String, Object>();

            parameters.put("p", obj);

            OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(reqFileName), "UTF-8");
            template.process(parameters, writer);
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();// TODO
        } catch (TemplateException e) {
            e.printStackTrace();// TODO
        }

    }
    public static void main(String[] args) {
        ValueObject val = new ValueObject();
        
        val.setFname("Yao");
        val.setGname("Yorker");
        val.setEmail("test@mail.com");
        val.setManager("manager");
        
        new Test().generateRequest(val);
    }
}

XML模板和class在package "com.test.xml.freemarker".

***在模板中通过${val}指定的值,如果在处理的时候val值为null,会出现下面的异常:

freemarker.core.InvalidReferenceException: Expression valis undefined on line 46, column 63 in test.ftl

FreeMarker这么做的本意是防止在传值的地方(Data Model)写入的参数,如想传入 parameters.put("abc", obj);,但是写成了parameters.put("abcd", obj);

但是有的时候,里面有的值不是必须有值的,可以通过${val!""}来绕过这个异常.${val!""}的意思是如果val为null,取值"".

***Freemarker对XML文件中特殊字符的处理:通过<#escape>

    <#escape x as x?xml>
    <person id="000001" age="20">
        <name>
            <family>${p.fname}</family>
            <given>${p.gname}</given>
        </name>
        <email>${p.email}</email>
        <link manager="${p.manager}" />
    </person>
    </#escape>

val.setManager("m&an<ager"); 传入的值就按照XML规范保存到XML文件 link manager="m&an<ager" />
***循环处理 <#list>

    <#list people as p>
    <person id="000001" age="20">
        <name>
            <family>${p.fname}</family>
            <given>${p.gname}</given>
        </name>
        <email>${p.email}</email>
        <link manager="${p.manager}" />
    </person>
    </#list>
        List<ValueObject> pList = new ArrayList<ValueObject>();
        ValueObject val = null;
        
        val = new ValueObject();        
        val.setFname("Yao");
        val.setGname("Yorker");
        val.setEmail("test@mail.com");
        val.setManager("m&an<ager");        
        pList.add(val);
        
        val = new ValueObject();        
        val.setFname("J");
        val.setGname("Jeremy");
        val.setEmail("test1@mail.com");
        val.setManager("m&an<ager");        
        pList.add(val);
        parameters.put("people", pList);

***分支处理<#if>,根据值对模板做不同的输出.

    <#if p.level == "L1">
    <l1tag>xxx</l1tag>
    </#if>

***对生成超大文件的测试:

    public void generateRequest(List<ValueObject> pList) {
        String reqFileName = "D:\\temp\\test.xml";
        try {
            Map<String, Object> parameters = new HashMap<String, Object>();
            parameters.put("people", pList);
            OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(reqFileName), "UTF-8");
            template.process(parameters, writer);
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();// TODO
        } catch (TemplateException e) {
            e.printStackTrace();// TODO
        }
    }
    public static void testLargeVolumn(){
        List<ValueObject> pList = new ArrayList<ValueObject>();
        ValueObject val = null;
        
        for(int i=0;i<400000;i++){
            val = new ValueObject();        
            val.setFname("Yao"+i);
            val.setGname("Yorker");
            val.setEmail("test@mail.com");
            val.setManager("m&an<ager");
            val.setLevel("L"+i);
            pList.add(val);
        }        
        new Test().generateRequest(pList);
    }

一次性输出,本例在达到循环400000次的时候异常:java.lang.OutOfMemoryError: Java heap space

解决办法:分多次输出到最终的输出文件中.

1,将模板需要循环的部分单独做成一个模板.

先一次输出循环模板前面的部分,分多次输出循环部分,一次输出循环部分之后的部分.

示例如下,(这里由于循环之前部分和之后部分不涉及模板替换,直接用JAVA代码输出)

模板需要循环输出的部分:

    <#escape x as x?xml>
    <#list people as p>
    <person id="000001" age="20">
        <name>
            <family>${p.fname}</family>
            <given>${p.gname}</given>
        </name>
        <email>${p.email}</email>
        <link manager="${p.manager}" />
        <#if p.level == "L1">
        <l1tag>xxx</l1tag>
        </#if>
    </person>
    </#list>
    </#escape>

JAVA代码:

public class LargeVolumnTest {
    Configuration freeMarkerCfg = new Configuration();
    Template template = null;
    public LargeVolumnTest() {
        freeMarkerCfg.setClassForTemplateLoading(getClass(),"");
        freeMarkerCfg.setObjectWrapper(new DefaultObjectWrapper());
        try {
            template = freeMarkerCfg.getTemplate("testL.xml");
        } catch (IOException e) {
            // TODO
            e.printStackTrace();
        }
    }

    public void generateRequestHeader() {
        String reqFileName = "D:\\temp\\test.xml";
        try {
            OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(reqFileName), "UTF-8");
            writer.write("<?xml version=\"1.0\" encoding=\"UTF-8\"?>");
            writer.write("<people  xmlns:h=\"http://www.w3.org/TR/html4/\">");
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();// TODO
        } 
    }
    public void generateRequestTail() {
        String reqFileName = "D:\\temp\\test.xml";
        try {
            OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(reqFileName,true), "UTF-8");
            writer.write("</people>");            
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();// TODO
        } 
    }
    
    public void generateRequest(List<ValueObject> pList) {
        String reqFileName = "D:\\temp\\test.xml";
        try {
            Map<String, Object> parameters = new HashMap<String, Object>();
            parameters.put("people", pList);
            OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(reqFileName,true), "UTF-8");
            template.process(parameters, writer);
            writer.flush();
        } catch (IOException e) {
            e.printStackTrace();// TODO
        } catch (TemplateException e) {
            e.printStackTrace();// TODO
        }
    }

    public  void testLargeVolumn(){
        generateRequestHeader();
        List<ValueObject> pList = new ArrayList<ValueObject>();
        ValueObject val = null;
        int i=0;
        for(;i<500000;i++){
            val = new ValueObject();        
            val.setFname("Yao"+i);
            val.setGname("Yorker");
            val.setEmail("test@mail.com");
            val.setManager("m&an<ager");
            val.setLevel("L"+i);
            pList.add(val);
            if(i%10000==0){
                generateRequest(pList);
                pList.clear();
            }
        }
        if(i%10000!=0){
            generateRequest(pList);
        }
        generateRequestTail();
    }
    public static void main(String[] args) {        
        new LargeVolumnTest().testLargeVolumn();
    }
}

注意在输出循环部分和结尾部分是通过追加到文件的方式:OutputStreamWriter writer = new OutputStreamWriter(new FileOutputStream(reqFileName,true), "UTF-8");
最终生成的XML文档有90M,没有报异常.
这里有FreeMarker的中文manual :http://download.csdn.net/user/kkdelta

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 196,099评论 5赞 462
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 82,473评论 2赞 373
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 143,229评论 0赞 325
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 52,570评论 1赞 267
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 61,427评论 5赞 358
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 46,335评论 1赞 273
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 36,737评论 3赞 386
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 35,392评论 0赞 254
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 39,693评论 1赞 294
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,730评论 2赞 312
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,512评论 1赞 326
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 32,349评论 3赞 314
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 37,750评论 3赞 299
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,017评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,290评论 1赞 251
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 41,706评论 2赞 342
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 40,904评论 2赞 335

推荐阅读更多精彩内容

  • Freemarker使用
    FreeMarker的模板文件并不比HTML页面复杂多少,FreeMarker模板文件主要由如下4个部分组成: 1...
    年轻小伙程序员阅读 2,898评论 0赞 5
  • Java初级面试题
    1. Java基础部分 基础部分的顺序：基本语法，类相关的语法，内部类的语法，继承相关的语法，异常的语法，线程的语...
    子非鱼_t_阅读 31,513评论 18赞 399
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,517评论 18赞 139
  • 小镇生活（二）
    回到这个小镇生活的那两年里，我感觉最明显的是睡得饱，每天晚上八点半以后，商铺逐一关门，小镇就安静了下来。 这正是读...
    静夜语思阅读 134评论 0赞 0
  • 2017-03-22
    敷完面膜再化妆? 这里才是问题的所在。 敷面膜之后，最要紧的事是不要给皮肤太多外来物质——皮肤这个时候犹如狂风中艰...
    Leeky_阅读 209评论 0赞 0