Freemarker是一款模板引擎。
模板 + 数据模型 = 输出
从上图不难看出FreeMarker就是将数据模型中的值填充到模板文件中指定的插值处,最后将填充后的文本形式输出。
使用FreeMarker将数据模型中的值合并到模板文件中,一般有以下步骤:
1、创建Configuration实例,该实例负责管理FreeMarker的模板加载路径,负责生产模板实例。
2、使用Configuration实例来生成Template实例,同时需要指定使用的模板文件。
3、填充数据模型,数据模型一般就是一个Map对象。
4、调用Template实例的process()方法完成合并。
**在Java中使用FreeMarker
**
FreeMarkerTest.java
public class FreeMarkerTest {
private Configuration cfg = null;
public static void main(String[] args) throws Exception {
FreeMarkerTest maker = new FreeMarkerTest();
maker.init();
maker.process();
}
//初始化工作
public void init() throws Exception {
cfg = new Configuration();
//设置模板文件位置
cfg.setDirectoryForTemplateLoading(new File("src/template"));
}
//模板 + 数据模型 = 输出
public void process() throws Exception {
//创建数据模型
Map<String, String> rootMap = new HashMap<String, String>();
rootMap.put("name", "FreeMarker");
rootMap.put("message", "FreeMarker For Java Project");
//使用Configuration实例加载指定模板
Template template = cfg.getTemplate("user.ftl");
//合并处理(模板 + 数据模型)
template.process(rootMap, new OutputStreamWriter(System.out));
}
}
创建的Map对象rootMap作为模板文件的数据模型,该数据模型中的两个Value值会填充到模板(user.ftl)中对应key值的插值处。
user.ftl
${name}, ${message}
Console
FreeMarker, FreeMarker For Java Project
**在Java Web中使用FreeMarker
**大部分时候FreeMarker都用于在Web应用中生成HTML页面。
FreeMarkerServlet.java
public class FreeMarkerServlet extends HttpServlet {
private Configuration cfg = null;
public void init() throws ServletException {
cfg = new Configuration();
//设置模板文件位置
cfg.setServletContextForTemplateLoading(getServletContext(), "/template");
}
public void doGet(HttpServletRequest request, HttpServletResponse response) {
//建立数据模型
Map<String, String> rootMap = new HashMap<String, String>();
rootMap.put("name", "FreeMarker模板");
rootMap.put("message", "FreeMarker For JavaWeb");
try {
//取得模板文件
Template template = cfg.getTemplate("hello.ftl");
response.setContentType("text/html; charset=utf-8 ");
Writer out = response.getWriter();
//合并数据模型和模板,并将结果输出到response.getWriter()中
template.process(rootMap, out);
}catch(IOException e) {
e.printStackTrace();
}catch(TemplateException t) {
t.printStackTrace();
}
}
}
hello.ftl
<html>
<head>
<title>FreeMarker For JavaWeb</title>
</head>
<body>
<h1 style = "color:blue">${name}</h1>
<h1 style = "color:red">${message}</h1>
</body>
</html>
访问 http://localhost:8080/FreeMarkerForJavaWeb/FreeMarkerServlet结果页面:
这两个示例的不同之处在于Servlet中加载模板的方法是setServletContextForTemplateLoading(Object o, String s),该方法的第一个参数是本应用的ServletContext实例,第二个参数是模板文件所在的路径。
**在Struts2中使用FreeMarker
**
index.jsp
<body>
<h1>Register Information</h1>
<s:form action="login" method="post">
<s:label value="username" />
<!-- name属性和Action中的字段名一致 -->
<s:textfield id="username" name="name" />
<s:label value="password" />
<s:password id="password" name="pwd" />
<s:label value="age" />
<s:textfield id="age" name="age" />
<s:label value="register" />
<s:textfield id="register" name="registerDate" />
<s:submit value="submit" />
</s:form>
<hr>
</body>
LoginAction.java
public class LoginAction extends ActionSupport {
private String name;
private String pwd;
private int age;
private Date registerDate;
省略getter、setter
@Override
public String execute() throws Exception {
return SUCCESS;
}
}
struts.xml
<struts>
<package name="FreeMarker For Struts2" extends="struts-default">
<action name="login" class="cn.struts2.action.LoginAction">
<result type="freemarker">/WEB-INF/templates/userlist.ftl</result>
</action>
</package>
</struts>
userlist.ftl
<html>
<head>
</head>
<body>
用户名:${name} <br>
密码:${pwd} <br>
年龄:${age} <br>
注册日期:${registerDate} <br>
</body>
</html>