FreeMarker在struts2.1.8,JAVA,web中的应用实例



FreeMarker在struts2.1.8,JAVA,web中的应用实例教程。FreeMarker概述
FreeMarker是一个模板引擎，一个基于模板生成文本输出的通用工具，使用纯Java编写
Template + data model = output

FreeMarker 是一个非常优秀的模板引擎,这个模板引擎可用于任何场景,FreeMarker负责将数据模型中的数据合并到模板中,从而生成标准输出.界面开发人员只需要关注界面(也就是模板文件)的开发,而业务逻辑开发者只需要负责将需要显示的数据填入数据模型—–FreeMarker负责合并数据模型和模板, 从而生成标准输出。
FreeMarker特别适应于MVC模式的Web应用,虽然FreeMarker具有一些编程能力,但这种编程能力非常有限,无法实现业务逻辑, 只能提供一些数据格式的转换功能.因此,通常由Java程序准备要显示的数据,由FreeMarker模板引擎来生成页面,而FreeMarker模板则提供页面布局支持.（好处：严格实现MVC分离）
此外,FreeMarker也是与Web容器无关的,也就是FreeMarker并不一定需要运行在Web容器中:FreeMarker同样可以应用于非Web应用程序环境.而且,FreeMarker并不是只能生成HTML页面,它也可以生成各种文本,如XML,RTF,Java源代码等.
Struts2默认采用FreeMarker作为其模板文件,而Struts2所有的主题模板文件都是采用FreeMarker编写的,eclipse中的JSP,Java等模板文件也是采用FreeMarker技术.
一、在struts2中使用freemarker
以一个简单的添加用户信息为例：当用户点击首页中的“添加用户”连接时，这时会发出一个添加用户页面的请求（addInput.action）,然后通过我们的返回一个添加页面，下面是我们普通的struts2配置文件一般是这么配置的：

Xml代码  收藏代码
  1. <action name=”addInput” class=”com.freemarker.action.UserAction”>
  2.   <result>/addInput.jsp</result>
  3. </action>

addInput.jsp文件：

Html代码  收藏代码
  1. <%@ page language=”java” import=”java.util.*” pageEncoding=”ISO-8859-1″%>
  2. <html>
  3. <head>
  4. <meta http-equiv=”Content-Type” content=”text/html; charset=GB2312″>
  5. <title>Insert title here</title>
  6. </head>
  7. <body>
  8. 添加用户：
  9. <form action=”add.action” >
  10. username:<input type=”text” name=”username”/><br/>
  11. password:<input type=”password” name=”password”/>
  12. <input type=”submit” value=”add”/>
  13. </form>
  14. </body>
  15. </html>

或者采用struts2标签：

Html代码  收藏代码
  1. <%@ page language=”java” import=”java.util.*” pageEncoding=”ISO-8859-1″%>
  2. <%@taglib prefix=”s” uri=”/struts-tags”%>
  3. <html>
  4. <head>
  5. <meta http-equiv=”Content-Type” content=”text/html; charset=GB2312″>
  6. <title>Insert title here</title>
  7. </head>
  8. <body>
  9. 添加用户：
  10. <s:form action=”add” method=”post”>
  11.         <s:textfield label=”username:” name=”username”/>
  12.         <s:password label=”password:” name=”password”/>
  13.         <s:submit value=”add”/>
  14.     </s:form>
  15. </body>
  16. </html>

在action返回的view是一个jsp页面，也可以改成是一个freemarker模板页面：

Xml代码  收藏代码
  1. <action name=”addInput” class=”com.freemarker.action.UserAction”>
  2.    <result type=”freemarker”>/addInput.ftl</result>
  3. </action>

addInput.ftl模板文件
当然我们希望能在addInput.ftl上也能够使用struts2的标签，需要在addInput.ftl页面最开始添加对struts2标签的引用：<%@taglib prefix=”s” uri=”/struts-tags”%>
注意：struts2在freemarker页面中标签写法和jsp页面的写法不同，freemarker里是<@s.form>，jsp里是<s:form>，一定不要写错了！
使用时发现对中文的支持不好，显示时中文出现乱码，这里修改下struts.xml配置文件：
<constant name=”struts.i18n.encoding” value=”gb2312″ />
现在就可以在struts2中正常使用freemarker了!
二、在java程序中使用FreeMarker
FreeMarker的模板就是一个.ftl文本文件,在该文件中使用了一些FreeMarker的特别标记,这些标记会动态显示,或者控制程序输出,如下面的模板文件代码:

