FreeMarker在struts2.0,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

普通的struts2配置文件一般是這麼配置的：

< action name = “ Action1 “ class = “ com.abc.Action1 “ >
< result >/ page.jsp </ result >
</ action >

這裏的view是一個jsp頁面，也可以改成是一個freemarker模板頁面：

< action name =”Action1″ class =”com.abc.Action1″ >
< result type =”freemarker” >/ fm.ftl </ result >
</ 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，添加如下內容：

     < servlet >
         < servlet-name > JspSupportServlet </ servlet-name >
         < servlet-class >
             org.apache.struts2.views.JspSupportServlet
         </ servlet-class >
         < load-on-startup > 1 </ load-on-startup >
     </ servlet >

一個簡單的fm.ftl文件的例子：

< #assign s = JspTaglibs[ " /WEB-INF/struts-tags.tld " ] />
< html >
< head >
< meta http - equiv = “ Content-Type “ content = “ text/html; charset=GB2312 “ >
< title > Insert title here </ title >
</ head >
< body >
< @s.form action = “Action1 .action “ >
< @s.textfield name = “ username “ ></ @s.textfield >
< @s.textfield name = “ password “ ></ @s.textfield >
< @s.submit value = “ 提交 “ />
</ @s.form >
< br /> 登錄用戶名：${username}
</ body >
</ html >

注意：struts2在freemarker頁面中標籤寫法和jsp頁面的寫法不同，freemarker裏是<@s.form>，jsp裏是<s:form>，一定不要寫錯了！

使用時發現對中文的支持不好，顯示時中文出現亂碼，這裏修改下struts.xml配置文件：

< constant name =”struts.i18n.encoding” value =”gb2312″ />

現在就可以在struts2中正常使用freemarker了!

自己的一個實例：

(1)在struts.xml添加跳轉:
<package name="loginPackage" extends="jason-default">
     <action name="jLogin" class="JLogin">
       <result name="success" >/WEB-INF/jason/index.jsp</result>
        <result name="error">/WEB-INF/jason/login.jsp</result>
        <result name="input">/WEB-INF/jason/login.jsp</result>
        <result name="search" type="freemarker">/ WEB-INF/templates/jsearch.ftl</result>
        <interceptor-ref name="jLoginStack"/>
     </action>
</package>

(2)
在ACTION中,進行設置:
..........
   Hits hits = JLuceneUtils.luceneSearch(indexPath, searchMess);
   System.out.println("----------hits.length():" + hits.length());
   for (int a = 0; a < hits.length(); a++) {
    Document doc2 = (Document) hits.doc(a);
    System.out.println(searchMess + "的值是:"+ doc2.get("confContext"));
    ActionContext.getContext().getSession().put("jsearch_value",

doc2.get("confContext"));
   }
   ActionContext.getContext().getSession().put ("jsearch_cout", hits.length());
   ActionContext.getContext().getSession().put("jsearch_name", searchMess);

(3)
設置模板文件:jsearch.ftl:
<#assign s=JspTaglibs["/WEB-INF/struts-tags.tld"] />
<html xmlns="http://www.w3.org/1999/xhtml ">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>jason search result</title>
</head>

<body>
<table width="98%" border="0" align="center" cellpadding="5" cellspacing="0">
<tr>
    <td><strong>以面是jason用lucene查詢的結果,共有${jsearch_cout}條符合：</strong></td>
</tr>
<tr>
    <#-- freemarker插值（如下，是利用EL語言,即將ACTION中的值先放入session/request/application） -->
    <td>查詢內容：${jsearch_name} --- 查詢值：${jsearch_value}</td>
</tr>
<tr>
    <td>
    <@s.url action="jLogin!login" id="login" />
    <a href="${login}">返回登錄主頁</a>
    </td>
</tr>
</table>
</body>
</html>

(4)
如果要使用STRUTS2.0的標籤,如上面.就要添加STRUTS2.0的標籤庫:
web.xml添加:
    <servlet>
        <servlet-name>JspSupportServlet</servlet-name>
        <servlet-class>
             org.apache.struts2.views.JspSupportServlet
        </servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>
在jsearch.ftl最前面添加:
<#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程序,程序源代碼如下:
package lee;
import java.util.*;
import java.io.*;
import freemarker.template.*;

