FreeMarker標簽介紹

轉自：http://www.blogjava.net/kxbin/articles/366505.html

?

FreeMarker標簽使用?
一、FreeMarker模板文件主要有4個部分組成
? 1、文本，直接輸出的部分
? 2、注釋，即<#--...-->格式不會輸出
? 3、插值（Interpolation）：即${..}或者#{..}格式的部分,將使用數據模型中的部分替代輸出
? 4、FTL指令：FreeMarker指令，和HTML標記類似，名字前加#予以區分，不會輸出。
??
? FTL指令規則
??? FreeMarker有三種FTL標簽，這和HTML的標簽是完全類似的
???? 開始標簽：<#directivename parameters>
???? 結束標簽：</#directivename>
???? 空標簽： <#directivename parameters />
???? 實際上，使用標簽時前面的#符號也可能變成@，如果該指令是一個用戶指令而不是系統內建指令時，應將#符號改為@符號
??
?? 插值規則
???? FreeMarker的插值有如下兩種類型
???? 1、通用插值：${expr}
???? 2、數字格式化插值：#{expr}或者#{expr;format}
????
??? 通用插值，有可以分為四種情況
??? a、插值結果為字符串值：直接輸出表達式結果
??? b、插值結果為數字值：根據默認格式(#setting 指令設置)將表達式結果轉換成文本輸出。可以使用內建的字符串函數格式單個插值，例如
?????? <#setting number_format = "currency" />
?????? <#assign price = 42 />
?????? ${price}
?????? ${price?string}
?????? ${price?string.number}
?????? ${price?string.currency}
?????? ${price?string.percent}
????
?? 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};
?? d、插值結果為布爾值
????? <#assign foo=true />
????? ${foo?string("是foo","非foo")}
??????
?? 數字格式化插值
???? 數字格式化插值可采用#{expr;format}的形式來格式化數字，其中format可以是：
???? mX:小數部分最小X位
???? MX:小數部分最大X位
???? 例如：
??????? <#assign x = 2.582 />
??????? <#assign y =4 />
??????? #{x;M2};
??????? #{y;M2};
??????? #{x;m1};
??????? #{y;m1};
??????? #{x;m1M2};
??????? #{y:m1M2};
???????