Html代码  收藏代码
  1. ${name}，你好！${msg}

这里类似于${}的就是动态的内容,称作”插值”.
为了使用FreeMarker来将数据模型中的值合并到模板文件中,可按如下步骤进行:
1,创建Configuration实例,该实例负责管理FreeMarker的模板加载路径,负责生成模板实例
2,使用Configuration实例来生成Template实例,同进需要指定使用的模板文件
3,填充数据模型,数据模型就是一个Map对象
4,调用Template实例的process方法完成合并.
下面来看看几个测试实例，以加深我们的对模板语言的认识：
实例一：Freemarker基本使用方法：
我们下面就用一个使用FreeMarker来创建一个java测试程序，将模板中的内容输出的指定的文件中,来简单了解一下其基本语法，程序源代码如下:

Java代码  收藏代码
  1. public void testFreemarker01() throws Exception{
  3.         //指定模板文件路径(在项目下，你可以修改此路径)
  4.         String dir = ”E:/workspace/freemarker/src/com/freemarker/test”;
  6.         //创建一个Configuration对象：该实例负责管理FreeMarker的模板加载路径,负责生成模板实例
  7.         Configuration cfg = new Configuration();
  9.         //配置freemarker从什么地方加载模板文件，通过创建的Configuration对象加载模板文件
  10.         cfg.setDirectoryForTemplateLoading(new File(dir));
  12.         //加载模板，生成模板实例对象，同时制定所使用的模板文件
  13.         Template template = cfg.getTemplate(“test01.ftl”);
  15.         //定义数据模型（Map对象），并填充数据
  16.         Map root = new HashMap();
  17.         root.put(“strvalue”, ”世界，你好”);
  19.         //定义输出，将其输出到指定文件中去
  20.         Writer out = new FileWriter(dir+”/test01_out.txt”);
  22.         //处理 执行，将模板与数据进行合并
  23.         template.process(root, out);
  24.     }

test01.ftl模板文件如下：

Html代码  收藏代码
  1. 第一个测试程序：${strvalue}

test01_out.txt文件内容结果：
第一个测试程序：世界，你好
实例二：Freemarker中关于空值的处理问题：
当在模板文件中取值，拿不到，为空值时，freemaker默认会将错误信息打印在页面中或输出到指定文件中，为了将错误信息隐藏到后台，而不要现在前台页面中，需要设置setTemplateExceptionHandler
来忽略异常信息，具体代码如下：

Java代码  收藏代码
  1. //关于空值的处理问题
  2.     public void testFreemarker02() throws Exception{
  4.         String dir = ”E:/workspace/freemarker/src/com/freemarker/test”;
  6.         Configuration cfg = new Configuration();
  8.         //配置freemarker从什么地方加载模板文件
  9.         cfg.setDirectoryForTemplateLoading(new File(dir));
  11.         [color=red]//增加设置忽略异常
  12.         cfg.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);[/color]
  14.         //加载模板
  15.         Template template = cfg.getTemplate(“test02.ftl”);
  17.         //定义数据
  18.         Map root = new HashMap();
  19.         //root.put(“strvalue”, ”世界，你好”);
  20.         root.put(“boolvalue”, true);
  21.         root.put(“today”, new Date());
  23.         //定义输出
  24.         Writer out = new FileWriter(dir+”/test02_out.txt”);
  26.         template.process(root, out);
  27.     }

贴出模板文件test02.ftl：

Html代码  收藏代码
  1. ${strvalue}
  2. ${boolvalue?string(“是”,”否”)}
  3. ${today?string(“yyyy年MM月dd日”)}

