现在的位置: 首页 > 综合 > 正文

FreeMarker概述

2013年04月09日 ⁄ 综合 ⁄ 共 12420字 ⁄ 字号 小 中 大 ⁄ 评论关闭

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技术.
1.
在struts2中使用freemarker
普通的struts2配置文件一般是这么配置的：
<action name=“Action1“ class=“com.abc.Action1“>
    <result>/page.jsp</result>
</action>
这里的view是一个jsp页面，也可以改成是一个freemarker模板页面：

Java代码 复制代码
  1. <action name=”Action1″ class=”com.abc.Action1″>   
  2.     <result type=”freemarker”>/fm.ftl</result>   
  3. </action>  

 

当然我们希望能在fm.ftl上使用struts2的标签，需要在fm.ftl页面最开始添加对struts2标签的引用：
<#assign s=JspTaglibs["/WEB-INF/struts-tags.tld"] />
引用前把struts2-core-2.0.x.x.jar包里的META-INF/struts-tags.tld 复制到 /WEB-INF/struts-tags.tld
默认是不支持JspTaglibs的引用的，这里还需要一个额外的配置，修改web.xml，添加如下内容：

Java代码 复制代码
  1. <servlet>   
  2.     <servlet-name>JspSupportServlet</servlet-name>   
  3.     <servlet-class>   
  4.          org.apache.struts2.views.JspSupportServlet   
  5.     </servlet-class>   
  6.     <load-on-startup>1</load-on-startup>   
  7. </servlet>  

 

一个简单的fm.ftl文件的例子：

Html代码 复制代码
  1. <#assign s=JspTaglibs["/WEB-INF/struts-tags.tld"] />  
  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. <@s.form action=“Action1.action“>  
  9. <@s.textfield name=“username“></@s.textfield>  
  10. <@s.textfield name=“password“></@s.textfield>  
  11. <@s.submit value=“提交“/>  
  12. </@s.form>  
  13. <br/>登录用户名：${username}   
  14. </body>  
  15. </html>  

 

注意：struts2在freemarker页面中标签写法和jsp页面的写法不同，freemarker里是<@s.form>，jsp里是<s:form>，一定不要写错了！
使用时发现对中文的支持不好，显示时中文出现乱码，这里修改下struts.xml配置文件：

Java代码 复制代码
  1. <constant name=”struts.i18n.encoding” value=”gb2312″ />  

 

现在就可以在struts2中正常使用freemarker了!
 
自己的一个实例：
(1)在struts.xml添加跳转:
Java代码 复制代码
  1. <package name="loginPackage" extends="jason-default">   
  2.     <action name="jLogin" class="JLogin">   
  3.       <result name="success" >/WEB-INF/jason/index.jsp</result>   
  4.        <result name="error">/WEB-INF/jason/login.jsp</result>   
  5.        <result name="input">/WEB-INF/jason/login.jsp</result>   
  6.        <result name="search" type="freemarker">/WEB-INF/templates/jsearch.ftl</result>   
  7.        <interceptor-ref name="jLoginStack"/>   
  8.     </action>   
  9. </package>  

 

(2)
在ACTION中,进行设置:
Java代码 复制代码
  1. ..........   
  2.    Hits hits = JLuceneUtils.luceneSearch(indexPath, searchMess);   
  3.    System.out.println("----------hits.length():" + hits.length());   
  4.    for (int a = 0; a < hits.length(); a++) {   
  5.     Document doc2 = (Document) hits.doc(a);   
  6.     System.out.println(searchMess + "的值是:"+ doc2.get("confContext"));   
  7.     ActionContext.getContext().getSession().put("jsearch_value",    
  8. doc2.get("confContext"));   
  9.    }   
  10.    ActionContext.getContext().getSession().put("jsearch_cout", hits.length());   
  11.    ActionContext.getContext().getSession().put("jsearch_name", searchMess);  

 

(3)
设置模板文件:jsearch.ftl:

