FreeMarker標簽使用
模板技術在現代的軟件開發中有着重要的地位，主要用於view層的展示，freemarker是比較流行的一種。
一、FreeMarker模板文件主要有4個部分組成
①文本，直接輸出的部分
②注釋，即<#--...-->格式不會輸出
③插值（Interpolation）：即${..}或者#{..}格式的部分,將使用數據模型中的部分替代輸出
④FTL指令：FreeMarker指令，和HTML標記類似，名字前加#予以區分，不會輸出。
1.FTL指令規則
FreeMarker有三種FTL標簽，這和HTML的標簽是完全類似的
開始標簽：<#directivename parameters>
結束標簽：</#directivename>
空標簽： <#directivename parameters />
實際上，使用標簽時前面的#符號也可能變成@，如果該指令是一個用戶指令而不是系統內建指令時，應將#符號改為@符號
2.插值規則
FreeMarker的插值有如下兩種類型
通用插值：${expr}
數字格式化插值：#{expr}或者#{expr;format}
1）通用插值，有可以分為四種情況
a、插值結果為字符串值：直接輸出表達式結果
b、插值結果為數字值：根據默認格式(#setting 指令設置)將表達式結果轉換成文本輸出。可以使用內建的字符串函數格式單個插值，例如
<#setting number_format = "currency" /> <#assign price = 42 /> ${price} ${price?string} ${price?string.number} ${price?string.currency} ${price?string.percent}
輸出結果是:
$42.00
$42.00
42
$42.00
4,200%
c、輸出值為日期值：根據默認格式(由 #setting 指令設置)將表達式結果轉換成文本輸出，可以使用內建的字符串函數格式化單個插值，例如
<#assign lastUpdated = "2009-01-07 15:05"?datetime("yyyy-MM-dd HH:mm") /> ${lastUpdated?string("yyyy-MM-dd HH:mm:ss zzzz")}; ${lastUpdated?string("EEE,MMM d,yy")}; ${lastUpdated?string("EEEE,MMMM dd,yyyy,hh:mm:ss a '('zzz')'")}; ${lastUpdated?string.short}; ${lastUpdated?string.long}; ${lastUpdated?String.full};
輸出結果是:
2008-04-08 08:08:08 Pacific Daylight Time
Tue, Apr 8, '03
Tuesday, April 08, 2003, 08:08:08 PM (PDT)
d、插值結果為布爾值
<#assign foo=true/> ${foo?string("yes", "no")}
輸出結果是:
yes
2)數字格式化插值
數字格式化插值可采用#{expr;format}形式來格式化數字,其中format可以是:
mX:小數部分最小X位
MX:小數部分最大X位
如下面的例子:
<#assign x=2.582/> <#assign y=4/> #{x; M2} <#-- 輸出2.58 --> #{y; M2} <#-- 輸出4 --> #{x; m2} <#-- 輸出2.6 --> #{y; m2} <#-- 輸出4.0 --> #{x; m1M2} <#-- 輸出2.58 --> #{x; m1M2} <#-- 輸出4.0 -->
二、表達式
表達式是FreeMarker的核心功能。表達式放置在插值語法（${...}）之中時，表面需要輸出表達式的值，表達式語法也可以與FreeMarker標簽結合，用於控制輸出
1、直接指定值
a、字符串
${"我的文件保存在C:\\盤"}
${'我名字是\"annlee\"'}
輸出結果是:
我的文件保存在C:\盤
我名字是"annlee"
FreeMarker支持如下轉義字符:
\";雙引號(u0022) \';單引號(u0027) \\;反斜杠(u005C) \n;換行(u000A) \r;回車(u000D) \t;Tab(u0009) \b;退格鍵(u0008) \f;Form feed(u000C) \l;< \g;> \a;& \{;{ \xCode;直接通過4位的16進制數來指定Unicode碼,輸出該unicode碼對應的字符.
如果某段文本中包含大量的特殊符號,FreeMarker提供了另一種特殊格式:可以在指定字符串內容的引號前增加r標記,在r標記后的文件將會直接輸出.看如下代碼:
${r"${foo}"}
${r"C:\foo\bar"}
輸出結果是:
${foo}
C:\foo\bar
b、數值
表達式中的數值直接輸出,不需要引號.小數點使用"."分隔,不能使用分組","符號.FreeMarker目前還不支持科學計數法,所以"1E3"是錯誤 的.FreeMarker表達式中使用數值需要注意以下幾點:
1,數值不能省略小數點前面的0,所以".5"是錯誤的寫法
2,數值8 , +8 , 8.00都是相同的
c、布爾值
直接使用true和false,不使用引號.
d、日期型
FreeMarker支持date、time、datetime三種類型，這三種類型的值無法直接指定，通常需要借助字符串的date、time、datetime三個內建函數進行轉換才可以
<#assign test1 = "2009-01-22"?date("yyyy-MM-dd") />; <#assign test2 ="16:34:43"?time("HH:mm:ss") /> <#assign test2 = "2009-01-22 17:23:45"?datetime("yyyy-MM-dd HH:mm:ss") /> ${test1?string.full}
e、集合
集合以方括號包括,各集合元素之間以英文逗號","分隔,看如下的例子:
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x> ${x} </#list>
輸出結果是:
星期一
星期二
星期三
星期四
星期五
星期六
星期天
除此之外,集合元素也可以是表達式,例子如下:
[2 + 2, [1, 2, 3, 4], "whatnot"]
還可以使用數字范圍定義數字集合,如2..5等同於[2, 3, 4, 5],但是更有效率.注意,使用數字范圍來定義集合時無需使用方括號,數字范圍也支持反遞增的數字范圍,如5..2
f、Map集合
Map對象使用花括號包括,Map中的key-value對之間以英文冒號":"分隔,多組key-value對之間以英文逗號","分隔.下面是一個例子:
{"語文":78, "數學":80}
Map對象的key和value都是表達式,但是key必須是字符串.
2.輸出變量值
FreeMarker的表達式輸出變量時,這些變量可以是頂層變量,也可以是Map對象中的變量,還可以是集合中的變量,並可以使用點(.)語法來訪問Java對象的屬性.下面分別討論這些情況
a,頂層變量
所謂頂層變量就是直接放在數據模型中的值,例如有如下數據模型:
Map root = new HashMap(); //創建數據模型
root.put("name","annlee"); //name是一個頂層變量
對於頂層變量,直接使用${variableName}來輸出變量值,變量名只能是字母,數字,下划線,$,@和#的組合,且不能以數字開頭號.為了輸出上面的name的值,可以使用如下語法:
${name}
b,輸出集合元素
如果需要輸出集合元素,則可以根據集合元素的索引來輸出集合元素,集合元素的索引以方括號指定.假設有索引:
["星期一","星期二","星期三","星期四","星期五","星期六","星期天"].該索引名為week,如果需要輸出星期三,則可以使用如下語法:
${week[2]} //輸出第三個集合元素
此外,FreeMarker還支持返回集合的子集合,如果需要返回集合的子集合,則可以使用如下語法:
week[3..5] //返回week集合的子集合,子集合中的元素是week集合中的第4-6個元素
c,輸出Map元素
這里的Map對象可以是直接HashMap的實例,甚至包括JavaBean實例,對於JavaBean實例而言,我們一樣可以把其當成屬性為key,屬性值為value的Map實例.為了輸出Map元素的值,可以使用點語法或方括號語法.假如有下面的數據模型:
Map root = new HashMap();
Book book = new Book();
Author author = new Author();
author.setName("annlee");
author.setAddress("gz");
book.setName("struts2");
book.setAuthor(author);
root.put("info","struts");
root.put("book", book);
為了訪問數據模型中名為struts2的書的作者的名字,可以使用如下語法:
book.author.name //全部使用點語法
book["author"].name
book.author["name"] //混合使用點語法和方括號語法
book["author"]["name"] //全部使用方括號語法
使用點語法時,變量名字有頂層變量一樣的限制,但方括號語法沒有該限制,因為名字可以是任意表達式的結果.
3, 字符串操作
FreeMarker的表達式對字符串操作非常靈活,可以將字符串常量和變量連接起來,也可以返回字符串的子串等.
字符串連接有兩種語法:
1,使用${..}或#{..}在字符串常量部分插入表達式的值,從而完成字符串連接.
2,直接使用連接運算符+來連接字符串
例如有如下數據模型:
Map root = new HashMap(); root.put("user","annlee");
下面將user變量和常量連接起來:
${"hello, ${user}!"} //使用第一種語法來連接
${"hello, " + user + "!"} //使用+號來連接
上面的輸出字符串都是hello,annlee!,可以看出這兩種語法的效果完全一樣.
值得注意的是,${..}只能用於文本部分,不能用於表達式,下面的代碼是錯誤的:
<#if ${isBig}>Wow!</#if> <#if "${isBig}">Wow!</#if>
應該寫成:<#if isBig>Wow!</#if>
截取子串可以根據字符串的索引來進行,截取子串時如果只指定了一個索引值,則用於取得字符串中指定索引所對應的字符;如果指定兩個索引值,則返回兩個索引中間的字符串子串.假如有如下數據模型:
Map root = new HashMap(); root.put("book","struts2,freemarker");
可以通過如下語法來截取子串:
${book[0]}${book[4]} //結果是su
${book[1..4]} //結果是tru
4. 集合連接運算符
這里所說的集合運算符是將兩個集合連接成一個新的集合,連接集合的運算符是+,看如下的例子:
<#list ["星期一","星期二","星期三"] + ["星期四","星期五","星期六","星期天"] as x> ${x} </#list>
輸出結果是:
星期一 星期二 星期三 星期四 星期五 星期六 星期天
5. Map連接運算符
Map對象的連接運算符也是將兩個Map對象連接成一個新的Map對象,Map對象的連接運算符是+,如果兩個Map對象具有相同的key,則右邊的值替代左邊的值.看如下的例子:
<#assign scores = {"語文":86,"數學":78} + {"數學":87,"Java":93}> 語文成績是${scores.語文} 數學成績是${scores.數學} Java成績是${scores.Java}
輸出結果是:
語文成績是86
數學成績是87
Java成績是93
6. 算術運算符
FreeMarker表達式中完全支持算術運算,FreeMarker支持的算術運算符包括:+, - , * , / , % 看如下的代碼:
<#assign x=5> ${ x * x - 100 } ${ x /2 } ${ 12 %10 }
輸出結果是:
-75 2.5 2
在表達式中使用算術運算符時要注意以下幾點:
1,運算符兩邊的運算數字必須是數字
2,使用+運算符時,如果一邊是數字,一邊是字符串,就會自動將數字轉換為字符串再連接,如:${3 + "5"},結果是:35
使用內建的int函數可對數值取整,如:
<#assign x=5> ${ (x/2)?int } ${ 1.1?int } ${ 1.999?int } ${ -1.1?int } ${ -1.999?int }
結果是:
2 1 1 -1 -1
7. 比較運算符
表達式中支持的比較運算符有如下幾個:
1,=或者==:判斷兩個值是否相等. 2,!=:判斷兩個值是否不等. 3,>或者gt:判斷左邊值是否大於右邊值 4,>=或者gte:判斷左邊值是否大於等於右邊值 5,<或者lt:判斷左邊值是否小於右邊值 6,<=或者lte:判斷左邊值是否小於等於右邊值
注意:=和!=可以用於字符串,數值和日期來比較是否相等,但=和!=兩邊必須是相同類型的值,否則會產生錯誤,而且FreeMarker是精確比較,"x","x ","X"是不等的.其它的運行符可以作用於數字和日期,但不能作用於字符串,大部分的時候,使用gt等字母運算符代替>會有更好的效果,因為 FreeMarker會把>解釋成FTL標簽的結束字符,當然,也可以使用括號來避免這種情況,如:<#if (x>y)>
8. 邏輯運算符
邏輯運算符有如下幾個:
邏輯與:&&
邏輯或:||
邏輯非:!
邏輯運算符只能作用於布爾值,否則將產生錯誤
3.9 內建函數
FreeMarker還提供了一些內建函數來轉換輸出,可以在任何變量后緊跟?,?后緊跟內建函數,就可以通過內建函數來輪換輸出變量.下面是常用的內建的字符串函數:
html:對字符串進行HTML編碼
cap_first:使字符串第一個字母大寫
lower_case:將字符串轉換成小寫
upper_case:將字符串轉換成大寫
trim:去掉字符串前后的空白字符
下面是集合的常用內建函數
size:獲取序列中元素的個數
下面是數字值的常用內建函數
int:取得數字的整數部分,結果帶符號
例如:
<#assign test="Tom & Jerry"> ${test?html} ${test?upper_case?html}
結果是:
Tom & Jerry TOM & JERRY
3.10 空值處理運算符
FreeMarker對空值的處理非常嚴格,FreeMarker的變量必須有值,沒有被賦值的變量就會拋出異常,因為FreeMarker未賦值的變量強制出錯可以杜絕很多潛在的錯誤,如缺失潛在的變量命名,或者其他變量錯誤.這里所說的空值,實際上也包括那些並不存在的變量,對於一個Java的 null值而言,我們認為這個變量是存在的,只是它的值為null,但對於FreeMarker模板而言,它無法理解null值,null值和不存在的變量完全相同.
為了處理缺失變量,FreeMarker提供了兩個運算符:
!:指定缺失變量的默認值
??:判斷某個變量是否存在
其中,!運算符的用法有如下兩種:
variable!或variable!defaultValue,第一種用法不給缺失的變量指定默認值,表明默認值是空字符串,長度為0的集合,或者長度為0的Map對象.
使用!指定默認值時,並不要求默認值的類型和變量類型相同.使用??運算符非常簡單,它總是返回一個布爾值,用法為:variable??,如果該變量存在,返回true,否則返回false
3.11 運算符的優先級
FreeMarker中的運算符優先級如下(由高到低排列):
1,一元運算符:! 2,內建函數:? 3,乘除法:*, / , % 4,加減法:- , + 5,比較:> , < , >= , <= (lt , lte , gt , gte) 6,相等:== , = , != 7,邏輯與:&& 8,邏輯或:|| 9,數字范圍:..
實際上,我們在開發過程中應該使用括號來嚴格區分,這樣的可讀性好,出錯少
三. FreeMarker的常用指令
FreeMarker的FTL指令也是模板的重要組成部分,這些指令可實現對數據模型所包含數據的撫今迭代,分支控制.除此之外,還有一些重要的功能,也是通過FTL指令來實現的.
1.if指令
這是一個典型的分支控制指令,該指令的作用完全類似於Java語言中的if,if指令的語法格式如下:
<#if condition>... <#elseif condition>... <#elseif condition>... <#else> ... </#if>
例子如下:
<#assign age=23> <#if (age>60)>老年人 <#elseif (age>40)>中年人 <#elseif (age>20)>青年人 <#else> 少年人 </#if>
輸出結果是:青年人
上面的代碼中的邏輯表達式用括號括起來主要是因為里面有>符號,由於FreeMarker會將>符號當成標簽的結束字符,可能導致程序出錯,為了避免這種情況,我們應該在凡是出現這些符號的地方都使用括號.
2. switch , case , default , break指令
這些指令顯然是分支指令,作用類似於Java的switch語句,switch指令的語法結構如下:
<#switch value> <#case refValue>...<#break> <#case refValue>...<#break> <#default>... </#switch>
3. list, break指令
list指令是一個迭代輸出指令,用於迭代輸出數據模型中的集合,list指令的語法格式如下:
<#list sequence as item> ... </#list>
上面的語法格式中,sequence就是一個集合對象,也可以是一個表達式,但該表達式將返回一個集合對象,而item是一個任意的名字,就是被迭代輸出的集合元素.此外,迭代集合對象時,還包含兩個特殊的循環變量:
item_index:當前變量的索引值
item_has_next:是否存在下一個對象
也可以使用<#break>指令跳出迭代
例子如下:
<#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x> ${x_index + 1}.${x}<#if x_has_next>,</if> <#if x="星期四"><#break></#if> </#list>
4. include
語法
<#include filename> or <#include filename options>
options包含兩個屬性
encoding=”GBK” 編碼格式
parse=true 是否作為ftl語法解析,默認是true，false就是以文本方式引入.注意在ftl文件里布爾值都是直接賦值的如parse=true,而不是parse=”true”
用例
/common/copyright.ftl包含內容
Copyright 2001-2002 ${me}<br>
All rights reserved.
模板文件
<#assign me = "Juila Smith"> <h1>Some test</h1> <p>Yeah. <hr> <#include "/common/copyright.ftl" encoding=”GBK”>
輸出結果
<h1>Some test</h1> <p>Yeah. <hr> Copyright 2001-2002 Juila Smith All rights reserved.
5. import指令
語法
<#import path as hash>
類似於java里的import,它導入文件，然后就可以在當前文件里使用被導入文件里的宏組件
用例 ,假設mylib.ftl里定義了宏copyright那么我們在其他模板頁面里可以這樣使用
<#import "/libs/mylib.ftl" as my> <@my.copyright date="1999-2002"/>
"my"在freemarker里被稱作namespace
6. noparse指令
noparse指令指定FreeMarker不處理該指定里包含的內容,該指令的語法格式如下:
<#noparse>...</#noparse>
看如下的例子:
<#noparse> <#list books as book> <tr><td>${book.name}<td>作者:${book.author} </#list> </#noparse>
輸出如下:
<#list books as book> <tr><td>${book.name}<td>作者:${book.author} </#list>
7. escape , noescape指令
escape指令導致body區的插值都會被自動加上escape表達式,但不會影響字符串內的插值,只會影響到body內出現的插值,使用escape指令的語法格式如下:
<#escape identifier as expression>... <#noescape>...</#noescape> </#escape>
看如下的代碼:
<#escape x as x?html> First name:${firstName} Last name:${lastName} Maiden name:${maidenName} </#escape>
上面的代碼等同於:
First name:${firstName?html}
Last name:${lastName?html}
Maiden name:${maidenName?html}
escape指令在解析模板時起作用而不是在運行時起作用,除此之外,escape指令也嵌套使用,子escape繼承父escape的規則,如下例子:
<#escape x as x?html> Customer Name:${customerName} Items to ship; <#escape x as itemCodeToNameMap[x]> ${itemCode1} ${itemCode2} ${itemCode3} ${itemCode4} </#escape> </#escape>
上面的代碼類似於:
Customer Name:${customerName?html}
Items to ship;
${itemCodeToNameMap[itemCode1]?html}
${itemCodeToNameMap[itemCode2]?html}
${itemCodeToNameMap[itemCode3]?html}
${itemCodeToNameMap[itemCode4]?html}
對於放在escape指令中所有的插值而言,這此插值將被自動加上escape表達式,如果需要指定escape指令中某些插值無需添加escape表達式,則應該使用noescape指令,放在noescape指令中的插值將不會添加escape表達式.
8. assign指令
assign指令在前面已經使用了多次,它用於為該模板頁面創建或替換一個頂層變量,assign指令的用法有多種,包含創建或替換一個頂層變量, 或者創建或替換多個變量等,它的最簡單的語法如下:
<#assign name=value> or <#assign name1=value1 name2=value2 ... nameN=valueN> or <#assign same as above... in namespacehash> or <#assign name> capture this </#assign> or <#assign name in namespacehash> capture this </#assign>
用例 ，生成變量,並且給變量賦值
給seasons賦予序列值
<#assign seasons = ["winter", "spring", "summer", "autumn"]>
給變量test加1
<#assign test = test + 1>
給my namespage 賦予一個變量bgColor,下面可以通過my.bgColor來訪問這個變量
<#import "/mylib.ftl" as my> <#assign bgColor="red" in my>
將一段輸出的文本作為變量保存在x里 ,下面的陰影部分輸出的文本將被賦值給x
<#assign x> <#list 1..3 as n> ${n} <@myMacro /> </#list> </#assign> Number of words: ${x?word_list?size} ${x}
<#assign x>Hello ${user}!</#assign> error <#assign x=” Hello ${user}!”> true
同時也支持中文賦值，如：
<#assign 語法> java </#assign> ${語法}
打印輸出: java
9. setting指令
該指令用於設置FreeMarker的運行環境,該指令的語法格式如下:<#setting name=value>,在這個格式中,name的取值范圍包含如下幾個:
locale:該選項指定該模板所用的國家/語言選項
number_format:指定格式化輸出數字的格式
boolean_format:指定兩個布爾值的語法格式,默認值是true,false
date_format,time_format,datetime_format:指定格式化輸出日期的格式
time_zone:設置格式化輸出日期時所使用的時區
10.global
語法
<#global name=value> or <#global name1=value1 name2=value2 ... nameN=valueN> or <#global name> capture this </#global>
全局賦值語法，利用這個語法給變量賦值，那么這個變量在所有的namespace中是可見的,如果這個變量被當前的assign語法覆蓋如<#global x=2> <#assign x=1> 在當前頁面里x=2將被隱藏，或者通過${.global.x}來訪問
11. macro , nested , return指令
macro可以用於實現自定義指令,通過使用自定義指令,可以將一段模板片段定義成一個用戶指令,使用macro指令的語法格式如下:
<#macro name param1 param2 ... paramN> ... <#nested loopvar1, loopvar2, ..., loopvarN> ... <#return> ... </#macro>
在上面的格式片段中,包含了如下幾個部分:
name:name屬性指定的是該自定義指令的名字,使用自定義指令時可以傳入多個參數
paramX:該屬性就是指定使用自定義指令時報參數,使用該自定義指令時,必須為這些參數傳入值
nested指令:nested標簽輸出使用自定義指令時的中間部分
nested指令中的循環變量:這此循環變量將由macro定義部分指定,傳給使用標簽的模板
return指令:該指令可用於隨時結束該自定義指令.
看如下的例子:
<#macro book> //定義一個自定義指令 j2ee </#macro> <@book /> //使用剛才定義的指令
上面的代碼輸出結果為:j2ee
在上面的代碼中,可能很難看出自定義標簽的用處,因為我們定義的book指令所包含的內容非常簡單,實際上,自定義標簽可包含非常多的內容,從而可以實現更好的代碼復用.此外,還可以在定義自定義指令時,為自定義指令指定參數,看如下代碼:
<#macro book booklist> //定義一個自定義指令booklist是參數 <#list booklist as book> ${book} </#list> </#macro> <@book booklist=["spring","j2ee"] /> //使用剛剛定義的指令
上面的代碼為book指令傳入了一個參數值,上面的代碼的輸出結果為:spring j2ee
不僅如此,還可以在自定義指令時使用nested指令來輸出自定義指令的中間部分,看如下例子:
<#macro page title> <html> <head> <title>FreeMarker示例頁面 - ${title?html}</title> </head> <body> <h1>${title?html}</h1> <#nested> //用於引入用戶自定義指令的標簽體 </body> </html> </#macro>
上面的代碼將一個HTML頁面模板定義成一個page指令,則可以在其他頁面中如此page指令:
<#import "/common.ftl" as com> //假設上面的模板頁面名為common.ftl,導入頁面 <@com.page title="book list"> <u1> <li>spring</li> <li>j2ee</li> </ul> </@com.page>
從上面的例子可以看出,使用macro和nested指令可以非常容易地實現頁面裝飾效果,此外,還可以在使用nested指令時,指定一個或多個循環變量,看如下代碼:
<#macro book> <#nested 1> //使用book指令時指定了一個循環變量值 <#nested 2> </#macro> <@book ;x> ${x} .圖書</@book>
當使用nested指令傳入變量值時,在使用該自定義指令時,就需要使用一個占位符(如book指令后的;x).上面的代碼輸出文本如下:
1 .圖書 2 .圖書
在nested指令中使用循環變量時,可以使用多個循環變量,看如下代碼:
<#macro repeat count> <#list 1..count as x> //使用nested指令時指定了三個循環變量 <#nested x, x/2, x==count> </#list> </#macro> <@repeat count=4 ; c halfc last> ${c}. ${halfc}<#if last> Last! </#if> </@repeat>
上面的輸出結果為:
1. 0.5 2. 1 3. 1.5 4. 2 Last;
return指令用於結束macro指令,一旦在macro指令中執行了return指令,則FreeMarker不會繼續處理macro指令里的內容,看如下代碼:
<#macro book> spring <#return> j2ee </#macro> <@book />
上面的代碼輸出:spring,而j2ee位於return指令之后,不會輸出.
-------------------------------------------------------------------------------------------------------------------------------------
完
轉載需注明轉載字樣，標注原作者和原博文地址。
更多閱讀：