一．Freemarker簡(jiǎn)介
二．環(huán)境搭建與配置
三．常用語法
四．與Struts結(jié)合
五．生成Html頁面
一．Freemarker簡(jiǎn)介
什么是Freemarker:.
Freemaker是一個(gè)”模板引擎”,也可以說是一個(gè)基于模板技術(shù)的生成文本輸出的一個(gè)通用工具.它是一個(gè)JAVA的包,一個(gè)JAVA程序員可以使用的
類庫.本身并不是一個(gè)對(duì)最終用戶的應(yīng)用程序.但是,程序員可以把它應(yīng)用到他們的產(chǎn)品中.
FreeMarker是設(shè)計(jì)為可以生成WEB PAGES.它是基于SERVLET遵循MVC模式的.這個(gè)思路是應(yīng)用MVC模式要降低分離,網(wǎng)頁設(shè)計(jì)人員和程序員的耦合.
每個(gè)人都可以做他們擅長的工作.網(wǎng)頁設(shè)計(jì)人員可以改變網(wǎng)頁的面貌,而并不需要程序員的重新編譯.因?yàn)闃I(yè)務(wù)邏輯和頁面的設(shè)計(jì)已經(jīng)被分離開了
.模板是不能由復(fù)雜的程序片斷組成的.即便網(wǎng)頁設(shè)計(jì)人員和程序員是一個(gè)人. 分離是有必要的.它能使程序更加的靈活和清晰.
雖然Freemarker能編程,但是它并不是一個(gè)編程語言.它是為程序顯示數(shù)據(jù)而準(zhǔn)備的.(像數(shù)據(jù)庫SQL語句的查詢.)以及.Freemarker僅僅是利用模
板加上數(shù)據(jù)生成文本頁面.
Freemarker并不是一個(gè)WEB應(yīng)用程序框架.可以說是一個(gè)WEB應(yīng)用框架的一個(gè)組件.但是FREEMARKER引擎本身并不了解HTTP或者SERVLETS.它只不過
生成文本而已.注意,它是MVC框架的一個(gè)組件(如STRUTS),也可以在模板中使用JSP標(biāo)簽.
? Freemarker下載地址為：http://www.freemarker.org/index.html
一般的用途:
l 能用來生成任意格式的文本:HTML,XML,RTF,JAVA源碼,等等.
l可以更好的嵌入到你的產(chǎn)品中,輕量級(jí)的.并不需要servlet環(huán)境.不依賴javax.servlet.classes.
l可插入的模板讀取器:你可以從任意的源碼讀取任意的模板.本地的文件,數(shù)據(jù)庫等等.
l你可以做任意你想生成的文本.存儲(chǔ)為本地文件.可以用來發(fā)送EMAIL或返回到WEB瀏覽器中.
?
強(qiáng)大的模板語言
l完整的指令:include,if/elseif/else,loop.
l 建立和修改模板中的變量.
l 能用復(fù)雜的表達(dá)式在任意地方指定變量.
n字符串操作:concateration,sub-string,uppercase,capitalize,escaping.等等
n十進(jìn)制數(shù)學(xué)計(jì)算.
n BOOL
n讀取數(shù)組和相關(guān)的數(shù)組元素.
n可以自己添加特殊的計(jì)算方法.
l宏指令
l 命名空間用來創(chuàng)建和維護(hù)宏指令庫或者把大的項(xiàng)目分成許多模塊.并不用擔(dān)心命名沖突
----------------------------------------------------------------------------
二．環(huán)境搭建與配置
<!—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.一個(gè)對(duì)象BOOK
? 1.輸出 ${book.name}
空值判斷：${book.name?if_exists },
${book.name?default(‘xxx’)}//默認(rèn)值xxx
${ book.name!"xxx"}//默認(rèn)值xxx
日期格式：${book.date?string('yyyy-MM-dd')}
數(shù)字格式：${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．循環(huán)讀取
<#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
4?宏/模板
宏Macro
宏是在模板中使用macro指令定義
l.1 基本用法
宏是和某個(gè)變量關(guān)聯(lián)的模板片斷，以便在模板中通過用戶定義指令使用該變量，下面是一個(gè)例子：
<#macro greet>
? <font size="+2">Hello Joe!</font>
</#macro>
調(diào)用宏時(shí)，與使用FreeMarker的其他指令類似，
?只是使用@替代FTL標(biāo)記中的#。
<@greet></@greet>
<#--<@greet/>-->
在macro指令中可以在宏變量之后定義參數(shù)，如：
<#macro greet person>
? <font size="+2">Hello ${person}!</font>
</#macro>
?可以這樣使用這個(gè)宏變量：
??<@greet person="Fred"/>
?但是下面的代碼具有不同的意思：
??<@greet person=Fred/>
?這意味著將Fred變量的值傳給person參數(shù)，該值不僅是字符串，還可以是其它類型，甚至是復(fù)雜的表達(dá)式。
宏可以有多參數(shù)，下面是一個(gè)例子：
<#macro greet person color>
? <font size="+2" color="${color}">Hello ${person}!</font>
</#macro>
可以這樣使用該宏變量，其中參數(shù)的次序是無關(guān)的：
<@greet person="Fred" color="black"/>
可以在定義參數(shù)時(shí)指定缺省值，否則，在調(diào)用宏的時(shí)候，必須對(duì)所有參數(shù)賦值：
<#macro greet person color="black">
? <font size="+2" color="${color}">Hello ${person}!</font>
</#macro>
注意：宏的參數(shù)是局部變量，只能在宏定義中有效。
在宏里嵌套內(nèi)容
FreeMarker的宏可以有嵌套內(nèi)容，
<#nested>指令會(huì)執(zhí)行宏調(diào)用指令開始和結(jié)束標(biāo)記之間的模板片斷，舉一個(gè)簡(jiǎn)單的例子：
<#macro border>
? <table border=4 cellspacing=0 cellpadding=4><tr><td>
??? <#nested>
? </tr></td></table>
</#macro>
執(zhí)行宏調(diào)用：
<@border>The bordered text</@border>
輸出結(jié)果：
<table border=4 cellspacing=0 cellpadding=4>
?<tr><td>
??? ??The bordered text
? ?</tr></td>
</table>
<#nested>指令可以被多次調(diào)用，每次都會(huì)執(zhí)行相同的內(nèi)容。
<#macro do_thrice>
? <#nested>
? <#nested>
? <#nested>
</#macro>
<@do_thrice>
? Anything.
</@do_thrice>
FMPP 輸出結(jié)果：
Anything.
Anything.
Anything.
嵌套內(nèi)容可以是有效的FTL，下面是一個(gè)有些復(fù)雜的例子，我們將上面三個(gè)宏組合起來：
<@border>
? <ul>
? <@do_thrice>
??? <li><@greet person="Joe"/>
? </@do_thrice>
? </ul>
</@border>
輸出結(jié)果：
<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>
宏定義中的局部變量對(duì)嵌套內(nèi)容是不可見的，例如：
<#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>
輸出結(jié)果：
test 3/1: ? ? ?
test 3/2: ? ? ?
test 3/3: ? ? ?
在宏定義中使用循環(huán)變量
nestted指令也可以有循環(huán)變量（循環(huán)變量的含義見下節(jié)），調(diào)用宏的時(shí)候在宏指令的參數(shù)后面依次列出循環(huán)變量的名字，格式如下：
<@ 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是宏的參數(shù)，c, halfc,last則為循環(huán)變量，輸出結(jié)果：
? 1. 0.5
? 2. 1
? 3. 1.5
? 4. 2 Last!
循環(huán)變量和宏標(biāo)記指定的不同不會(huì)有問題，如果調(diào)用時(shí)少指定了循環(huán)變量，那么多余的值不可見。調(diào)用時(shí)多指定了循環(huán)變量，多余的循環(huán)變量
不會(huì)被創(chuàng)建：
<@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指令創(chuàng)建和替換。
局部變量：在宏定義體中有效，使用local指令創(chuàng)建和替換。
循環(huán)變量：只能存在于指令的嵌套內(nèi)容，由指令（如list）自動(dòng)創(chuàng)建；宏的參數(shù)是局部變量，而不是循環(huán)變量
局部變量隱藏（而不是覆蓋）同名的plain變量；循環(huán)變量隱藏同名的局部變量和plain變量，下面是一個(gè)例子：
<#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>
輸出結(jié)果：
? 1. plain
? 2. plain
? 3. local
? 4. loop
? 5. local
? 6. plain
? 7. loop
? 8. loop
? 9. plain2
內(nèi)部循環(huán)變量隱藏同名的外部循環(huán)變量，如：
<#list ["loop 1"] as x>
? ${x}
? <#list ["loop 2"] as x>
??? ${x}
??? <#list ["loop 3"] as x>
????? ${x}
??? </#list>
??? ${x}
? </#list>
? ${x}
</#list>
輸出結(jié)果：
loop 1
??? loop 2
????? loop 3
??? loop 2
? loop 1
模板中的變量會(huì)隱藏（而不是覆蓋）數(shù)據(jù)模型中同名變量，如果需要訪問數(shù)據(jù)模型中的同名變量，使用特殊變量global，下面的例子假設(shè)數(shù)據(jù)
模型中的user的值是Big Joe：
<#assign user = "Joe Hider">
${user}????????? <#-- prints: Joe Hider -->
${.globals.user} <#-- prints: Big Joe -->
名字空間
通常情況，只使用一個(gè)名字空間，稱為主名字空間，但為了創(chuàng)建可重用的宏、變換器或其它變量的集合（通常稱庫），必須使用多名字空間，
其目的是防止同名沖突
創(chuàng)建庫
下面是一個(gè)創(chuàng)建庫的例子（假設(shè)保存在lib/my_test.ftl中）：
<#macro copyright date>
? <p>Copyright (C) ${date} Julia Smith. All rights reserved.
? <br>Email: ${mail}</p>
</#macro>
<#assign mail = "jsmith@acme.com">
使用import指令導(dǎo)入庫到模板中，F(xiàn)reemarker會(huì)為導(dǎo)入的庫創(chuàng)建新的名字空間，并可以通過import指令中指定的散列變量訪問庫中的變量：
<#import "/lib/my_test.ftl" as my>
<#assign mail="fred@acme.com">
<@my.copyright date="1999-2002"/>
${my.mail}
${mail}
輸出結(jié)果：
<p>Copyright (C) 1999-2002 Julia Smith. All rights reserved.
? <br>Email: mailto:jsmith@acme.com%3C/p>
jsmith@acme.com
fred@acme.com
可以看到例子中使用的兩個(gè)同名變量并沒有沖突，因?yàn)樗鼈兾挥诓煌拿挚臻g。還可以使用assign指令在導(dǎo)入的名字空間中創(chuàng)建或替代變量
，下面是一個(gè)例子：
<#import "/lib/my_test.ftl" as my>
${my.mail}
<#assign mail="jsmith@other.com" in my>
${my.mail}
輸出結(jié)果：
jsmith@acme.com
jsmith@other.com
數(shù)據(jù)模型中的變量任何地方都可見，也包括不同的名字空間，下面是修改的庫：
<#macro copyright date>
? <p>Copyright (C) ${date} ${user}. All rights reserved.</p>
</#macro>
<#assign mail = "mailto:$%7Buser%7D@acme.com">
假設(shè)數(shù)據(jù)模型中的user變量的值是Fred，則下面的代碼：
<#import "/lib/my_test.ftl" as my>
<@my.copyright date="1999-2002"/>
${my.mail}
輸出結(jié)果：
<p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>Fred@acme.com
----------------------------------------------------------------------------
四．Freemarker與Struts結(jié)合
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等標(biāo)簽
a.導(dǎo)入à<#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 {
??????????? //設(shè)置freemarker的參數(shù)
??????????? cfg.setNumberFormat("0.##########");//生成html文件時(shí)web.xml配制無效
??????????? //cfg.setEncoding();
??????????? cfg.setDirectoryForTemplateLoading(new File(templatePath));
??????????? cfg.setObjectWrapper(new DefaultObjectWrapper());
??????????? Template bookTemplate = cfg.getTemplate(bookFtl.getTemplateName());//模板對(duì)象
??????????? 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;
??? }
}