FreeMarker是一個模板引擎,一個基于模板生成文本輸出的通用工具,使用純Java編寫
FreeMarker被設計用來生成HTML Web頁面,特別是基于MVC模式的應用程序
雖然FreeMarker具有一些編程的能力,但通常由Java程序準備要顯示的數據,由FreeMarker生成頁面,通過模板顯示準備的數據。
FreeMarker不是一個Web應用框架,而適合作為Web應用框架一個組件
FreeMarker與容器無關,因為它并不知道HTTP或Servlet;FreeMarker同樣可以應用于非Web應用程序環境
FreeMarker更適合作為Model2框架(如Struts)的視圖組件,你也可以在模板中使用JSP標記庫
FreeMarker是免費的
1、通用目標
能夠生成各種文本:HTML、XML、RTF、Java源代碼等等
易于嵌入到你的產品中:輕量級;不需要Servlet環境
插件式模板載入器:可以從任何源載入模板,如本地文件、數據庫等等
你可以按你所需生成文本:保存到本地文件;作為Email發送;從Web應用程序發送它返回給Web瀏覽器
2、強大的模板語言
所有常用的指令:include、if/elseif/else、循環結構
在模板中創建和改變變量
幾乎在任何地方都可以使用復雜表達式來指定值
命名的宏,可以具有位置參數和嵌套內容
名字空間有助于建立和維護可重用的宏庫,或者將一個大工程分成模塊,而不必擔心名字沖突
輸出轉換塊:在嵌套模板片段生成輸出時,轉換HTML轉義、壓縮、語法高亮等等;你可以定義自己的轉換
3、通用數據模型
freeMarker不是直接反射到Java對象,Java對象通過插件式對象封裝,以變量方式在模板中顯示
你可以使用抽象(接口)方式表示對象(JavaBean、XML文檔、SQL查詢結果集等等),告訴模板開發者使用方法,使其不受技術細節的打擾
4、為Web準備
- 在模板語言中內建處理典型Web相關任務(如HTML轉義)的結構
- 能夠集成到Model2 Web應用框架中作為JSP的替代
- 支持JSP標記庫
- 為MVC模式設計:分離可視化設計和應用程序邏輯;分離頁面設計員和程序員
5、智能的國際化和本地化
- 字符集智能化(內部使用UNICODE)
- 數字格式本地化敏感
- 日期和時間格式本地化敏感
- 非US字符集可以用作標識(如變量名)
- 多種不同語言的相同模板
6、強大的XML處理能力
<#recurse> 和<#visit>指令(2.3版本)用于遞歸遍歷XML樹
在模板中清楚和直覺的訪問XML對象模型
Helloworld
新建一個WEB工程,下載(我使用的是freemarker-2.3.20)freemarker并導入freemarker.jar,在WEB-INF下新建文件夾templates用于存放模版文件
在templates下新建test.ftl,這是示例模版文件。內容就是HTML內容,里面帶有一個標記符,用于將來進行變量替換,內容如下:
1
2
3
4
5
6
7
8
|
< html > < head > < title >freemarker測試</ title > </ head > < body > < h1 >${message},${name}</ h1 > </ body > </ html > |
新建一個Servlet,用于請求設置變量,并處理模版的輸出:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
package com.test.servlet; import java.io.IOException; import java.io.Writer; import java.util.HashMap; import java.util.Map; import javax.servlet.ServletException; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import freemarker.template.Configuration; import freemarker.template.Template; import freemarker.template.TemplateException; @SuppressWarnings ( "serial" ) public class HelloFreeMarkerServlet extends HttpServlet { // 負責管理FreeMarker模板的Configuration實例 private Configuration cfg = null ; public void init() throws ServletException { // 創建一個FreeMarker實例 cfg = new Configuration(); // 指定FreeMarker模板文件的位置 cfgsetServletContextForTemplateLoading(getServletContext(), "/WEB-INF/templates" ); } @SuppressWarnings ( "unchecked" ) public void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { // 建立數據模型 Map root = new HashMap(); root.put( "message" , "hello world" ); root.put( "name" , "java小強" ); // 獲取模板文件 Template t = cfg.getTemplate( "test.ftl" ); // 使用模板文件的Charset作為本頁面的charset // 使用text/html MIME-type responsesetContentType( "text/html; charset=" + tgetEncoding()); Writer out = response.getWriter(); // 合并數據模型和模板,并將結果輸出到out中 try { tprocess(root, out); // 往模板里寫數據 } catch (TemplateException e) { e.printStackTrace(); } } public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doPost(request, response); } public void destroy() { super .destroy(); } } |
注意要在你的web.xml中配置該Servlet:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
<? xml version = "1.0" encoding = "UTF-8" ?> < web-app version = "2.5" xmlns = "http://java.sun.com/xml/ns/javaee" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"> < servlet > < servlet-name >hello</ servlet-name > < servlet-class > com.test.servlet.HelloFreeMarkerServlet </ servlet-class > </ servlet > < servlet-mapping > < servlet-name >hello</ servlet-name > < url-pattern >/hello</ url-pattern > </ servlet-mapping > < welcome-file-list > < welcome-file >index.jsp</ welcome-file > </ welcome-file-list > </ web-app > |
為了方便測試,訪問工程直接跳轉到Servlet,對主頁index.jsp做一個簡單修改:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
<%@ page language= "java" import = "java.util.*" pageEncoding= "UTF-8" %> <% String path = request.getContextPath(); String basePath = request.getScheme()+ "://" +request.getServerName() + ":" +request.getServerPort()+path+ "/" ; %> <html> <body> <% String mypath = "hello" ; response.sendRedirect(basePath + mypath); %> </body> </html> |