基于servlet的 Freemarker Demo

FreeMarker简介

FreeMarker模板文件主要由如下4个部分组成:

1,文本:直接输出的部分  //无论是json格式和html格式都变得非常的方便。

2,注释:<#-- ... -->格式部分,不会输出

3,插值:即${...}或#{...}格式的部分,将使用数据模型中的部分替代输出

4,FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出

在java程序中使用FreeMarker

FreeMarker的模板就是一个.ftl文本文件,在该文件中使用了一些FreeMarker的特别标记,这些标记会动态显示,或者控制程序输出,如下面的模板文件代码:

${name}，你好！${msg}

这里类似于${}的就是动态的内容,称作"插值".

为了使用FreeMarker来将数据模型中的值合并到模板文件中,可按如下步骤进行:

1,创建Configuration实例,该实例负责管理FreeMarker的模板加载路径,负责生成模板实例

2,使用Configuration实例来生成Template实例,同进需要指定使用的模板文件

3,填充数据模型,数据模型就是一个Map对象

4,调用Template实例的process方法完成合并.

pom.xml 添加freemarker的依赖包：

Code:

1. <dependency>  
2.         <groupId>org.freemarker</groupId>  
3.         <artifactId>freemarker</artifactId>  
4.         <version>2.3.16</version>  
5. </dependency>  

 

servlet程序：

Code:

1. import java.util.*;  
2. import java.io.*;  
3. import javax.servlet.*;  
4. import javax.servlet.http.*;  
5. import freemarker.template.*;  
6.   
7. public class HelloServlet extends HttpServlet{  
8.     private static final long serialVersionUID = 1L;  
9.     private Configuration cfg;   
10.     public void init() {  
11.         //初始化FreeMarker配置  
12.         //创建一个Configuration实例   第一步
13.         cfg = new Configuration();  
14.         //设置FreeMarker的模版文件位置   
    
15.         cfg.setServletContextForTemplateLoading(getServletContext(), "WEB-INF/templates");  
16.     }  
17.   
18.     public void service(HttpServletRequest request, HttpServletResponse response)  
19.         throws ServletException, IOException{          
20.         //建立数据模型  第二步
    
21.         Map root = new HashMap();  
22.         root.put("message", "Hello FreeMarker!");       
23.         //取得模版文件  第三步
24.         Template t = cfg.getTemplate("test.ftl");          
25.         // 开始准备生成输出  
26.         // - 使用模版文件的charset作为本页面的charset  
27.         // - 使用text/html MIME-type  
28.         response.setContentType("text/html; charset=" + t.getEncoding());  
29.         Writer out = response.getWriter();  
30.         //合并数据模型和模版，并将结果输出到out中  
31.         try{  
32.             t.process(root, out);   //第四步
    
33.         }   
34.    catch (TemplateException e){  
35.             throw new ServletException("处理Template模版中出现错误", e);  
36.         }  
37.     }  
38. }  

web.xml 配置：

Code:

1. <servlet>  
2.     <servlet-name>ServletFM</servlet-name>  
3.     <servlet-class>HelloServlet</servlet-class>  
4.   </servlet>  
5.   <servlet-mapping>  
6.     <servlet-name>ServletFM</servlet-name>  
7.     <url-pattern>/ServletFM</url-pattern>  
8.   </servlet-mapping>  

输出结果：

Code:

1. Hello FreeMarker!   

   可以看到这个Servlet类的代码与普通的Java程序中使用FreeMarker大致一样,区别有两个:1,设置FreeMarker加载模板的方法不一样,在Servlet中设置加载的方法是setServletContextForTemplateLoading,第一个参数是本web应用的ServletContext,第二个参数是模板文件的路径.;2,结果必须输出到HttpServletResponse中,才能被浏览器加载.