Freemaker FTL指令常用標籤及語法
阿新 • • 發佈：2019-01-24
freemaker註釋:<#-- 註釋內容 -->格式部分,不會輸出
---------------------------------- 基礎語法 ----------------------------------
1、字元輸出
${emp.name?if_exists} // 變數存在，輸出該變數，否則不輸出
${emp.name!} // 變數存在，輸出該變數，否則不輸出
${emp.name?default("xxx")} // 變數不存在，取預設值xxx
${emp.name!"xxx"} // 變數不存在，取預設值xxx常用內部函式：
${"123<br>456"?html} // 對字串進行HTML編碼，對html中特殊字元進行轉義
${"str"?cap_first} // 使字串第一個字母大寫
${"Str"?lower_case} // 將字串轉換成小寫
${"Str"?upper_case} // 將字串轉換成大寫
${"str"?trim} // 去掉字串前後的空白字元字串的兩種拼接方式拼接：
${"hello${emp.name!}"} // 輸出hello+變數名
${"hello"+emp.name!} // 使用+號來連線，輸出hello+變數名 可以通過如下語法來擷取子串:
<#assign str = "abcdefghijklmn"/> // 方法1 ${str?substring(0,4)} // 輸出abcd // 方法2 ${str[0]}${str[4]} // 結果是ae ${str[1..4]} // 結果是bcde // 返回指定字元的索引 ${str?index_of("n")}
2、日期輸出
${emp.date?string('yyyy-MM-dd')} //日期格式3、數字輸出(以數字20為例)
${emp.name?string.number} // 輸出20
${emp.name?string.currency} // 數字格式化插值可採用#{expr;format}形式來格式化數字,其中format可以是:
mX:小數部分最小X位
MX:小數部分最大X位如下面的例子: <#assign x=2.582/> <#assign y=4/> #{x; M2} // 輸出2.58 #{y; M2} // 輸出4 #{x; m2} // 輸出2.58 #{y; m2} // 輸出4.0 #{x; m1M2} // 輸出2.58 #{x; m1M2} // 輸出4.0
4、申明變數
<#assign foo=false/> // 宣告變數,插入布林值進行顯示,注意不要用引號 ${foo?string("yes","no")} // 當為true時輸出"yes",否則輸出"no"
申明變數的幾種方式
<#assign name=value> <#assign name1=value1 name2=value2 ... nameN=valueN> <#assign same as above... in namespacehash> <#assign name> capture this </#assign> <#assign name in namespacehash> capture this </#assign>
5、比較運算子
表示式中支援的比較運算子有如下幾個:
= 或 == ：判斷兩個值是否相等.
!= ：判斷兩個值是否不等.
> 或 gt ：判斷左邊值是否大於右邊值
>= 或 gte ：判斷左邊值是否大於等於右邊值
< 或 lt ：判斷左邊值是否小於右邊值
<= 或 lte ：判斷左邊值是否小於等於右邊值
6、算術運算子
FreeMarker表示式中完全支援算術運算,
FreeMarker支援的算術運算子包括:+, - , * , / , %
注意：
（1）、運算子兩邊必須是數字
（2）、使用+運算子時,如果一邊是數字,一邊是字串,就會自動將數字轉換為字串再連線,如:${3 + "5"},結果是:35
7、邏輯運算子
邏輯運算子有如下幾個:
邏輯與:&&
邏輯或:||
邏輯非:!
邏輯運算子只能作用於布林值,否則將產生錯誤
8、FreeMarker中的運算子優先順序如下(由高到低排列):
①、一元運算子:!
②、內建函式:?
③、乘除法:*, / , %
④、加減法:- , +
⑤、比較:> , < , >= , <= (lt , lte , gt , gte)
⑥、相等:== , = , !=
⑦、邏輯與:&&
⑧、邏輯或:||
⑨、數字範圍:..
實際上,我們在開發過程中應該使用括號來嚴格區分,這樣的可讀性好,出錯少
9、if 邏輯判斷（注意：elseif 不加空格）
<#if condition> ... <#elseif condition2> ... <#elseif condition3> ... <#else> ... </#if>
if 空值判斷
// 當 photoList 不為空時 <#if photoList??>...</#if> 值得注意的是,${..}只能用於文字部分,不能用於表示式,下面的程式碼是錯誤的: <#if ${isBig}>Wow!</#if> <#if "${isBig}">Wow!</#if> // 正確寫法 <#if isBig>Wow!</#if>
10、switch (條件可為數字，可為字串)
<#switch value> <#case refValue1> .... <#break> <#case refValue2> .... <#break> <#case refValueN> .... <#break> <#default> .... </#switch>
11、集合 & 迴圈
// 遍歷集合: <#list empList! as emp> ${emp.name!} </#list> // 可以這樣遍歷集合: <#list 0..(empList!?size-1) as i> ${empList[i].name!} </#list> // 與jstl迴圈類似,也可以訪問迴圈的狀態。 empList?size // 取集合的長度 emp_index: // int型別，當前物件的索引值 emp_has_next: // boolean型別，是否存在下一個物件 // 使用<#break>跳出迴圈 <#if emp_index = 0><#break></#if> // 集合長度判斷 <#if empList?size != 0></#if> // 判斷=的時候,注意只要一個=符號,而不是== <#assign l=0..100/> // 定義一個int區間的0~100的集合，數字範圍也支援反遞增,如100..2 <#list 0..100 as i> // 等效於java for(int i=0; i <= 100; i++) ${i} </#list> // 擷取子集合： empList[3..5] //返回empList集合的子集合,子集合中的元素是empList集合中的第4-6個元素 // 建立集合： <#list ["星期一", "星期二", "星期三", "星期四", "星期五", "星期六", "星期天"] as x> // 集合連線運算,將兩個集合連線成一個新的集合 <#list ["星期一","星期二","星期三"] + ["星期四","星期五","星期六","星期天"] as x> // 除此之外,集合元素也可以是表示式,例子如下: [2 + 2, [1, 2, 3, 4], "whatnot"] // seq_contains：判斷序列中的元素是否存在 <#assign x = ["red", 16, "blue", "cyan"]> ${x?seq_contains("blue")?string("yes", "no")} // yes ${x?seq_contains("yellow")?string("yes", "no")} // no ${x?seq_contains(16)?string("yes", "no")} // yes ${x?seq_contains("16")?string("yes", "no")} // no // seq_index_of：第一次出現的索引 <#assign x = ["red", 16, "blue", "cyan", "blue"]> ${x?seq_index_of("blue")} // 2 // sort_by：排序（升序） <#list movies?sort_by("showtime") as movie></#list> // sort_by：排序（降序） <#list movies?sort_by("showtime")?reverse as movie></#list> // 具體介紹： // 不排序的情況： <#list movies as moive> <a href="${moive.url}">${moive.name}</a> </#list> //要是排序，則用 <#list movies?sort as movie> <a href="${movie.url}">${movie.name}</a> </#list> // 這是按元素的首字母排序。若要按list中物件元素的某一屬性排序的話，則用 <#list moives?sort_by(["name"]) as movie> <a href="${movie.url}">${movie.name}</a> </#list> //這個是按list中物件元素的[name]屬性排序的，是升序，如果需要降序的話，如下所示： <#list movies?sort_by(["name"])?reverse as movie> <a href="${movie.url}">${movie.name}</a> </#list>
12、Map物件
// 建立map <#assign scores = {"語文":86,"數學":78}> // Map連線運算子 <#assign scores = {"語文":86,"數學":78} + {"數學":87,"Java":93}> // Map元素輸出 emp.name // 全部使用點語法 emp["name"] // 使用方括號
13、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}"} // 輸出 ${foo}
${r"C:/foo/bar"} // 輸出 C:/foo/bar
14、include指令
// include指令的作用類似於JSP的包含指令: <#include "/test.ftl" encoding="UTF-8" parse=true> // 在上面的語法格式中,兩個引數的解釋如下: encoding="GBK" // 編碼格式 parse=true // 是否作為ftl語法解析,預設是true，false就是以文字方式引入,注意:在ftl檔案里布爾值都是直接賦值的如parse=true,而不是parse="true"
15、import指令
// 類似於jsp裡的import,它匯入檔案，然後就可以在當前檔案裡使用被匯入檔案裡的巨集元件 <#import "/libs/mylib.ftl" as my> // 上面的程式碼將匯入/lib/common.ftl模板檔案中的所有變數,交將這些變數放置在一個名為com的Map物件中，"my"在freemarker裡被稱作namespace
17、compress 壓縮
// 用來壓縮空白空間和空白的行 <#compress> ... </#compress>
<#t> // 去掉左右空白和回車換行 <#lt>// 去掉左邊空白和回車換行 <#rt>// 去掉右邊空白和回車換行 <#nt>// 取消上面的效果
18、escape,noescape 對字串進行HTML編碼
// escape指令導致body區的插值都會被自動加上escape表示式,但不會影響字串內的插值,只會影響到body內出現的插值,使用escape指令的語法格式如下: <#escape x as x?html> First name: ${firstName} <#noescape>Last name: ${lastName}</#noescape> Maiden name: ${maidenName} </#escape> // 相同表示式 First name: ${firstName?html} Last name: ${lastName} Maiden name: ${maidenName?html}
---------------------------------- 高階語法 ----------------------------------
1、global全域性賦值語法
<#global name=value> <#global name1=value1 name2=value2 ... nameN=valueN> <#global name> capture this </#global> // 利用這個語法給變數賦值，那麼這個變數在所有的namespace中是可見的，如果這個變數被當前的assign語法覆蓋如<#global x=2><#assign x=1>在當前頁面裡x=2將被隱藏，或者通過${.globals.x} 來訪問
2、setting 語法
// 用來設定整個系統的一個環境 locale // zh_CN 中文環境 number_format boolean_format date_format , time_format , datetime_format time_zone classic_compatible // 例1： <#setting number_format="percent"/> // 設定數字預設輸出方式('percent',百分比) // 例2： // 假如當前是匈牙利的設定，然後修改成美國 ${1.2} // 輸出1,2 <#setting locale="en_US"> ${1.2} // 輸出1.2,因為匈牙利是採用", "作為十進位制的分隔符，美國是用". "
3、macro巨集指令
例子1：
<#-- 定義巨集 --> <#macro test foo bar="Bar" baaz=-1> Text: ${foo}, ${bar}, ${baaz} </#macro> <#-- 使用巨集 --> <@test foo="a" bar="b" baaz=5*5/> // 輸出：Text: a, b, 25 <@test foo="a" bar="b"/> // 輸出：Text: a, b, -1 <@test foo="a" baaz=5*5-2/> // 輸出：Text: a, Bar, 23 <@test foo="a"/> // 輸出：Text: a, Bar, -1
例子2：
<#-- 定義一個迴圈輸出的巨集 --> <#macro list title items> ${title} <#list items as x> *${x} </#list> </#macro> <#-- 使用巨集 --> <@list items=["mouse", "elephant", "python"] title="Animals"/> // 輸出Animals *mouse *elephant *python
例子3：
<#-- 巢狀巨集 -->
<#macro border>
<table>
<#nested>
</table>
</#macro>
<#-- 巢狀巨集使用 -->
<@border>
<tr><td>hahaha</td></tr>
</@border>
輸出結果：
<table>
<tr><td>hahaha</td></tr>
</table>例子4：在nested指令中使用迴圈變數時,可以使用多個迴圈變數,看如下程式碼:
<#-- 迴圈巢狀巨集 --> <#macro repeat count> <#list 1..count as x> <#nested x, x/2, x==count> // 使用nested指令時指定了三個迴圈變數 </#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!
4、結束macro指令
// return指令用於結束macro指令 <#-- 建立巨集 --> <#macro book> spring <#return> j2ee </#macro> <#-- 使用巨集 --> <@book /> // 上面的程式碼輸出:spring,而j2ee位於return指令之後,不會輸出.
FreeMarker 工具類：
THE END ！！！！