FreeMarker的四種基本數據類型及其序列和哈希表

轉自：FreeMarker的四種基本數據類型及其序列和哈希表          作者：玄玉

這裏分兩塊來說：四種基本數據類型、序列和哈希表

package com.jadyer.util;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Map;

import freemarker.template.Configuration;
import freemarker.template.Template;
import freemarker.template.TemplateException;

public class FreeMarkerUtil {
    /**
     * 獲取指定目錄下的模板文件
     * @param name       模板文件的名稱
     * @param pathPrefix 模板文件的目錄
     */
    public Template getTemplate(String name, String pathPrefix) throws IOException{
        Configuration cfg = new Configuration(); //通過FreeMarker的Configuration對象可以讀取ftl文件
        cfg.setClassForTemplateLoading(this.getClass(), pathPrefix); //設置模板文件的目錄
        cfg.setDefaultEncoding("UTF-8");       //Set the default charset of the template files
        Template temp = cfg.getTemplate(name); //在模板文件目錄中尋找名爲"name"的模板文件
        return temp; //此時FreeMarker就會到類路徑下的"pathPrefix"文件夾中尋找名爲"name"的模板文件
    }

    /**
     * 根據模板文件輸出內容到控制檯
     * @param name       模板文件的名稱
     * @param pathPrefix 模板文件的目錄
     * @param rootMap    模板的數據模型
     */
    public void print(String name, String pathPrefix, Map<String,Object> rootMap) throws TemplateException, IOException{
        this.getTemplate(name, pathPrefix).process(rootMap, new PrintWriter(System.out));
    }

    /**
     * 根據模板文件輸出內容到指定的文件中
     * @param name       模板文件的名稱
     * @param pathPrefix 模板文件的目錄
     * @param rootMap    模板的數據模型
     * @param file       內容的輸出文件
     */
    public void printFile(String name, String pathPrefix, Map<String,Object> rootMap, File file) throws TemplateException, IOException{
        Writer out = new BufferedWriter(new OutputStreamWriter(new FileOutputStream(file), "UTF-8"));
        this.getTemplate(name, pathPrefix).process(rootMap, out); //將模板文件內容以UTF-8編碼輸出到相應的流中
        if(null != out){
            out.close();
        }
    }
}

這是位於//src//ftl//包中用於演示四種基本數據類型用法的dataType.ftl

<meta http-equiv="content-type" content="text/html; charset=UTF-8">


<#-- 定義變量 -->
<#assign myname="Jadyer"/>
${myname}


<#-- 定義數字 -->
<#assign mynum=10/>
${mynum + 20}


<#-- 定義字符串 -->
<#assign mystr="55"/>
${mystr + 20}
<#-- 下面的變量會覆蓋上面定義的同名變量，而不會顧及數據類型是否一致 -->
<#assign mystr=55/>
${mystr + 20}
<#-- 下面的兩種寫法是等價的，它們連接字符串的方式分別爲：字符串連接方式和插值連接方式 -->
${"hello,welcome:" + username}
${"hello,welcome:${username}"}


<#-- 定義布爾型 -->
<#-- 如果直接輸出${myflag}則會報錯，因爲FreeMarker不能直接輸出數字或字符串以外的東西，否則都會報錯 -->
<#-- 此時需要將其轉換爲字符串才能輸出：使用xxx?string可以完成對字符串的轉換。另外??用於判斷變量是否存在 -->
<#assign myflag=true/>
${myflag?string}
${myflag?string("isTrue","isFalse")}
${(user.name)???string("user.nameIsTrue","user.nameIsFalse")}


<#-- 日期類型的處理。如果直接輸出${currTime}則會報錯，此時仍需將其轉換爲字符串 -->
${currTime?string("yyyy-MM-dd HH:mm:ss")}
<#-- 字符串轉換爲日期。注意：這樣輸出${"2012-06-08 22:33:33"?time("HH:mm:ss")}時，會報錯 -->
<#assign mydate="2012-06-06"?date("yyy-MM-dd")>
${mydate}
${myTime?date("yyy-MM-dd")}
${"2012-06-08 22:33:33"?time("yyy-MM-dd HH:mm:ss")}
${"2012-06-09 22:44:44"?datetime("yyy-MM-dd HH:mm:ss")}


<#-- HTML的轉換。補充：更多FreeMarker內建函數請參考《FreeMarker2.3.19_Manual_zh_CN.pdf》第四部分 -->
${"<br/>"}
${"<br/>"?html}

這是位於//src//ftl//包中用於演示序列和哈希表用法的seqHash.ftl

<meta http-equiv="content-type" content="text/html; charset=UTF-8">


<#-- 定義序列 -->
<#assign mynums=[11,12,13,14,15,16,17,18,19]/>
<#list mynums as mn>
    ${mn}
</#list>


<#-- 拆分序列 -->
<#-- 這裏是將mynums序列中下標從3到6之間的元素拆分出來，組成一個新的序列 -->
<#assign mynum01=mynums[3..6]/>
<#list mynum01 as mn01>
    ${mn01}
</#list>

<#-- 拆分序列的引申:支持字符串的拆分 -->
<#-- 比如說博客文章概要時，可以採用這種方式，它要比CSS方便得多 -->
${"我本將心向明月，奈何明月照溝渠。"[5..9]}....


<#-- 連續序列 -->
<#-- 從55到58：注意此時若寫成[55..58]或者[66..68]則會報錯 -->
<#assign num01=55..58/>
<#list num01 as num>
    ${num}
</#list>
<#list 66..68 as num>
    ${num}
</#list>



<#-- 定義哈希表 -->
<#-- 注意：FreeMarker中的哈希表要求其key必須是字符串，包括數據模型中的java.util.HashMap的key也要是字符串，否則報錯 -->
<#assign maps={"1":"張起靈", "2":56, "3":"王胖子"}/>
${maps["1"]}
<#assign users={"username":"jadyer", "password":1234}/>
${users.username}----${(users.password)?int}----${users["password"]?string(0)}----${7.5?int}----${7.5?string(0)}


<#-- 遍歷哈希表 -->
<#-- 不能直接用list遍歷map，需要先將map的key轉換爲相應的序列 -->
<#assign keys=maps?keys/>
<#list keys as key>
    ${key}----${maps[key]}
</#list>

最後是用JUnit4.x寫的一個測試類FreeMarkerTest.java

package com.jadyer.test;

import java.io.File;
import java.io.IOException;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import org.junit.Before;
import org.junit.Test;

import com.jadyer.util.FreeMarkerUtil;

import freemarker.template.TemplateException;

public class FreeMarkerTest {
    String pathPrefix;
    File file;
    Map<String,Object> rootMap;
    FreeMarkerUtil fmu;

    @Before
    public void setUp(){
        pathPrefix = "/ftl";
        file = new File("D:\\ftl\\my.html");
        rootMap = new HashMap<String,Object>();
        fmu = new FreeMarkerUtil();
    }

    @Test
    public void printDateType() throws TemplateException, IOException{
        rootMap.put("username", "張小凡");
        rootMap.put("currTime", new Date());
        rootMap.put("myTime", "2012-06-07 22:22:22");
        fmu.print("dataType.ftl", pathPrefix, rootMap);
        fmu.printFile("dataType.ftl", pathPrefix, rootMap, file);
    }

    @Test
    public void printSeqHash() throws TemplateException, IOException{
        fmu.print("seqHash.ftl", pathPrefix, rootMap);
        fmu.printFile("seqHash.ftl", pathPrefix, rootMap, file);
    }
}