Html代码 复制代码
  1. <#assign s=JspTaglibs["/WEB-INF/struts-tags.tld"] />  
  2. <html xmlns="http://www.w3.org/1999/xhtml">  
  3. <head>  
  4. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />  
  5. <title>jason search result</title>  
  6. </head>  
  7. <body>  
  8. <table width="98%" border="0" align="center" cellpadding="5" cellspacing="0">  
  9.   <tr>  
  10.     <td><strong>以面是jason用lucene查询的结果,共有${jsearch_cout}条符合：</strong></td>  
  11.   </tr>  
  12.   <tr>  
  13.     <#-- freemarker插值（如下，是利用EL语言,即将ACTION中的值先放入session/request/application） -->  
  14.     <td>查询内容：${jsearch_name} --- 查询值：${jsearch_value}</td>  
  15.   </tr>  
  16.   <tr>  
  17.     <td>  
  18.     <@s.url action="jLogin!login" id="login" />  
  19.     <a href="${login}">返回登录主页</a>  
  20.     </td>  
  21.   </tr>  
  22. </table>  
  23. </body>  
  24. </html>  

 (4)
如果要使用STRUTS2.0的标签,如上面.就要添加STRUTS2.0的标签库:
web.xml添加:
   

Java代码 复制代码
  1. <servlet>   
  2.         <servlet-name>JspSupportServlet</servlet-name>   
  3.         <servlet-class>   
  4.              org.apache.struts2.views.JspSupportServlet   
  5.         </servlet-class>   
  6.         <load-on-startup>1</load-on-startup>   
  7.     </servlet>  

 在jsearch.ftl最前面添加:

Java代码 复制代码
  1. <#assign s=JspTaglibs["/WEB-INF/struts-tags.tld"] />  

  

2,在java程序中使用FreeMarker
FreeMarker的模板就是一个.ftl文本文件,在该文件中使用了一些FreeMarker的特别标记,这些标记会动态显示,或者控制程序输出,如下面的模板文件代码:
${name}，你好！${msg}
这里类似于${}的就是动态的内容,称作"插值".
为了使用FreeMarker来将数据模型中的值合并到模板文件中,可按如下步骤进行:
1,创建Configuration实例,该实例负责管理FreeMarker的模板加载路径,负责生成模板实例
2,使用Configuration实例来生成Template实例,同进需要指定使用的模板文件
3,填充数据模型,数据模型就是一个Map对象
4,调用Template实例的process方法完成合并.
下面是一个使用FreeMarker创建输出的Java程序,程序源代码如下:
Java代码 复制代码
  1. package lee;   
  2. import java.util.*;   
  3. import java.io.*;   
  4. import freemarker.template.*;   
  5. public class HelloFreeMarker   
  6. {   
  7.     private Configuration cfg;    
  8.     public void init() throws Exception   
  9. {   
  10.         //初始化FreeMarker配置   
  11.         //创建一个Configuration实例   
  12.         cfg = new Configuration();   
  13.         //设置FreeMarker的模版文件位置   
  14.         cfg.setDirectoryForTemplateLoading(new File("templates"));   
  15.     }   
  16.        
  17. public void process()throws Exception   
  18. {   
  19.         Map root = new HashMap();   
  20.         root.put("name", "FreeMarker!");    
  21.    root.put("msg" , "您已经完成了第一个FreeMarker的示例");   
  22.         Template t = cfg.getTemplate("test.ftl");   
  23.         t.process(root, new OutputStreamWriter(System.out));   
  24. }   
  25. public static void main(String[] args)throws Exception   
  26. {   
  27.    HelloFreeMarker hf = new HelloFreeMarker();   
  28.    hf.init();   
  29.    hf.process();    
  30. }   
  31. }  

 上面的代码创建了一个Map实例,这个Map将作为模板文件的数据模型,我们要使用FreeMarker必须导入freemarker.jar文件,FreeMarker的官网是http://freemarker.sourceforge.net/,虽然FreeMarker可以在Java程序中使用,但大部分时候还是用来生成HTML页面.

3,在Web应用中使用FreeMarker
在Web应用中使用FreeMarker跟在Java程序中使用并没有太大的区别.下面是是一个在Web中使用的例子,用来生成HTML页面的模板文件内容如下:
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.     }   
  18.        
  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();   
  32.            
  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>  

 4,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>  
返回
【上篇】
【下篇】

作者:

抱歉!评论已关闭.

返回首页

Copyright © 2013-2018 学步园  保留所有权利.
软文销售 QQ客服：2265327166 点击这里给我发消息（其他合作也可洽谈）
必威体育
必威电竞