1. 程式人生 > >FreeMarker中引入公共檔案的兩種方式

FreeMarker中引入公共檔案的兩種方式

這裡簡單敘述了一下<#include/>和<#import/>的用法

首先是自定義的工具類FreeMarkerUtil.java

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//包中用於演示最後效果的theImport.ftl

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

<#-- 使用<#include/>可能會出現同名變數被覆蓋的問題 -->
<#include "/inc/top.ftl"/>
<#include "/inc/body.ftl"/>
${myblog}

<#-- 可以使用<#import/>完成匯入,並且加入名稱空間 -->
<#import "/inc/top.ftl" as mytop/>
<#import "/inc/body.ftl" as mybody/>
${mytop.myblog}
${mybody.myblog}

<#-- 訪問名稱空間中的自定義指令 -->
<@mytop.myIncMacro/>

<#-- 也可在定義模板變數時指定其所屬的名稱空間,且此時就必須使用"名稱空間.變數名"的方法訪問了 -->
<#-- 另外其所指定的名稱空間不能憑空捏造,在本例中只能指定mytop or mybody -->
<#assign age=26 in mybody/>
${mybody.age}

這是位於//src//ftl//inc//包中的公共檔案top.ftl
<h2>Welcome ${visitor} to visit my blog</h2>
<hr/>

<#assign myblog="http://blog.csdn.net/jadyer"/>

<#macro myIncMacro>
	hello:inc macor
</#macro>

這是位於//src//ftl//inc//包中的公共檔案body.ftl
<#assign myblog="MyBlog—>http://blog.csdn.net/jadyer"/>

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

package com.jadyer.test;

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

import org.junit.Test;

import com.jadyer.util.FreeMarkerUtil;

import freemarker.template.TemplateException;

public class FreeMarkerTest {
	@Test
	public void printInc() throws TemplateException, IOException{
		Map<String,Object> rootMap = new HashMap<String,Object>();
		rootMap.put("visitor", "吳邪");
		new FreeMarkerUtil().print("theImport.ftl", "/ftl", rootMap);
		new FreeMarkerUtil().printFile("theImport.ftl", "/ftl", rootMap, new File("D:\\ftl\\my.html"));
	}
}