FreeMarker標(biāo)簽使用
一、FreeMarker模板文件主要有4個(gè)部分組成
1、文本,直接輸出的部分
2、注釋,即<#--...-->格式不會(huì)輸出
3、插值(Interpolation):即${..}或者#{..}格式的部分,將使用數(shù)據(jù)模型中的部分替代輸出
4、FTL指令:FreeMarker指令,和HTML標(biāo)記類似,名字前加#予以區(qū)分,不會(huì)輸出。
FTL指令規(guī)則
FreeMarker有三種FTL標(biāo)簽,這和HTML的標(biāo)簽是完全類似的
開(kāi)始標(biāo)簽:<#directivename parameters>
結(jié)束標(biāo)簽:</#directivename>
空標(biāo)簽: <#directivename parameters />
實(shí)際上,使用標(biāo)簽時(shí)前面的#符號(hào)也可能變成@,如果該指令是一個(gè)用戶指令而不是系統(tǒng)內(nèi)建指令時(shí),應(yīng)將#符號(hào)改為@符號(hào)
插值規(guī)則
FreeMarker的插值有如下兩種類型
1、通用插值:${expr}
2、數(shù)字格式化插值:#{expr}或者#{expr;format}
通用插值,有可以分為四種情況
a、插值結(jié)果為字符串值:直接輸出表達(dá)式結(jié)果
b、插值結(jié)果為數(shù)字值:根據(jù)默認(rèn)格式(#setting 指令設(shè)置)將表達(dá)式結(jié)果轉(zhuǎn)換成文本輸出。可以使用內(nèi)建的字符串函數(shù)格式單個(gè)插值,例如
<#setting number_format = "currency" />
<#assign price = 42 />
${price}
${price?string}
${price?string.number}
${price?string.currency}
${price?string.percent}
c、輸出值為日期值:根據(jù)默認(rèn)格式(由 #setting 指令設(shè)置)將表達(dá)式結(jié)果轉(zhuǎn)換成文本輸出,可以使用內(nèi)建的字符串函數(shù)格式化單個(gè)插值,例如
<#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};
d、插值結(jié)果為布爾值
<#assign foo=true />
${foo?string("是foo","非foo")}
數(shù)字格式化插值
數(shù)字格式化插值可采用#{expr;format}的形式來(lái)格式化數(shù)字,其中format可以是:
mX:小數(shù)部分最小X位
MX:小數(shù)部分最大X位
例如:
<#assign x = 2.582 />
<#assign y =4 />
#{x;M2};
#{y;M2};
#{x;m1};
#{y;m1};
#{x;m1M2};
#{y:m1M2};
二、表達(dá)式
表達(dá)式是FreeMarker的核心功能。表達(dá)式放置在插值語(yǔ)法(${...})之中時(shí),表面需要輸出表達(dá)式的值,表達(dá)式語(yǔ)法也可以與FreeMarker標(biāo)簽結(jié)合,用于控制輸出
1、直接指定值
例如:
a、字符串
${'我的名字是\"yeek\"'};
${"我的文件保存在d:\\盤"};
b、數(shù)值
c、布爾值
d、日期型
FreeMarker支持date、time、datetime三種類型,這三種類型的值無(wú)法直接指定,通常需要借助字符串的date、time、datetime三個(gè)內(nèi)建函數(shù)進(jìn)行轉(zhuǎn)換才可以
<#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、集合
集合以方括號(hào)包括,各集合元素之間以英文逗號(hào)(,)分隔,看如下的示例:
<#list["星期一",,["星期二",["星期三",["星期四",["星期五"] as x>
${s};
</#list>
f、Map集合
Map對(duì)象使用花括號(hào)包括,Map中的key-value對(duì)之間以英文冒號(hào)(:)隔開(kāi),多組key-value對(duì)之間以英文逗號(hào)(,) 隔開(kāi)
例如
<#assign score = {"語(yǔ)文":78,"數(shù)學(xué)":83,"Java":89} >
<#list score?key as x>
${x}--->${score[x]};
</#list>
2、輸出變量值
FreeMarker的表達(dá)式輸出變量時(shí),這些變量可以是頂層變量,也可以是Map對(duì)象中的變量,還可以是集合中的變量,并可以使用點(diǎn)(.)語(yǔ)法來(lái)訪問(wèn)Java對(duì)象的屬性
a、頂層變量
Map root = new HashMap();
root.put("name","wenchao");
對(duì)應(yīng)頂層變量,直接使用${variableName}來(lái)輸出變量值,變量名只能是數(shù)字、字母、下劃線、$、@和#的組合,并不能以數(shù)字開(kāi)頭
b、輸出集合元素
如果需要輸出集合元素,則可以根據(jù)集合元素的索引來(lái)輸出元素。集合元素的索引以方括號(hào)指定。
假設(shè)有集合對(duì)象為:["星期一","星期二","星期三","星期四","星期五","星期六"],該集合對(duì)象名為week, 如果需要輸出星期三,則可以使用如下語(yǔ)法:
${week[2]}
集合里的第一個(gè)元素的索引是0
c、輸出Map元素
這里的Map對(duì)象可以是直接HashMap的實(shí)例,甚至包括 JavaBean實(shí)例,對(duì)應(yīng)JavaBean實(shí)例,我們一樣可以把其當(dāng)成屬性為key,屬性為value的Map實(shí)例
3、字符串操作
a、字符串鏈接
字符串連接有兩種語(yǔ)法
A、使用${..}(或#{..})在字符串常量部分插入表達(dá)式的值,從而完成字符串連接
B、直接使用連接運(yùn)算符(+)來(lái)連接字符串
使用第一種語(yǔ)法來(lái)連接字符串
${"Hello,${user}!"}
第二種使用連接符號(hào)來(lái)連接字符串
${"Hello,"+user+"!"};
值的注意的是,${..}只能用于文本部分,因此,下面的代碼是錯(cuò)誤的:
<#if ${isBig}>Wow!</#if>
<#if "${isBig}">Wow!</#if>
應(yīng)該寫成:
<#if isBig>Wow!</#if>
b、截取字符串
Map root = new HashMap();
root.put("book","瘋狂Ajax講義");
${book[0]}
${book[4]}
${book[1..4]}
4、集合連接運(yùn)算符
這里所說(shuō)的集合連接運(yùn)算時(shí)將兩個(gè)集合連接成一個(gè)新的集合,連接集合的運(yùn)算符是+,例如
<#list ["星期一"," 星期二","星期三"]+["星期四","星期五"] as x>
${x}
</#list>
5、Map連接運(yùn)算符
Map對(duì)象的連接運(yùn)算也是將兩個(gè)Map對(duì)象連接成一個(gè)新的Map對(duì)象,Map對(duì)象的連接運(yùn)算符是+。如果兩個(gè)Map對(duì)象具有相同的 key,則后加入Map里的key所
對(duì)應(yīng)的value替代原來(lái)key所對(duì)應(yīng)的value
6、算術(shù)運(yùn)算符
FreeMarker表達(dá)式中完全支持算術(shù)運(yùn)算,F(xiàn)reeMarker支持的算術(shù)運(yùn)算符包括: +,-,*,/,%
看如下代碼示范
<#assign x = 5 />
${x* -100}
${x/2}
${12%10}
在表達(dá)式中使用算術(shù)運(yùn)算時(shí)要注意以下幾點(diǎn)。
A、運(yùn)算符兩邊的運(yùn)算數(shù)必須是數(shù)字,因此下面的代碼是錯(cuò)誤的:
${3*"5"}
B、使用+(既可以作為加號(hào),也可以作為字符串連接運(yùn)算符)運(yùn)算時(shí),如果一邊是數(shù)字,一邊是字符串,就會(huì)自動(dòng)將數(shù)字轉(zhuǎn)化為字符串。例如
${3+"5"}
輸出結(jié)果:35
C、使用內(nèi)建的int函數(shù)可對(duì)數(shù)值取整。例如
<#assign x = 5>
${(x/2)?int}
${1.1?int}
${1.999?int}
${-1.9999?int}
${-1.1?int}
7、比較運(yùn)算符
表達(dá)式中支持的比較運(yùn)算符有如下幾個(gè)
a、=(或者==):判斷兩個(gè)值是否相等.
b、!=:判斷兩個(gè)值是否不相等
c、 >(或者gt):判斷坐標(biāo)值是否大于右邊值
d、 >=(或者gte):判斷坐標(biāo)值是否大于等于右邊值
e、 <(或者lt):判斷左邊值是否小于右邊值
f、 <=(或者lte):判斷左邊值是否小于等于右邊值
8、邏輯運(yùn)算符
邏輯運(yùn)算符有如下幾個(gè)
a、邏輯與:&&
b、邏輯或:||
c、邏輯非:!
邏輯運(yùn)算符只能作用于布爾值,否則將產(chǎn)生錯(cuò)誤。
9、內(nèi)建函數(shù)
FreeMarker還提供了一些內(nèi)建函數(shù)來(lái)轉(zhuǎn)換輸出,可以在任何變量后緊跟?,?后緊跟內(nèi)建函數(shù),就可通過(guò)內(nèi)建函數(shù)來(lái)轉(zhuǎn)換輸出變量
下面是常用的內(nèi)建的字符串函數(shù)
a、html:對(duì)字符串進(jìn)行HTML編碼
b、cap_first:將字符串第一個(gè)字母成大寫
c、lower_case:將字符串轉(zhuǎn)換成小寫
d、upper_case:將字符串轉(zhuǎn)換成大寫
e、trim: 去掉字符串前后的空白字符
下面是集合的常用的內(nèi)建函數(shù)
a、size: 獲得序列中元素的數(shù)目
下面是數(shù)字值的常用的內(nèi)建函數(shù)
a、int 取得數(shù)字的整數(shù)部分
例如
<#assign test="Tom & Jerry" />
${test?html}
${test?upper_case?html}
10、空值處理運(yùn)算符
FreeMarker對(duì)空值的處理非常嚴(yán)格,F(xiàn)reeMarker的變量必須有值,沒(méi)有被賦值的變量就會(huì)拋出異常。
11、運(yùn)算符優(yōu)先級(jí)
三、FreeMarker 的常用指令
1、if指令
分支控制語(yǔ)句
語(yǔ)法格式如下
<#if condition>
....
<#elseif condition2>
...
<#elseif condition3>
...
<#else>
...
</#if>
2、switch、case、default、break指令
<#switch value>
<#case refValue>
...
<#bread>
<#case refValue>
...
<#bread>
<#default>
...
</#switch>
雖然FreeMarker提供了switch指令,但它并不推薦使用switch指令來(lái)控制也輸出,而是推薦使用FreeMarker的if..elseif..else 指令來(lái)替代它。
3、list、break指令
list指令時(shí)一個(gè)典型的迭代輸出指令,用于迭代輸出數(shù)據(jù)模型中的集合。list指令的語(yǔ)法格式如下:
<#list sequence as item>
...
</#list>
除此之外,迭代集合對(duì)象時(shí),還包括兩個(gè)特殊的循環(huán)變量:
a、item_index:當(dāng)前變量的索引值。
b、item_has_next:是否存在下一個(gè)對(duì)象
也可以使用<#break>指令跳出迭代
<#list ["星期一","星期二","星期三","星期四","星期五"] as x>
${x_index +1}.${x} <#if x_has_next>,</#if>
<#if x = "星期四"><#break></#if>
</#list>
4、include 指令
include指令的作用類似于JSP的包含指令,用于包含指定頁(yè),include指令的語(yǔ)法格式如下
<#include filename [options]
在上面的語(yǔ)法格式中,兩個(gè)參數(shù)的解釋如下
a、filename:該參數(shù)指定被包含的模板文件
b、options:該參數(shù)可以省略,指定包含時(shí)的選項(xiàng),包含encoding和parse兩個(gè)選項(xiàng),encoding指定包含頁(yè)面時(shí)所使用的解碼集,而parse指定被
包含是否作為FTL文件來(lái)解析。如果省略了parse選項(xiàng)值,則該選項(xiàng)值默認(rèn)是true
5、 import指令
該指令用于導(dǎo)入FreeMarker模板中的所有變量,并將該變量放置在指定的Map對(duì)象中,import 指令的語(yǔ)法格式如下
<#import path as mapObject>
在上面的語(yǔ)法格式中,path指定要被導(dǎo)入的模板文件,而mapObject是一個(gè)Map對(duì)象名,通過(guò)這行代碼,將導(dǎo)致path模板中的所有變量都被放置
在mapObject中
<#import "/lib/common.ftl" as com>
6、noparse指令
noparse指令指定FreeMarker不處理該指令里包含的內(nèi)容,該指令的語(yǔ)法格式如下:
<#noparse>
...
</#noparse>
7、escape、noescape指令
8、assign指令
它用于為該模板頁(yè)面創(chuàng)建或替換一個(gè)頂層變量
9、setting指令
該指令用于設(shè)置FreeMarker的運(yùn)行環(huán)境,該指令的語(yǔ)法格式如下:
<#setting name = value>
name 的取值范圍包括如下幾個(gè)
locale :該選項(xiàng)指定該模板所用的國(guó)家/語(yǔ)言選項(xiàng)
number_format:該選項(xiàng)指定格式化輸出數(shù)字的格式
boolean_format:該選項(xiàng)指定兩個(gè)布爾值的語(yǔ)法格式,默認(rèn)值是"true、false"
date_format,time_format,datetime_format:該選項(xiàng)指定格式化輸出日期的格式
time_zone: 設(shè)置格式化輸出日期時(shí)所使用的時(shí)區(qū)
10、macro、nested、return指令
posted on 2011-12-16 11:17
kxbin 閱讀(60067)
評(píng)論(3) 編輯 收藏