二、表達式
??? 表達式是FreeMarker的核心功能。表達式放置在插值語法（${...}）之中時，表面需要輸出表達式的值，表達式語法也可以與FreeMarker標簽結合，用于控制輸出
????
??? 1、直接指定值
????? 例如：
????? a、字符串
???????? ${'我的名字是\"yeek\"'};
???????? ${"我的文件保存在d：\\盤"};
????? b、數值
????? c、布爾值
????? 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>
???????? ${s};
??????? </#list>
????? f、Map集合
???????? Map對象使用花括號包括，Map中的key-value對之間以英文冒號(:)隔開，多組key-value對之間以英文逗號(,) 隔開
?????????? 例如
?????????? <#assign score = {"語文":78,"數學":83,"Java":89} >
???????????? <#list score?key as x>
????????????? ${x}--->${score[x]};
???????????? </#list>
?????????????
?????????????
????? 2、輸出變量值
????????? FreeMarker的表達式輸出變量時，這些變量可以是頂層變量，也可以是Map對象中的變量，還可以是集合中的變量，并可以使用點(.)語法來訪問Java對象的屬性
????????? a、頂層變量
???????????? Map root = new HashMap();
???????????? root.put("name","wenchao");
???????????? 對應頂層變量，直接使用${variableName}來輸出變量值，變量名只能是數字、字母、下劃線、$、@和#的組合，并不能以數字開頭
????????? b、輸出集合元素
???????????? 如果需要輸出集合元素，則可以根據集合元素的索引來輸出元素。集合元素的索引以方括號指定。
???????????? 假設有集合對象為：["星期一","星期二","星期三","星期四","星期五","星期六"],該集合對象名為week, 如果需要輸出星期三，則可以使用如下語法：
??????????????? ${week[2]}
???????????? 集合里的第一個元素的索引是0
????????? c、輸出Map元素
????????????? 這里的Map對象可以是直接HashMap的實例，甚至包括 JavaBean實例，對應JavaBean實例，我們一樣可以把其當成屬性為key，屬性為value的Map實例
??????????????
??????????????
????? 3、字符串操作
???????? a、字符串鏈接
?????????? 字符串連接有兩種語法
?????????? A、使用${..}(或#{..})在字符串常量部分插入表達式的值，從而完成字符串連接
?????????? B、直接使用連接運算符（+）來連接字符串
???????????? 使用第一種語法來連接字符串
???????????? ${"Hello,${user}!"}
????????????? 第二種使用連接符號來連接字符串
???????????? ${"Hello,"+user+"!"};
?????????????? 值的注意的是，${..}只能用于文本部分，因此，下面的代碼是錯誤的：
???????????????? <#if ${isBig}>Wow!</#if>
???????????????? <#if "${isBig}">Wow!</#if>
???????????????? 應該寫成：
???????????????? <#if isBig>Wow!</#if>
?????????
???????? b、截取字符串
??????????? Map root = new HashMap();
??????????? root.put("book","瘋狂Ajax講義")；
????????????
??????????? ${book[0]}
??????????? ${book[4]}
??????????? ${book[1..4]}
????????????
????? 4、集合連接運算符
??????? 這里所說的集合連接運算時將兩個集合連接成一個新的集合，連接集合的運算符是+，例如
??????? <#list ["星期一"," 星期二","星期三"]+["星期四","星期五"] as x>
?????????? ${x}
??????? </#list>
????????
????? 5、Map連接運算符
???????????? Map對象的連接運算也是將兩個Map對象連接成一個新的Map對象，Map對象的連接運算符是+。如果兩個Map對象具有相同的 key，則后加入Map里的key所
???????? 對應的value替代原來key所對應的value
?????????
????? 6、算術運算符
???????? FreeMarker表達式中完全支持算術運算，FreeMarker支持的算術運算符包括： +，-，*，/，%
???????? 看如下代碼示范
?????????? <#assign x = 5 />
?????????? ${x* -100}
?????????? ${x/2}
?????????? ${12%10}
???????? 在表達式中使用算術運算時要注意以下幾點。
???????? A、運算符兩邊的運算數必須是數字，因此下面的代碼是錯誤的：
?????????? ${3*"5"}
???????? B、使用+（既可以作為加號，也可以作為字符串連接運算符）運算時，如果一邊是數字，一邊是字符串，就會自動將數字轉化為字符串。例如
??????????? ${3+"5"}
??????????? 輸出結果：35
???????? C、使用內建的int函數可對數值取整。例如
??????????? <#assign x = 5>
??????????? ${(x/2)?int}
??????????? ${1.1?int}
??????????? ${1.999?int}
??????????? ${-1.9999?int}
??????????? ${-1.1?int}
???????
?????? 7、比較運算符
?????????? 表達式中支持的比較運算符有如下幾個
?????????? a、=（或者==）:判斷兩個值是否相等.
?????????? b、!=:判斷兩個值是否不相等
?????????? c、 >(或者gt):判斷坐標值是否大于右邊值
?????????? d、 >=(或者gte):判斷坐標值是否大于等于右邊值
?????????? e、 <(或者lt):判斷左邊值是否小于右邊值
?????????? f、 <=(或者lte):判斷左邊值是否小于等于右邊值??????????
????????????????
????????????
?????? 8、邏輯運算符
????????? 邏輯運算符有如下幾個
????????? a、邏輯與：&&
????????? b、邏輯或：||
????????? c、邏輯非：!
????????? 邏輯運算符只能作用于布爾值，否則將產生錯誤。
??????????
?????? 9、內建函數
????????? FreeMarker還提供了一些內建函數來轉換輸出，可以在任何變量后緊跟?,?后緊跟內建函數，就可通過內建函數來轉換輸出變量
????????? 下面是常用的內建的字符串函數
????????? a、html：對字符串進行HTML編碼
????????? b、cap_first:將字符串第一個字母成大寫
????????? c、lower_case:將字符串轉換成小寫
????????? d、upper_case:將字符串轉換成大寫
????????? e、trim: 去掉字符串前后的空白字符
????????? 下面是集合的常用的內建函數
????????? a、size： 獲得序列中元素的數目
??????????
????????? 下面是數字值的常用的內建函數
????????? a、int 取得數字的整數部分
????????? 例如
????????? <#assign test="Tom & Jerry" />
????????? ${test?html}
????????? ${test?upper_case?html}
??????????
?????? 10、空值處理運算符
????????? FreeMarker對空值的處理非常嚴格，FreeMarker的變量必須有值，沒有被賦值的變量就會拋出異常。
??????????
??????????
?????? 11、運算符優先級
??????????
? 三、FreeMarker 的常用指令
???? 1、if指令
??????? 分支控制語句
??????? 語法格式如下
?????? <#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指令來控制也輸出，而是推薦使用FreeMarker的if..elseif..else 指令來替代它。
????????
??? 3、list、break指令
??? list指令時一個典型的迭代輸出指令，用于迭代輸出數據模型中的集合。list指令的語法格式如下：
???? <#list sequence as item>
?????? ...
???? </#list>
????? 除此之外，迭代集合對象時，還包括兩個特殊的循環變量：
????? a、item_index：當前變量的索引值。
????? b、item_has_next:是否存在下一個對象
????? 也可以使用<#break>指令跳出迭代
????? <#list ["星期一","星期二","星期三","星期四","星期五"] as x>
????????? ${x_index +1}.${x} <#if x_has_next>,</#if>
????????? <#if x = "星期四"><#break></#if>
????? </#list>
??????
????? 4、include 指令
??????? include指令的作用類似于JSP的包含指令，用于包含指定頁，include指令的語法格式如下
???????? <#include filename [options]
????????? 在上面的語法格式中，兩個參數的解釋如下
????????? a、filename：該參數指定被包含的模板文件
????????? b、options：該參數可以省略，指定包含時的選項，包含encoding和parse兩個選項，encoding指定包含頁面時所使用的解碼集，而parse指定被
???????????? 包含是否作為FTL文件來解析。如果省略了parse選項值，則該選項值默認是true
???? 5、 import指令
??????? 該指令用于導入FreeMarker模板中的所有變量，并將該變量放置在指定的Map對象中，import 指令的語法格式如下
??????? <#import path as mapObject>
??????? 在上面的語法格式中，path指定要被導入的模板文件，而mapObject是一個Map對象名，通過這行代碼，將導致path模板中的所有變量都被放置
??????? 在mapObject中
??????? <#import "/lib/common.ftl" as com>
?????
???? 6、noparse指令
???????? noparse指令指定FreeMarker不處理該指令里包含的內容，該指令的語法格式如下：
???????? <#noparse>
??????????? ...
???????? </#noparse>
?????????
???? 7、escape、noescape指令
???????
???????
???? 8、assign指令
??????? 它用于為該模板頁面創建或替換一個頂層變量
????????
???? 9、setting指令
??????? 該指令用于設置FreeMarker的運行環境，該指令的語法格式如下：
??????? <#setting name = value>
??????? name 的取值范圍包括如下幾個
???????? locale ：該選項指定該模板所用的國家/語言選項
???????? number_format:該選項指定格式化輸出數字的格式
???????? boolean_format:該選項指定兩個布爾值的語法格式，默認值是"true、false"
???????? date_format,time_format,datetime_format：該選項指定格式化輸出日期的格式
???????? time_zone:? 設置格式化輸出日期時所使用的時區