一．Freemarker簡介
二．環境搭建與配置
三．常用語法
四．與Struts結合
五．生成Html頁面
一．Freemarker簡介
什麼是Freemarker:.
Freemaker是一個”模板引擎”,也可以說是一個基於模板技術的生成文本輸出的一個通用工具.它是一個JAVA的包,一個JAVA程序員可以使用的
類庫.本身並不是一個對最終用戶的應用程序.但是,程序員可以把它應用到他們的產品中.
FreeMarker是設計爲可以生成WEB PAGES.它是基於SERVLET遵循MVC模式的.這個思路是應用MVC模式要降低分離,網頁設計人員和程序員的耦合.
每個人都可以做他們擅長的工作.網頁設計人員可以改變網頁的面貌,而並不需要程序員的重新編譯.因爲業務邏輯和頁面的設計已經被分離開了
.模板是不能由複雜的程序片斷組成的.即便網頁設計人員和程序員是一個人. 分離是有必要的.它能使程序更加的靈活和清晰.
雖然Freemarker能編程,但是它並不是一個編程語言.它是爲程序顯示數據而準備的.(像數據庫SQL語句的查詢.)以及.Freemarker僅僅是利用模
板加上數據生成文本頁面.
Freemarker並不是一個WEB應用程序框架.可以說是一個WEB應用框架的一個組件.但是FREEMARKER引擎本身並不瞭解HTTP或者SERVLETS.它只不過
生成文本而已.注意,它是MVC框架的一個組件(如STRUTS),也可以在模板中使用JSP標籤.
Freemarker下載地址爲：http://www.freemarker.org/index.html
一般的用途:
l 能用來生成任意格式的文本:HTML,XML,RTF,JAVA源碼,等等.
l可以更好的嵌入到你的產品中,輕量級的.並不需要servlet環境.不依賴javax.servlet.classes.
l可插入的模板讀取器:你可以從任意的源碼讀取任意的模板.本地的文件,數據庫等等.
l你可以做任意你想生成的文本.存儲爲本地文件.可以用來發送EMAIL或返回到WEB瀏覽器中.
強大的模板語言
l完整的指令:include,if/elseif/else,loop.
l 建立和修改模板中的變量.
l 能用複雜的表達式在任意地方指定變量.
n字符串操作:concateration,sub-string,uppercase,capitalize,escaping.等等
n十進制數學計算.
n BOOL
n讀取數組和相關的數組元素.
n可以自己添加特殊的計算方法.
l宏指令
l 命名空間用來創建和維護宏指令庫或者把大的項目分成許多模塊.並不用擔心命名衝突
二．環境搭建與配置
<!—freemarker初始配置-->
<servlet>
<servlet-name>freemarker</servlet-name>
<servlet-class>freemarker.ext.servlet.FreemarkerServlet</servlet-class>
<init-param>
<param-name>TemplatePath</param-name>
<param-value>/</param-value>
</init-param>
<init-param>
<param-name>NoCache</param-name>
<param-value>true</param-value>
</init-param>
<init-param>
<param-name>ContentType</param-name>
<param-value>text/html</param-value>
</init-param>
<init-param>
<param-name>template_update_delay</param-name>
<param-value>0</param-value>
</init-param>
<init-param>
<param-name>default_encoding</param-name>
<param-value>GBK</param-value>
</init-param>
<init-param>
<param-name>locale</param-name>
<param-value>zh_CN </param-value>
</init-param>
<init-param>
<param-name>number_format</param-name>
<param-value>0.##########</param-value>
</init-param>
<load-on-startup>2</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>action</servlet-name>
<url-pattern>*.do</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>freemarker</servlet-name>
<url-pattern>*.ftl</url-pattern>
</servlet-mapping>
----------------------------------------------------------------------------
三．常用語法
EG.一個對象BOOK
1.輸出 ${book.name}
空值判斷：${book.name?if_exists },
${book.name?default(‘xxx’)}//默認值xxx
${ book.name!"xxx"}//默認值xxx
日期格式：${book.date?string('yyyy-MM-dd')}
數字格式：${book?string.number}--20
${book?string.currency}--<#-- $20.00 -->
${book?string.percent}—<#-- 20% -->
插入布爾值：
<#assign foo=ture />
${foo?string("yes","no")} <#-- yes -->
2．邏輯判斷
a:
<#if condition>...
<#elseif condition2>...
<#elseif condition3>......
<#else>...
其中空值判斷可以寫成<#if book.name?? >
</#if>
b:
<#switch value>
<#case refValue1>
...
<#break>
<#case refValue2>
...
<#break>
...
<#case refValueN>
...
<#break>
<#default>
...
</#switch>
3．循環讀取
<#list sequence as item>
...
</#list>
空值判斷<#if bookList?size = 0></#list>
e.g.
<#list employees as e>
${e_index}. ${e.name}
</#list>
輸出:
1. Readonly
2. Robbin
4.FreeMarker
3 宏/模板
宏Macro
宏是在模板中使用macro指令定義
l.1 基本用法
宏是和某個變量關聯的模板片斷，以便在模板中通過用戶定義指令使用該變量，下面是一個例子：
<#macro greet>
<font size="+2">Hello Joe!</font>
</#macro>
調用宏時，與使用FreeMarker的其他指令類似，
只是使用@替代FTL標記中的#。
<@greet></@greet>
<#--<@greet/>-->
在macro指令中可以在宏變量之後定義參數，如：
<#macro greet person>
<font size="+2">Hello ${person}!</font>
</#macro>
可以這樣使用這個宏變量：
<@greet person="Fred"/>
但是下面的代碼具有不同的意思：
<@greet person=Fred/>
這意味着將Fred變量的值傳給person參數，該值不僅是字符串，還可以是其它類型，甚至是複雜的表達式。
宏可以有多參數，下面是一個例子：
<#macro greet person color>
<font size="+2" color="${color}">Hello ${person}!</font>
</#macro>
可以這樣使用該宏變量，其中參數的次序是無關的：
<@greet person="Fred" color="black"/>
可以在定義參數時指定缺省值，否則，在調用宏的時候，必須對所有參數賦值：
<#macro greet person color="black">
<font size="+2" color="${color}">Hello ${person}!</font>
</#macro>
注意：宏的參數是局部變量，只能在宏定義中有效。
在宏裏嵌套內容
FreeMarker的宏可以有嵌套內容，
<#nested>指令會執行宏調用指令開始和結束標記之間的模板片斷，舉一個簡單的例子：
<#macro border>
<table border=4 cellspacing=0 cellpadding=4><tr><td>
<#nested>
</tr></td></table>
</#macro>
執行宏調用：
<@border>The bordered text</@border>
輸出結果：
<table border=4 cellspacing=0 cellpadding=4>
<tr><td>
The bordered text
</tr></td>
</table>
<#nested>指令可以被多次調用，每次都會執行相同的內容。
<#macro do_thrice>
<#nested>
<#nested>
<#nested>
</#macro>
<@do_thrice>
Anything.
</@do_thrice>
FMPP 輸出結果：
Anything.
Anything.
Anything.
嵌套內容可以是有效的FTL，下面是一個有些複雜的例子，我們將上面三個宏組合起來：
<@border>
<ul>
<@do_thrice>
<li><@greet person="Joe"/>
</@do_thrice>
</ul>
</@border>
輸出結果：
<table border=4 cellspacing=0 cellpadding=4><tr><td>
<ul>
<li><font size="+2">Hello Joe!</font>
<li><font size="+2">Hello Joe!</font>
<li><font size="+2">Hello Joe!</font>
</ul>
</tr></td></table>
宏定義中的局部變量對嵌套內容是不可見的，例如：
<#macro repeat count>
<#local y = "test">
<#list 1..count as x>
${y} ${count}/${x}: <#nested>
</#list>
</#macro>
<@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")}</@repeat>
輸出結果：
test 3/1: ? ? ?
test 3/2: ? ? ?
test 3/3: ? ? ?
在宏定義中使用循環變量
nestted指令也可以有循環變量（循環變量的含義見下節），調用宏的時候在宏指令的參數後面依次列出循環變量的名字，格式如下：
<@ macro_name paramter list; loop variable list[,]>
例如：
<#macro repeat count>
<#list 1..count as x>
<#nested x, x/2, x==count>
</#list>
</#macro>
<@repeat count=4 ; c, halfc, last>
${c}. ${halfc}<#if last> Last!</#if>
</@repeat>
這裏count是宏的參數，c, halfc,last則爲循環變量，輸出結果：
1. 0.5
2. 1
3. 1.5
4. 2 Last!
循環變量和宏標記指定的不同不會有問題，如果調用時少指定了循環變量，那麼多餘的值不可見。調用時多指定了循環變量，多餘的循環變量
不會被創建：
<@repeat count=4 ; c, halfc, last>
${c}. ${halfc}<#if last> Last!</#if>
</@repeat>
<@repeat count=4 ; c, halfc>
${c}. ${halfc}
</@repeat>
<@repeat count=4>
Just repeat it...
</@repeat>
在模板中定義變量
在模板中定義的變量有三種類型：
plain變量：可以在模板的任何地方訪問，包括使用include指令插入的模板，使用assign指令創建和替換。
局部變量：在宏定義體中有效，使用local指令創建和替換。
循環變量：只能存在於指令的嵌套內容，由指令（如list）自動創建；宏的參數是局部變量，而不是循環變量
局部變量隱藏（而不是覆蓋）同名的plain變量；循環變量隱藏同名的局部變量和plain變量，下面是一個例子：
<#assign x = "plain">
${x} <#-- we see the plain var. here -->
<@test/>
6. ${x} <#-- the value of plain var. was not changed -->
<#list ["loop"] as x>
7. ${x} <#-- now the loop var. hides the plain var. -->
<#assign x = "plain2"> <#-- replace the plain var, hiding does not mater here -->
8. ${x} <#-- it still hides the plain var. -->
</#list>
9. ${x} <#-- the new value of plain var. -->
<#macro test>
2. ${x} <#-- we still see the plain var. here -->
<#local x = "local">
3. ${x} <#-- now the local var. hides it -->
<#list ["loop"] as x>
4. ${x} <#-- now the loop var. hides the local var. -->
</#list>
5. ${x} <#-- now we see the local var. again -->
</#macro>
輸出結果：
1. plain
2. plain
3. local
4. loop
5. local
6. plain
7. loop
8. loop
9. plain2
內部循環變量隱藏同名的外部循環變量，如：
<#list ["loop 1"] as x>
${x}
<#list ["loop 2"] as x>
${x}
<#list ["loop 3"] as x>
${x}
</#list>
${x}
</#list>
${x}
</#list>
輸出結果：
loop 1
loop 2
loop 3
loop 2
loop 1
模板中的變量會隱藏（而不是覆蓋）數據模型中同名變量，如果需要訪問數據模型中的同名變量，使用特殊變量global，下面的例子假設數據
模型中的user的值是Big Joe：
<#assign user = "Joe Hider">
${user} <#-- prints: Joe Hider -->
${.globals.user} <#-- prints: Big Joe -->
名字空間
通常情況，只使用一個名字空間，稱爲主名字空間，但爲了創建可重用的宏、變換器或其它變量的集合（通常稱庫），必須使用多名字空間，
其目的是防止同名衝突
創建庫
下面是一個創建庫的例子（假設保存在lib/my_test.ftl中）：
<#macro copyright date>
<p>Copyright (C) ${date} Julia Smith. All rights reserved.
<br>Email: ${mail}</p>
</#macro>
<#assign mail = "[email protected]">
使用import指令導入庫到模板中，Freemarker會爲導入的庫創建新的名字空間，並可以通過import指令中指定的散列變量訪問庫中的變量：
<#import "/lib/my_test.ftl" as my>
<#assign mail="[email protected]">
<@my.copyright date="1999-2002"/>
${my.mail}
${mail}
輸出結果：
<p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.
<br>Email: [email protected]</p>
[email protected]
[email protected]
可以看到例子中使用的兩個同名變量並沒有衝突，因爲它們位於不同的名字空間。還可以使用assign指令在導入的名字空間中創建或替代變量
，下面是一個例子：
<#import "/lib/my_test.ftl" as my>
${my.mail}
<#assign mail="[email protected]" in my>
${my.mail}
輸出結果：
[email protected]
[email protected]
數據模型中的變量任何地方都可見，也包括不同的名字空間，下面是修改的庫：
<#macro copyright date>
<p>Copyright (C) ${date} ${user}. All rights reserved.</p>
</#macro>
<#assign mail = "${user}@acme.com">
假設數據模型中的user變量的值是Fred，則下面的代碼：
<#import "/lib/my_test.ftl" as my>
<@my.copyright date="1999-2002"/>
${my.mail}
輸出結果：
<p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>[email protected]
四．Freemarker與Struts結合
1.輸出文件換成以ftl格式的文件
E.G.
<action name="bookActionForm" parameter="method" path="/bookAction" scope="request" type="example.BookAction"
validate="true">
<forward name="list" path="/index.ftl"/>
</action>
2.使用struts，jstl等標籤
a.導入à<#global html=JspTaglibs["/WEB-INF/tags/struts-html.tld"]>
或<#assign html=JspTaglibs["/WEB-INF/struts-html.tld"]>
<#assign bean=JspTaglibs["/WEB-INF/struts-bean.tld"]>
<#assign logic=JspTaglibs["/WEB-INF/struts-logic.tld"]>
b.使用à<@bean.page id="request" property="request"/>,
<@html.text property="vo.newsTitle" styleClass="input1"/>
五．用Freemarker生成Html頁面
例子：MakeFileManager.java
package example;
import freemarker.template.Configuration;
import java.text.SimpleDateFormat;
import java.io.File;
import freemarker.template.DefaultObjectWrapper;
import java.util.Map;
import java.util.HashMap;
import java.io.Writer;
import java.io.OutputStreamWriter;
import java.io.FileOutputStream;
import freemarker.template.TemplateException;
import java.io.IOException;
import freemarker.template.Template;
public class MakeFileManager {
public String make(Book book, BookFtl bookFtl) {
Configuration cfg = new Configuration();//配製
String realPath = bookFtl.getRealPath();
String templatePath = realPath + "/WEB-INF/templates/book";
String cDateStr = "book/" +
new SimpleDateFormat("yyyyMMdd").format(new java.util.
Date());
String filePostfix = ".html";
String path = realPath + "/" + cDateStr;
String fileTimeName = new SimpleDateFormat("yyyyMMddhhmmss").format(new
java.util.Date());
String returnFileName = cDateStr + "/" + fileTimeName + filePostfix;
String fileName = "";
File bookDir = new File(path);
if (bookDir.exists()) {
fileName = path + "/" + fileTimeName + filePostfix;
} else {
bookDir.mkdirs();
fileName = path + "/" + fileTimeName + filePostfix;
}
try {
//設置freemarker的參數
cfg.setNumberFormat("0.##########");//生成html文件時web.xml配製無效
//cfg.setEncoding();
cfg.setDirectoryForTemplateLoading(new File(templatePath));
cfg.setObjectWrapper(new DefaultObjectWrapper());
Template bookTemplate = cfg.getTemplate(bookFtl.getTemplateName());//模板對象
Map root = new HashMap();
root.put("book", book);
root.put("book2",book);
Writer out = new OutputStreamWriter(new FileOutputStream(fileName));
try {
bookTemplate.process(root, out);
} catch (TemplateException e) {
e.printStackTrace();
}
out.flush();
} catch (IOException e) {
e.printStackTrace();
}
return returnFileName;
}
}