文件test02_out.txt显示结果：
是
2010年04月11日
如果上面的不设置忽略异常的话，则在模板文件中的${strvalue}将取不到值而在页面显示错误，当然可以在模板文件中可以使用条件判断将空值情况排除<#if strvalue?exists> </#if>。
实例三：关于集合处理的问题
在模板中显示数据模型中集合列表信息，
显示集合列表信息：<#list></#list>
条件判断：<#if 变量? exists ></#if>
条件${?string(“1″,”0″)}关于这些还是去看实例吧，我就不在这里描述了。从实例中去学习其语法。
具体代码如下：

Java代码  收藏代码
  1. //关于集合的处理
  2. public void testFreemarker03() throws Exception{
  4.     String dir = ”E:/workspace/freemarker/src/com/freemarker/test”;
  6.     Configuration cfg = new Configuration();
  8.     //配置freemarker从什么地方加载模板文件
  9.     cfg.setDirectoryForTemplateLoading(new File(dir));
  11.     //忽略异常
  12.     cfg.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
  14.     //加载模板
  15.     Template template = cfg.getTemplate(“test03.ftl”);
  17.     //定义数据
  18.     Map root = new HashMap();
  19.     List list = new ArrayList();
  20.     for(int i=0; i<10; i++){
  21.         list.add(“listvalue”+i);
  22.     }
  23.     root.put(“list”, list);
  25.     //定义输出
  26.     Writer out = new FileWriter(dir+”/test03_out.txt”);
  28.     template.process(root, out);
  29. }

test03.ftl模板文件如下：

Html代码  收藏代码
  1. listvalue:<#– 正常显示的文本信息 –>
  3. <#list list as v>
  4.     ${v} - ${v_index} [${v_has_next?string("y","n")}]
  5. </#list>

test03_out.txt显示结果如下：
listvalue:

listvalue0 – 0 [y]
listvalue1 – 1 [y]
listvalue2 – 2 [y]
listvalue3 – 3 [y]
listvalue4 – 4 [y]
listvalue5 – 5 [y]
listvalue6 – 6 [y]
listvalue7 – 7 [y]
listvalue8 – 8 [y]
listvalue9 – 9 [n]
实例四：关于宏定义的应用<#macro ></#macro>
贴出测试代码：

Java代码  收藏代码
  1. //关于freemarker的宏定义
  2.     public void testFreemarker04() throws Exception{
  4.         String dir = ”E:/workspace/freemarker/src/com/freemarker/test”;
  6.         Configuration cfg = new Configuration();
  8.         //配置freemarker从什么地方加载模板文件
  9.         cfg.setDirectoryForTemplateLoading(new File(dir));
  11.         //忽略异常
  12.         cfg.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
  14.         //加载模板
  15.         Template template = cfg.getTemplate(“test04.ftl”);
  17.         //定义数据
  18.         Map root = new HashMap();
  19.         root.put(“name”, ”李四”);
  21.         //定义输出
  22.         Writer out = new FileWriter(dir+”/test04_out.txt”);
  24.         template.process(root, out);
  25.     }

来看看模板文件test04.ftl：

Html代码  收藏代码
  1. <#macro greet p>
  2.     Hello,${p}
  3. </#macro>
  5. <@greet p=”张三” />
  6. <@greet p=”${name}” />

来看看输出文件的结果：

Hello,张三
Hello,李四
实例五：关于auto-import特性的使用,自动引入模板文件
贴出测试代码：

Java代码  收藏代码
  1. //关于auto-import特性
  2.     public void testFreemarker05() throws Exception{
  4.         String dir = ”E:/workspace/freemarker/src/com/freemarker/test”;
  6.         Configuration cfg = new Configuration();
  8.         //配置freemarker从什么地方加载模板文件
  9.         cfg.setDirectoryForTemplateLoading(new File(dir));
  11.         //忽略异常
  12.         cfg.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
  14.         //添加auto-import
  15.         cfg.addAutoImport(“my”, ”common.ftl”);
  17.         //加载模板
  18.         Template template = cfg.getTemplate(“test05.ftl”);
  20.         //定义数据
  21.         Map root = new HashMap();
  22.         root.put(“name”, ”李四”);
  24.         //定义输出
  25.         Writer out = new FileWriter(dir+”/test05_out.txt”);
  27.         template.process(root, out);
  28.     }

