FreeMarker简易入门

FreeMarker是一个用Java语言编写的模板引擎，它基于自己定义的模板来生成文本输出。

官网：http://www.freemarker.org/

简易开发步骤如下：

1、下载Jar包：freemarker-2.3.21.jar

Maven下载配置：

<dependency>
  	<groupId>org.freemarker</groupId>
  	<artifactId>freemarker</artifactId>
  	<version>2.3.21</version>
</dependency>

2、创建一个模板文件Notice.ftl

亲爱的${data.recipient}：

  您好！

  请查看如下通知：
  ${data.content}

  感谢您的阅读！

- ${data.publisher}
- ${data.dateTime}

3、创建一个数据源类Notice.java

public class Notice {
	private String recipient;
	private String content;
	private String publisher;
	private String dateTime;
	
	//getters and setters
}

4、利用FreeMarker模板生成文本

package com.xjj.util;

import java.io.BufferedWriter;
import java.io.File;
import java.io.IOException;
import java.io.StringWriter;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import com.xjj.freeMarker.bean.Notice;

import freemarker.template.Configuration;
import freemarker.template.DefaultObjectWrapperBuilder;
import freemarker.template.Template;
import freemarker.template.Version;

public class FreeMarkerUtil {
	//模板所在路径
	public static final String PATH = "conf/freeMarker";

	public static Version version = new Version("2.3.21"); //FreeMarker版本号
	public static Configuration config;
	
	// 模板对象
	public static Template template;

	public static DefaultObjectWrapperBuilder defaultObjectWrapperBuilder;
	
	// 创建 Configuration 对象
	static {
		final File file = new File(FreeMarkerUtil.class.getResource("/"+PATH).getPath());
		config = new Configuration(version);
		// 设置默认编码 (至关重要 - 解决中文乱码问题)
		config.setDefaultEncoding("UTF-8");
		
		defaultObjectWrapperBuilder = new DefaultObjectWrapperBuilder(version); //用于创建defaultObjectWrapper
		
		try {
			// 设置模板的目录
			config.setDirectoryForTemplateLoading(file);
			// 设置对象包装器
			config.setObjectWrapper(defaultObjectWrapperBuilder.build());
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
	
	/**
	 * 根据template和dataMap生成文档内容
	 * @param templateName 模板文件名
	 * @param dataMap 需要填充的数据
	 * @return 生成的文档内容
	 */
	public static <T> String buildContent(final String templateName, final Map<String, T> dataMap) {
		// 返回结果
		String result = null;
		try	{
			// 从模板目录下获取指定 ftl 模板文件
			template = config.getTemplate(templateName);
			// 设置文件编码
			template.setEncoding("UTF-8");
			// 字符串 字符输出流
			final StringWriter stringWriter = new StringWriter();
			final BufferedWriter bufferedWriter = new BufferedWriter(stringWriter);
			// 把 数据源写到模板中
			template.process(dataMap, bufferedWriter);
			
			// 获取输出的文本 (调用其 toString方法获得String)
			result = stringWriter.toString();
			// 刷新
			bufferedWriter.flush();
			// 关闭输出流
			bufferedWriter.close();
			
		} catch (Exception e) {
			e.printStackTrace();
		}
		
		return result;
	}
	
	//测试
	public static void main(String[] args) {
		Notice notice = new Notice();
		notice.setRecipient("张三");
		notice.setPublisher("系统管理员");
		notice.setContent("这是通知内容，请记住。\n不要问我是谁！");
		SimpleDateFormat df = new SimpleDateFormat("yyyy年MM月dd日 HH时mm分ss秒");
		notice.setDateTime(df.format(new Date()));
		
		Map<String, Notice> dataMap = new HashMap<String, Notice>();
		dataMap.put("data", notice);
		
		String templateName = "Notice.ftl";
		String content = FreeMarkerUtil.buildContent(templateName, dataMap);
		
		System.out.print(content);
	}
}

测试结果如下：

亲爱的张三：

  您好！

  请查看如下通知：
  这是通知内容，请记住。
不要问我是谁！

  感谢您的阅读！

- 系统管理员
- 2014年12月11日 09时11分33秒