public class HelloFreeMarker
{
    private Configuration cfg;
    public void init() throws Exception
{
        //初始化FreeMarker配置
        //創建一個Configuration實例
        cfg = new Configuration();
        //設置FreeMarker的模版文件位置
        cfg.setDirectoryForTemplateLoading(new File("templates"));
    }

public void process()throws Exception
{
        Map root = new HashMap();
        root.put("name", "FreeMarker!");
   root.put("msg" , "您已經完成了第一個FreeMarker的示例");
        Template t = cfg.getTemplate("test.ftl");
        t.process(root, new OutputStreamWriter(System.out));

}

public static void main(String[] args)throws Exception
{
   HelloFreeMarker hf = new HelloFreeMarker();
   hf.init();
   hf.process();
}
}
上面的代碼創建了一個Map實例,這個Map將作爲模板文件的數據模型,我們要使用FreeMarker必須導入freemarker.jar文件,FreeMarker的官網是 http://freemarker.sourceforge.net/ ,雖然FreeMarker可以在Java程序中使用,但大部分時候還是用來生成HTML頁面.

3,在Web應用中使用FreeMarker

在Web應用中使用FreeMarker跟在Java程序中使用並沒有太大的區別.下面是是一個在Web中使用的例子,用來生成HTML頁面的模板文件內容如下:
<html>
<head>
<title>FreeMarker的HelloWorld</title>
</head>
<body>
${message}
</body>
</html>
我們在Web應用中使用FreeMarker時,應該讓Servlet來合併模板和數據,因此,Servlet負責創建Configuration實例,並負責合併模板和數據,下面是Servlet源代碼:
package lee;
import java.util.*;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import freemarker.template.*;

public class HelloServlet extends HttpServlet
{
    private Configuration cfg;
    public void init()
{
        //初始化FreeMarker配置
        //創建一個Configuration實例
        cfg = new Configuration();
        //設置FreeMarker的模版文件位置
        cfg.setServletContextForTemplateLoading(getServletContext(), "WEB-INF/templates");
    }

    public void service(HttpServletRequest request, HttpServletResponse response)
        throws ServletException, IOException
{
        //建立數據模型
        Map root = new HashMap();
        root.put("message", "Hello FreeMarker!");
        //取得模版文件
        Template t = cfg.getTemplate("test.ftl");
        // 開始準備生成輸出
        // - 使用模版文件的charset作爲本頁面的charset
        // - 使用text/html MIME-type
        response.setContentType("text/html; charset=" + t.getEncoding());
        Writer out = response.getWriter();

        //合併數據模型和模版，並將結果輸出到out中
        try
   {
            t.process(root, out);
        }
   catch (TemplateException e)
   {
            throw new ServletException("處理Template模版中出現錯誤", e);
        }
    }
}
可以看到這個Servlet類的代碼與普通的Java程序中使用FreeMarker大致一樣,區別有兩個:1,設置FreeMarker加載模板的方法不一樣,在Servlet中設置加載的方法是setServletContextForTemplateLoading,第一個參數是本web應用的 ServletContext,第二個參數是模板文件的路徑.;2,結果必須輸出到HttpServletResponse中,才能被瀏覽器加載.
配置Servlet的web.xml文件中的代碼如下:
<web-app>
<servlet>
   <servlet-name>hello</servlet-name>
   <servlet-class>lee.HelloServlet</servlet-class>
</servlet>
<servlet-mapping>
   <servlet-name>hello</servlet-name>
   <url-pattern>/hello</url-pattern>
</servlet-mapping>
</web-app>

4,FreeMarker的模板文件

從上面的例子可以看到FreeMarker的模板文件並不比HTML頁面複雜多少,FreeMarker模板文件主要由如下4個部分組成:
1,文本:直接輸出的部分
2,註釋:<#-- ... -->格式部分,不會輸出
3,插值:即${...}或#{...}格式的部分,將使用數據模型中的部分替代輸出
4,FTL指令:FreeMarker指定,和HTML標記類似,名字前加#予以區分,不會輸出

下面是一個FreeMarker模板的例子,包含了以上所說的4個部分
<html><br>
<head><br>
<title>Welcome!</title><br>
</head><br>
<body><br>
<#-- 註釋部分 --><br>
<#-- 下面使用插值 -->
<h1>Welcome ${user} !</h1><br>
<p>We have these animals:<br>
<u1><br>
<#-- 使用FTL指令 -->
<#list animals as being><br>
<li>${being.name} for ${being.price} Euros<br>
<#list><br>
<u1><br>
</body><br>
</html>

freemarker,還可以用於生成代碼，或XML。（待續。。。）

springk

發佈了23 篇原創文章 · 獲贊 8 · 訪問量 16萬+

私信關注

FreeMarker在struts2.0,JAVA,web中的應用實例

FreeMarker概述

常用的 Git 指令

sm4加密工具類

Flink-Table StreamTableEnvironment實踐編程（四）中

Flink-Table API 實踐編程 StreamTableEnvironment（九）下

Flink-Table連接到外部系統（八）

Flink-Table SQL 實踐編程 StreamTableEnvironment（十）下

Flink-Table SQL 實踐編程 BatchTableEnvironment（十）中

Mac下配置sublime實現LaTeX

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結