先来看看模板test05.ftl文件：

Html代码  收藏代码
  1. <@my.greet p=”张三” />
  2. <@my.greet p=”${name}” />

所有引入的模板common.ftl文件：

Html代码  收藏代码
  1. <#macro greet p>
  2.     Hello,${p}
  3. </#macro>

下面来看看输出文件test05_out.txt的结果信息：
Hello,张三
Hello,李四
说明：上面的代码创建了一个Map实例,这个Map将作为模板文件的数据模型,我们要使用FreeMarker必须导入freemarker.jar文件,FreeMarker的官网是http://freemarker.sourceforge.net/,虽然FreeMarker可以在Java程序中使用,但大部分时候还是用来生成HTML页面.

三、在Web应用中使用FreeMarker
在Web应用中使用FreeMarker跟在Java程序中使用并没有太大的区别.下面是是一个在Web中使用的例子,用来生成HTML页面的模板文件test.ftl内容如下:

Html代码  收藏代码
  1. <html>
  2. <head>
  3. <title>FreeMarker的HelloWorld</title>
  4. </head>
  5. <body>
  6. ${message}
  7. </body>
  8. </html>

我们在Web应用中使用FreeMarker时,应该让Servlet来合并模板和数据,因此,Servlet负责创建Configuration实例,并负责合并模板和数据,下面是Servlet源代码:

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

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

Xml代码  收藏代码
  1. <web-app>
  2. <servlet>
  3.    <servlet-name>hello</servlet-name>
  4.    <servlet-class>lee.HelloServlet</servlet-class>
  5. </servlet>
  6. <servlet-mapping>
  7.    <servlet-name>hello</servlet-name>
  8.    <url-pattern>/hello</url-pattern>
  9. </servlet-mapping>
  10. </web-app>

下面是在ssh框架中使用的加载模板的方式：

Java代码  收藏代码
  1. private static Configuration cfg = new Configuration();
  2.     static{
  3.         //配置freemarker从什么地方加载模板文件
  4.         cfg.setTemplateLoader(new ClassTemplateLoader(DocumentAction.class,”templates”));
  5.         cfg.setTemplateExceptionHandler(TemplateExceptionHandler.IGNORE_HANDLER);
  6.     }
  8.     public String dynaForm(int workflowId){
  10.         try {
  11.             //获得流程对应的表单定义对象
  12.             FlowForm form = formManager.findForm(workflowId);
  13.             if(form == null){
  14.                 return ”";
  15.             }
  17.             Template template = cfg.getTemplate(form.getTemplate());
  19.             Map root = new HashMap();
  20.             root.put(“form”, form);
  22.             Writer out = new StringWriter();
  24.             template.process(root, out);
  26.             return out.toString();
  27.         } catch (Exception e) {
  28.             e.printStackTrace();
  29.         }
  31.         return ”";
  32.     }

四、FreeMarker的模板文件
从上面的例子可以看到FreeMarker的模板文件并不比HTML页面复杂多少,FreeMarker模板文件主要由如下4个部分组成:
1,文本:直接输出的部分
2,注释:<#– … –>格式部分,不会输出
3,插值:即${…}或#{…}格式的部分,将使用数据模型中的部分替代输出
4,FTL指令:FreeMarker指定,和HTML标记类似,名字前加#予以区分,不会输出
下面是一个FreeMarker模板的例子,包含了以上所说的4个部分

Html代码  收藏代码
  1. <html><br>
  2. <head><br>
  3. <title>Welcome!</title><br>
  4. </head><br>
  5. <body><br>
  6. <#– 注释部分 –><br>
  7. <#– 下面使用插值 –>
  8. <h1>Welcome ${user} !</h1><br>
  9. <p>We have these animals:<br>
  10. <u1><br>
  11. <#– 使用FTL指令 –>
  12. <#list animals as being><br>
  13.    <li>${being.name} for ${being.price} Euros<br>
  14. <#list><br>
  15. <u1><br>
  16. </body><br>
  17. </html>

http://lzh166.iteye.com/blog/641265