FreeMarker中文API手册(完整)
轉(zhuǎn)自http://blog.csdn.net/junjun16818/article/details/6990068
FreeMarker概述
?
???????? FreeMarker是一個模板引擎，一個基于模板生成文本輸出的通用工具，使用純Java編寫
???????? FreeMarker被設(shè)計用來生成HTML Web頁面，特別是基于MVC模式的應(yīng)用程序
???????? 雖然FreeMarker具有一些編程的能力，但通常由Java程序準備要顯示的數(shù)據(jù)，由FreeMarker生成頁面，通過模板顯示準備的數(shù)據(jù)（如下圖）
???????? FreeMarker不是一個Web應(yīng)用框架，而適合作為Web應(yīng)用框架一個組件
???????? FreeMarker與容器無關(guān)，因為它并不知道HTTP或Servlet；FreeMarker同樣可以應(yīng)用于非Web應(yīng)用程序環(huán)境
???????? FreeMarker更適合作為Model2框架（如Struts）的視圖組件，你也可以在模板中使用JSP標記庫
???????? FreeMarker是免費的
?
?
1、通用目標
???????? 能夠生成各種文本：HTML、XML、RTF、Java源代碼等等
???????? 易于嵌入到你的產(chǎn)品中：輕量級；不需要Servlet環(huán)境
???????? 插件式模板載入器：可以從任何源載入模板，如本地文件、數(shù)據(jù)庫等等
???????? 你可以按你所需生成文本：保存到本地文件；作為Email發(fā)送；從Web應(yīng)用程序發(fā)送它返回給Web瀏覽器
?
2、強大的模板語言
???????? 所有常用的指令：include、if/elseif/else、循環(huán)結(jié)構(gòu)
???????? 在模板中創(chuàng)建和改變變量
???????? 幾乎在任何地方都可以使用復(fù)雜表達式來指定值
???????? 命名的宏，可以具有位置參數(shù)和嵌套內(nèi)容
???????? 名字空間有助于建立和維護可重用的宏庫，或者將一個大工程分成模塊，而不必擔心名字沖突
???????? 輸出轉(zhuǎn)換塊：在嵌套模板片段生成輸出時，轉(zhuǎn)換HTML轉(zhuǎn)義、壓縮、語法高亮等等；你可以定義自己的轉(zhuǎn)換
?
3、通用數(shù)據(jù)模型
???????? FreeMarker不是直接反射到Java對象，Java對象通過插件式對象封裝，以變量方式在模板中顯示
???????? 你可以使用抽象（接口）方式表示對象（JavaBean、XML文檔、SQL查詢結(jié)果集等等），告訴模板開發(fā)者使用方法，使其不受技術(shù)細節(jié)的打擾
?
4、為Web準備
???????? 在模板語言中內(nèi)建處理典型Web相關(guān)任務(wù)（如HTML轉(zhuǎn)義）的結(jié)構(gòu)
???????? 能夠集成到Model2 Web應(yīng)用框架中作為JSP的替代
???????? 支持JSP標記庫
???????? 為MVC模式設(shè)計：分離可視化設(shè)計和應(yīng)用程序邏輯；分離頁面設(shè)計員和程序員
?
5、智能的國際化和本地化
???????? 字符集智能化（內(nèi)部使用UNICODE）
???????? 數(shù)字格式本地化敏感
???????? 日期和時間格式本地化敏感
???????? 非US字符集可以用作標識（如變量名）
???????? 多種不同語言的相同模板
?
6、強大的XML處理能力
???????? <#recurse> 和<#visit>指令（2.3版本）用于遞歸遍歷XML樹
???????? 在模板中清楚和直覺的訪問XML對象模型
??
?
??
FreeMarker設(shè)計指南(1)
?
1、快速入門
（1）模板 + 數(shù)據(jù)模型 = 輸出
???????? FreeMarker基于設(shè)計者和程序員是具有不同專業(yè)技能的不同個體的觀念
???????? 他們是分工勞動的：設(shè)計者專注于表示——創(chuàng)建HTML文件、圖片、Web頁面的其它可視化方面；程序員創(chuàng)建系統(tǒng)，生成設(shè)計頁面要顯示的數(shù)據(jù)
???????? 經(jīng)常會遇到的問題是：在Web頁面（或其它類型的文檔）中顯示的信息在設(shè)計頁面時是無效的，是基于動態(tài)數(shù)據(jù)的
???????? 在這里，你可以在HTML（或其它要輸出的文本）中加入一些特定指令，FreeMarker會在輸出頁面給最終用戶時，用適當?shù)臄?shù)據(jù)替代這些代碼
???????? 下面是一個例子：
<html>
<head>
? <title>Welcome!</title>
</head>
<body>
? <h1>Welcome ${user}!</h1>
? <p>Our latest product:
? <a href="${latestProduct.url}">${latestProduct.name}</a>!
</body>
</html>?
???????? 這個例子是在簡單的HTML中加入了一些由${…}包圍的特定代碼，這些特定代碼是FreeMarker的指令，而包含F(xiàn)reeMarker的指令的文件就稱為模板（Template）
???????? 至于user、latestProduct.url和latestProduct.name來自于數(shù)據(jù)模型（data model）
???????? 數(shù)據(jù)模型由程序員編程來創(chuàng)建，向模板提供變化的信息，這些信息來自于數(shù)據(jù)庫、文件，甚至于在程序中直接生成
???????? 模板設(shè)計者不關(guān)心數(shù)據(jù)從那兒來，只知道使用已經(jīng)建立的數(shù)據(jù)模型
???????? 下面是一個可能的數(shù)據(jù)模型：
(root)
? |
? +- user = "Big Joe"
? |
? +- latestProduct
????? |
????? +- url = "products/greenmouse.html"
????? |
????? +- name = "green mouse"
???????? 數(shù)據(jù)模型類似于計算機的文件系統(tǒng)，latestProduct可以看作是目錄，而user、url和name看作是文件，url和name文件位于latestProduct目錄中（這只是一個比喻，實際并不存在）
???????? 當FreeMarker將上面的數(shù)據(jù)模型合并到模板中，就創(chuàng)建了下面的輸出：
<html>
<head>
? <title>Welcome!</title>
</head>
<body>
? <h1>Welcome Big Joe!</h1>
? <p>Our latest product:
?<a href="products/greenmouse.html">green mouse</a>!
</body>
</html>?
（2）數(shù)據(jù)模型
???????? 典型的數(shù)據(jù)模型是樹型結(jié)構(gòu)，可以任意復(fù)雜和深層次，如下面的例子：
(root)
? |
? +- animals
? |?? |
? |?? +- mouse
? |?? |?? |??
? |?? |?? +- size = "small"
? |?? |?? |??
? |?? |?? +- price = 50
? |?? |
? |?? +- elephant
? |?? |?? |??
? |?? |?? +- size = "large"
? |?? |?? |??
? |?? |?? +- price = 5000
? |?? |
? |?? +- python
? |?????? |??
? |?????? +- size = "medium"
? |?????? |??
? |?????? +- price = 4999
? |
? +- test = "It is a test"
? |
? +- whatnot
????? |
????? +- because = "don't know"
???????? 類似于目錄的變量稱為hashes，包含保存下級變量的唯一的查詢名字
???????? 類似于文件的變量稱為scalars，保存單值
???????? scalars保存的值有兩種類型：字符串（用引號括起，可以是單引號或雙引號）和數(shù)字（不要用引號將數(shù)字括起，這會作為字符串處理）
???????? 對scalars的訪問從root開始，各部分用“.”分隔，如animals.mouse.price
???????? 另外一種變量是sequences，和hashes類似，只是不使用變量名字，而使用數(shù)字索引，如下面的例子：
(root)
? |
? +- animals
? |?? |
? |?? +- (1st)
? |?? |?? |
? |?? |?? +- name = "mouse"
? |?? |?? |
? |?? |?? +- size = "small"
? |?? |?? |
? |?? |?? +- price = 50
? |?? |
? |?? +- (2nd)
? |?? |?? |
? |?? |?? +- name = "elephant"
? |?? |?? |
? |?? |?? +- size = "large"
? |?? |?? |
? |?? |?? +- price = 5000
? |?? |
? |?? +- (3rd)
? |?????? |
? |?????? +- name = "python"
? |?????? |
? |?????? +- size = "medium"
? |?????? |
? |?????? +- price = 4999
? |
? +- whatnot
????? |
????? +- fruits
????????? |
????????? +- (1st) = "orange"
????????? |
????????? +- (2nd) = "banana"
???????? 這種對scalars的訪問使用索引，如animals[0].name
（3）模板
???????? 在FreeMarker模板中可以包括下面三種特定部分：
????????? ${…}：稱為interpolations，FreeMarker會在輸出時用實際值進行替代
????????? FTL標記（FreeMarker模板語言標記）：類似于HTML標記，為了與HTML標記區(qū)分，用#開始（有些以@開始，在后面敘述）
????????? 注釋：包含在<#--和-->（而不是<!--和-->）之間
???????? 下面是一些使用指令的例子：
????????? if指令
<#if animals.python.price < animals.elephant.price>
? Pythons are cheaper than elephants today.
<#else>
? Pythons are not cheaper than elephants today.
</#if>?
????????? list指令
<p>We have these animals:
<table border=1>
? <tr><th>Name<th>Price
? <#list animals as being>
? <tr><td>${being.name}<td>${being.price} Euros
? </#list>
</table>?
輸出為：
<p>We have these animals:
<table border=1>
? <tr><th>Name<th>Price
? <tr><td>mouse<td>50 Euros
? <tr><td>elephant<td>5000 Euros
? <tr><td>python<td>4999 Euros
</table>?
????????? include指令
<html>
<head>
? <title>Test page</title>
</head>
<body>
? <h1>Test page</h1>
? <p>Blah blah...
<#include "/copyright_footer.html">
</body>
</html>?
????????? 一起使用指令
<p>We have these animals:
<table border=1>
? <tr><th>Name<th>Price
? <#list animals as being>
? <tr>
??? <td>
????? <#if being.size = "large"><b></#if>
????? ${being.name}
????? <#if being.size = "large"></b></#if>
??? <td>${being.price} Euros
? </#list>
</table>?
?
-------------------------------------------------------------
?
FreeMarker設(shè)計指南(3)
?
3、模板
（1）整體結(jié)構(gòu)
???????? 模板使用FTL（FreeMarker模板語言）編寫，是下面各部分的一個組合：
????????? 文本：直接輸出
????????? Interpolation：由${和}，或#{和}來限定，計算值替代輸出
????????? FTL標記：FreeMarker指令，和HTML標記類似，名字前加#予以區(qū)分，不會輸出
????????? 注釋：由<#--和-->限定，不會輸出
???????? 下面是以一個具體模板例子：
<html>[BR]
<head>[BR]
? <title>Welcome!</title>[BR]
</head>[BR]
<body>[BR]
? <#-- Greet the user with his/her name -->[BR]
? <h1>Welcome ${user}!</h1>[BR]
? <p>We have these animals:[BR]
? <ul>[BR]
? <#list animals as being>[BR]
??? <li>${being.name} for ${being.price} Euros[BR]
? </#list>[BR]
? </ul>[BR]
</body>[BR]
</html>?
???????? [BR]是用于換行的特殊字符序列
???????? 注意事項：
????????? FTL區(qū)分大小寫，所以list是正確的FTL指令，而List不是；${name}和${NAME}是不同的
????????? Interpolation只能在文本中使用
????????? FTL標記不能位于另一個FTL標記內(nèi)部，例如：
<#if <#include 'foo'>='bar'>...</if>
????????? 注釋可以位于FTL標記和Interpolation內(nèi)部，如下面的例子：
<h1>Welcome ${user <#-- The name of user -->}!</h1>[BR]
<p>We have these animals:[BR]
<ul>[BR]
<#list <#-- some comment... --> animals as <#-- again... --> being>[BR]
...?
????????? 多余的空白字符會在模板輸出時移除
（2）指令
???????? 在FreeMarker中，使用FTL標記引用指令
???????? 有三種FTL標記，這和HTML標記是類似的：
????????? 開始標記：<#directivename parameters>
????????? 結(jié)束標記：</#directivename>
????????? 空內(nèi)容指令標記：<#directivename parameters/>
???????? 有兩種類型的指令：預(yù)定義指令和用戶定義指令
???????? 用戶定義指令要使用@替換#，如<@mydirective>...</@mydirective>（會在后面講述）
???????? FTL標記不能夠交叉，而應(yīng)該正確的嵌套，如下面的代碼是錯誤的：
<ul>
<#list animals as being>
? <li>${being.name} for ${being.price} Euros
? <#if use = "Big Joe">
???? (except for you)
</#list>
</#if> <#-- WRONG! -->
</ul>?
???????? 如果使用不存在的指令，FreeMarker不會使用模板輸出，而是產(chǎn)生一個錯誤消息
???????? FreeMarker會忽略FTL標記中的空白字符，如下面的例子：
<#list[BR]
? animals?????? as[BR]
???? being[BR]
>[BR]
${being.name} for ${being.price} Euros[BR]
</#list??? >?
???????? 但是，<、</和指令之間不允許有空白字符
（3）表達式
???????? 直接指定值
????????? 字符串
n???????? 使用單引號或雙引號限定
n???????? 如果包含特殊字符需要轉(zhuǎn)義，如下面的例子：
${"It's \"quoted\" and
this is a backslash: \\"}
?
${'It\'s "quoted" and
this is a backslash:?\\'}
輸出結(jié)果是：
It's "quoted" and
this is a backslash: \
?
It's "quoted" and
this is a backslash: \
n???????? 下面是支持的轉(zhuǎn)義序列：?
轉(zhuǎn)義序列
?
含義
?
\"
?
雙引號(u0022)
?
\'
?
單引號(u0027)
?
\\
?
反斜杠(u005C)
?
\n
?
換行(u000A)
?
\r
?
Return (u000D)
?
\t
?
Tab (u0009)
?
\b
?
Backspace (u0008)
?
\f
?
Form feed (u000C)
?
\l
?
<?
?
\g
?
>?
?
\a
?
&
?
\{
?
{
?
\xCode
?
4位16進制Unicode代碼
?
n???????? 有一類特殊的字符串稱為raw字符串，被認為是純文本，其中的\和{等不具有特殊含義，該類字符串在引號前面加r，下面是一個例子：
${r"${foo}"}
${r"C:\foo\bar"}?
輸出的結(jié)果是：
${foo}
C:\foo\bar?
????????? 數(shù)字
n???????? 直接輸入，不需要引號
n???????? 精度數(shù)字使用“.”分隔，不能使用分組符號
n???????? 目前版本不支持科學(xué)計數(shù)法，所以“1E3”是錯誤的
n???????? 不能省略小數(shù)點前面的0，所以“.5”是錯誤的
n???????? 數(shù)字8、+8、08和8.00都是相同的
????????? 布爾值
n???????? true和false，不使用引號
????????? 序列
n???????? 由逗號分隔的子變量列表，由方括號限定，下面是一個例子：
<#list ["winter", "spring", "summer", "autumn"] as x>
${x}
</#list>
輸出的結(jié)果是：
winter
spring
summer
autumn
n???????? 列表的項目是表達式，所以可以有下面的例子：
[2 + 2, [1, 2, 3, 4], "whatnot"]
n???????? 可以使用數(shù)字范圍定義數(shù)字序列，例如2..5等同于[2, 3, 4, 5]，但是更有效率，注意數(shù)字范圍沒有方括號
n???????? 可以定義反遞增的數(shù)字范圍，如5..2
????????? 散列（hash）
n???????? 由逗號分隔的鍵/值列表，由大括號限定，鍵和值之間用冒號分隔，下面是一個例子：
{"name":"green mouse", "price":150}
n???????? 鍵和值都是表達式，但是鍵必須是字符串
???????? 獲取變量
????????? 頂層變量： ${variable}，變量名只能是字母、數(shù)字、下劃線、$、@和#的組合，且不能以數(shù)字開頭
????????? 從散列中獲取數(shù)據(jù)
n???????? 可以使用點語法或方括號語法，假設(shè)有下面的數(shù)據(jù)模型：
(root)
|
+- book
|?? |
|?? +- title = "Breeding green mouses"
|?? |
|?? +- author
|?????? |
|?????? +- name = "Julia Smith"
|?????? |
|?????? +- info = "Biologist, 1923-1985, Canada"
|
+- test = "title"
下面都是等價的：
book.author.name
book["author"].name
book.author.["name"]
book["author"]["name"]
n???????? 使用點語法，變量名字有頂層變量一樣的限制，但方括號語法沒有該限制，因為名字是任意表達式的結(jié)果
????????? 從序列獲得數(shù)據(jù)：和散列的方括號語法語法一樣，只是方括號中的表達式值必須是數(shù)字；注意：第一個項目的索引是0
????????? 序列片斷：使用[startIndex..endIndex]語法，從序列中獲得序列片斷（也是序列）；startIndex和endIndex是結(jié)果為數(shù)字的表達式
????????? 特殊變量：FreeMarker內(nèi)定義變量，使用.variablename語法訪問
???????? 字符串操作
????????? Interpolation（或連接操作）
n???????? 可以使用${..}（或#{..}）在文本部分插入表達式的值，例如：
${"Hello ${user}!"}
${"${user}${user}${user}${user}"}?
n???????? 可以使用+操作符獲得同樣的結(jié)果
${"Hello " + user + "!"}
${user + user + user + user}
n???????? ${..}只能用于文本部分，下面的代碼是錯誤的：
<#if ${isBig}>Wow!</#if>
<#if "${isBig}">Wow!</#if>
應(yīng)該寫成：
<#if isBig>Wow!</#if>
????????? 子串
n???????? 例子（假設(shè)user的值為“Big Joe”）：
${user[0]}${user[4]}
${user[1..4]}
結(jié)果是（注意第一個字符的索引是0）：
BJ
ig J
???????? 序列操作
????????? 連接操作：和字符串一樣，使用+，下面是一個例子：
<#list ["Joe", "Fred"] + ["Julia", "Kate"] as user>
- ${user}
</#list>
輸出結(jié)果是：
- Joe
- Fred
- Julia
- Kate
???????? 散列操作
????????? 連接操作：和字符串一樣，使用+，如果具有相同的key，右邊的值替代左邊的值，例如：
<#assign ages = {"Joe":23, "Fred":25} + {"Joe":30, "Julia":18}>
- Joe is ${ages.Joe}
- Fred is ${ages.Fred}
- Julia is ${ages.Julia}?
輸出結(jié)果是：
- Joe is 30
- Fred is 25
- Julia is 18?
???????? 算術(shù)運算
????????? ＋、－、×、／、％，下面是一個例子：
${x * x - 100}
${x / 2}
${12 % 10}
輸出結(jié)果是（假設(shè)x為5）：
-75
2.5
2?
????????? 操作符兩邊必須是數(shù)字，因此下面的代碼是錯誤的：
${3 * "5"} <#-- WRONG! -->?
????????? 使用+操作符時，如果一邊是數(shù)字，一邊是字符串，就會自動將數(shù)字轉(zhuǎn)換為字符串，例如：
${3 + "5"}?
輸出結(jié)果是：
35
????????? 使用內(nèi)建的int（后面講述）獲得整數(shù)部分，例如：
${(x/2)?int}
${1.1?int}
${1.999?int}
${-1.1?int}
${-1.999?int}
輸出結(jié)果是（假設(shè)x為5）：
2
1
1
-1
-1
???????? 比較操作符
????????? 使用=（或==，完全相等）測試兩個值是否相等，使用!= 測試兩個值是否不相等
????????? =和!=兩邊必須是相同類型的值，否則會產(chǎn)生錯誤，例如<#if 1 = "1">會引起錯誤
????????? Freemarker是精確比較，所以對"x"、"x? "和"X"是不相等的
????????? 對數(shù)字和日期可以使用<、<=、>和>=，但不能用于字符串
????????? 由于Freemarker會將>解釋成FTL標記的結(jié)束字符，所以對于>和>=可以使用括號來避免這種情況，例如<#if (x > y)>
????????? 另一種替代的方法是，使用lt、lte、gt和gte來替代<、<=、>和>=
???????? 邏輯操作符
????????? &&（and）、||（or）、!（not），只能用于布爾值，否則會產(chǎn)生錯誤
????????? 例子：
<#if x < 12 && color = "green">
? We have less than 12 things, and they are green.
</#if>
<#if !hot> <#-- here hot must be a boolean -->
? It's not hot.
</#if>?
???????? 內(nèi)建函數(shù)
????????? 內(nèi)建函數(shù)的用法類似訪問散列的子變量，只是使用“?”替代“.”，下面列出常用的一些函數(shù)
????????? 字符串使用的：
n???????? html：對字符串進行HTML編碼
n???????? cap_first：使字符串第一個字母大寫
n???????? lower_case：將字符串轉(zhuǎn)換成小寫
n???????? upper_case：將字符串轉(zhuǎn)換成大寫
n???????? trim：去掉字符串前后的空白字符
????????? 序列使用的：
n???????? size：獲得序列中元素的數(shù)目
????????? 數(shù)字使用的：
n???????? int：取得數(shù)字的整數(shù)部分（如-1.9?int的結(jié)果是-1）
????????? 例子（假設(shè)test保存字符串"Tom & Jerry"）：
${test?html}
${test?upper_case?html}
輸出結(jié)果是：
Tom & Jerry
TOM & JERRY?
???????? 操作符優(yōu)先順序?
操作符組
?
操作符
?
后綴
?
[subvarName] [subStringRange] . (methodParams)
?
一元
?
+expr、-expr、!
?
內(nèi)建
?
?
?
乘法
?
*、 / 、%
?
加法
?
+、-
?
關(guān)系
?
<、>、<=、>=（lt、lte、gt、gte）
?
相等
?
==（=）、!=
?
邏輯and
?
&&
?
邏輯or
?
||
?
數(shù)字范圍
?
..
?
（4）Interpolation
???????? Interpolation有兩種類型：
????????? 通用Interpolation：${expr}
????????? 數(shù)字Interpolation：#{expr}或#{expr; format}
???????? 注意：Interpolation只能用于文本部分
???????? 通用Interpolation
????????? 插入字符串值：直接輸出表達式結(jié)果
????????? 插入數(shù)字值：根據(jù)缺省格式（由#setting指令設(shè)置）將表達式結(jié)果轉(zhuǎn)換成文本輸出；可以使用內(nèi)建函數(shù)string格式化單個Interpolation，下面是一個例子：
<#setting number_format="currency"/>
<#assign answer=42/>
${answer}
${answer?string}? <#-- the same as ${answer} -->
${answer?string.number}
${answer?string.currency}
${answer?string.percent}
輸出結(jié)果是：
$42.00
$42.00
42
$42.00
4,200%
????????? 插入日期值：根據(jù)缺省格式（由#setting指令設(shè)置）將表達式結(jié)果轉(zhuǎn)換成文本輸出；可以使用內(nèi)建函數(shù)string格式化單個Interpolation，下面是一個使用格式模式的例子：
${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')'")}?
輸出的結(jié)果類似下面的格式：
2003-04-08 21:24:44 Pacific Daylight Time
Tue, Apr 8, '03
Tuesday, April 08, 2003, 09:24:44 PM (PDT)
????????? 插入布爾值：根據(jù)缺省格式（由#setting指令設(shè)置）將表達式結(jié)果轉(zhuǎn)換成文本輸出；可以使用內(nèi)建函數(shù)string格式化單個Interpolation，下面是一個例子：
<#assign foo=true/>
${foo?string("yes", "no")}
輸出結(jié)果是：
yes
???????? 數(shù)字Interpolation的#{expr; format}形式可以用來格式化數(shù)字，format可以是：
????????? mX：小數(shù)部分最小X位
????????? MX：小數(shù)部分最大X位
????????? 例子：
?????????? <#-- If the language is US English the output is: -->
<#assign x=2.582/>
<#assign y=4/>
#{x; M2}?? <#-- 2.58 -->
#{y; M2}?? <#-- 4??? -->
#{x; m1}?? <#-- 2.6 -->
#{y; m1}?? <#-- 4.0 -->
#{x; m1M2} <#-- 2.58 -->
#{y; m1M2} <#-- 4.0? -->
?
-----------------------------------------------------------
?
FreeMarker設(shè)計指南(4)
4、雜項
（1）用戶定義指令
???????? 宏和變換器變量是兩種不同類型的用戶定義指令，它們之間的區(qū)別是宏是在模板中使用macro指令定義，而變換器是在模板外由程序定義，這里只介紹宏
???????? 基本用法
????????? 宏是和某個變量關(guān)聯(lián)的模板片斷，以便在模板中通過用戶定義指令使用該變量，下面是一個例子：
<#macro greet>
? <font size="+2">Hello Joe!</font>
</#macro>?
????????? 作為用戶定義指令使用宏變量時，使用@替代FTL標記中的#
<@greet></@greet>
????????? 如果沒有體內(nèi)容，也可以使用：
<@greet/>
???????? 參數(shù)
????????? 在macro指令中可以在宏變量之后定義參數(shù)，如：
<#macro greet person>
? <font size="+2">Hello ${person}!</font>
</#macro>
????????? 可以這樣使用這個宏變量：
<@greet person="Fred"/> and <@greet person="Batman"/>
輸出結(jié)果是：
? <font size="+2">Hello Fred!</font>
and?? <font size="+2">Hello Batman!</font>
?
????????? 宏的參數(shù)是FTL表達式，所以下面的代碼具有不同的意思：
<@greet person=Fred/>
????????? 這意味著將Fred變量的值傳給person參數(shù)，該值不僅是字符串，還可以是其它類型，甚至是復(fù)雜的表達式
????????? 宏可以有多參數(shù)，下面是一個例子：
<#macro greet person color>
? <font size="+2" color="${color}">Hello ${person}!</font>
</#macro>
????????? 可以這樣使用該宏變量：
<@greet person="Fred" color="black"/>
????????? 其中參數(shù)的次序是無關(guān)的，因此下面是等價的：
<@greet color="black" person="Fred"/>
????????? 只能使用在macro指令中定義的參數(shù)，并且對所有參數(shù)賦值，所以下面的代碼是錯誤的：
<@greet person="Fred" color="black" background="green"/>
<@greet person="Fred"/>
????????? 可以在定義參數(shù)時指定缺省值，如：
<#macro greet person color="black">
? <font size="+2" color="${color}">Hello ${person}!</font>
</#macro>?
????????? 這樣<@greet person="Fred"/>就正確了
????????? 宏的參數(shù)是局部變量，只能在宏定義中有效
???????? 嵌套內(nèi)容
????????? 用戶定義指令可以有嵌套內(nèi)容，使用<#nested>指令執(zhí)行指令開始和結(jié)束標記之間的模板片斷
????????? 例子：
<#macro border>
? <table border=4 cellspacing=0 cellpadding=4><tr><td>
??? <#nested>
? </tr></td></table>
</#macro>?
這樣使用該宏變量：
<@border>The bordered text</@border>
輸出結(jié)果：
? <table border=4 cellspacing=0 cellpadding=4><tr><td>
??? The bordered text
? </tr></td></table>
?
????????? <#nested>指令可以被多次調(diào)用，例如：
<#macro do_thrice>
? <#nested>
? <#nested>
? <#nested>
</#macro>
<@do_thrice>
? Anything.
</@do_thrice>?
輸出結(jié)果：
? Anything.
? Anything.
? Anything.
????????? 嵌套內(nèi)容可以是有效的FTL，下面是一個有些復(fù)雜的例子：
<@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>?
????????? 宏定義中的局部變量對嵌套內(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)變量
????????? 用戶定義指令可以有循環(huán)變量，通常用于重復(fù)嵌套內(nèi)容，基本用法是：作為nested指令的參數(shù)傳遞循環(huán)變量的實際值，而在調(diào)用用戶定義指令時，在<@…>開始標記的參數(shù)后面指定循環(huán)變量的名字
????????? 例子：
<#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>?
輸出結(jié)果：
? 1. 0.5
? 2. 1
? 3. 1.5
? 4. 2 Last!
?
????????? 指定的循環(huán)變量的數(shù)目和用戶定義指令開始標記指定的不同不會有問題
n???????? 調(diào)用時少指定循環(huán)變量，則多指定的值不可見
n???????? 調(diào)用時多指定循環(huán)變量，多余的循環(huán)變量不會被創(chuàng)建
（2）在模板中定義變量
???????? 在模板中定義的變量有三種類型：
????????? plain變量：可以在模板的任何地方訪問，包括使用include指令插入的模板，使用assign指令創(chuàng)建和替換
????????? 局部變量：在宏定義體中有效，使用local指令創(chuàng)建和替換
????????? 循環(huán)變量：只能存在于指令的嵌套內(nèi)容，由指令（如list）自動創(chuàng)建；宏的參數(shù)是局部變量，而不是循環(huán)變量
???????? 局部變量隱藏（而不是覆蓋）同名的plain變量；循環(huán)變量隱藏同名的局部變量和plain變量，下面是一個例子：
<#assign x = "plain">
1. ${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
???????? 模板中的變量會隱藏（而不是覆蓋）數(shù)據(jù)模型中同名變量，如果需要訪問數(shù)據(jù)模型中的同名變量，使用特殊變量global，下面的例子假設(shè)數(shù)據(jù)模型中的user的值是Big Joe：
<#assign user = "Joe Hider">
${user}????????? <#-- prints: Joe Hider -->
${.globals.user} <#-- prints: Big Joe -->?
（3）名字空間
???????? 通常情況，只使用一個名字空間，稱為主名字空間
???????? 為了創(chuàng)建可重用的宏、變換器或其它變量的集合（通常稱庫），必須使用多名字空間，其目的是防止同名沖突
???????? 創(chuàng)建庫
????????? 下面是一個創(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)入庫到模板中，Freemarker會為導(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:?jsmith@acme.com</p>
jsmith@acme.com
fred@acme.com?
可以看到例子中使用的兩個同名變量并沒有沖突，因為它們位于不同的名字空間
???????? 可以使用assign指令在導(dǎo)入的名字空間中創(chuàng)建或替代變量，下面是一個例子：
<#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 = "${user}@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>
注釋：包含在<#--和-->
<#local y = "test"> 定義局部變量
<#import "/lib/my_test.ftl" as my> 導(dǎo)入模板文件 指定名字空間 my
<#macro greet> ? ??用戶定義指令
? <font size="+2">Hello Joe!</font>
</#macro>?
????????? 作為用戶定義指令使用宏變量時，使用@替代FTL標記中的#
<@greet></@greet>
????????? 如果沒有體內(nèi)容，也可以使用：
<@greet/>
<#macro greet person>
? <font size="+2">Hello ${person}!</font>
</#macro>
????????? 可以這樣使用這個宏變量：
<@greet person="Fred"/> and <@greet person="Batman"/>
輸出結(jié)果是：
? <font size="+2">Hello Fred!</font>
and?? <font size="+2">Hello Batman!</font>
用戶定義指令可以有嵌套內(nèi)容，使用<#nested>指令執(zhí)行指令開始和結(jié)束標記之間的模板片斷
????????? 例子：
<#macro border>
? <table border=4 cellspacing=0 cellpadding=4><tr><td>
??? <#nested>
? </tr></td></table>
</#macro>?
?
?
?if指令
<#if animals.python.price < animals.elephant.price>
? Pythons are cheaper than elephants today.
<#else>
? Pythons are not cheaper than elephants today.
</#if>?
?
?
?list指令
? <#list animals as being>
??<tr><td>${being.name}<td>${being.price} Euros
? </#list>
?
? <#list ["winter", "spring", "summer", "autumn"] as x>
? ? ? ?${x}
? </#list>
<#list ["Joe", "Fred"] + ["Julia", "Kate"] as user>
- ${user}
</#list>
輸出結(jié)果是：
- Joe
- Fred
- Julia
- Kate
?
include指令
<#include "/copyright_footer.html">
?
?
有一類特殊的字符串稱為raw字符串，被認為是純文本，其中的\和{等不具有特殊含義，該類字符串在引號前面加r，下面是一個例子：
${r"${foo}"}
${r"C:\foo\bar"}?
輸出的結(jié)果是：
${foo}
C:\foo\bar?
?
?
<#assign ages = {"Joe":23, "Fred":25} + {"Joe":30, "Julia":18}>
- Joe is ${ages.Joe}
- Fred is ${ages.Fred}
- Julia is ${ages.Julia}?
輸出結(jié)果是：
- Joe is 30
- Fred is 25
- Julia is 18?
?
?由于Freemarker會將>解釋成FTL標記的結(jié)束字符，所以對于>和>=可以使用括號來避免這種情況，例如
<#if (x > y)>
?
?
內(nèi)建函數(shù)
????????? 內(nèi)建函數(shù)的用法類似訪問散列的子變量，只是使用“?”替代“.”，下面列出常用的一些函數(shù)
????????? 字符串使用的：
n???????? html：對字符串進行HTML編碼
n???????? cap_first：使字符串第一個字母大寫
n???????? lower_case：將字符串轉(zhuǎn)換成小寫
n???????? upper_case：將字符串轉(zhuǎn)換成大寫
n???????? trim：去掉字符串前后的空白字符
????????? 序列使用的：
n???????? size：獲得序列中元素的數(shù)目
????????? 數(shù)字使用的：
n???????? int：取得數(shù)字的整數(shù)部分（如-1.9?int的結(jié)果是-1）
????????? 例子（假設(shè)test保存字符串"Tom & Jerry"）：
${test?html}
${test?upper_case?html}
輸出結(jié)果是：
Tom & Jerry
TOM & JERRY?
?
?
string格式化單個Interpolation，下面是一個例子：
<#setting number_format="currency"/>
<#assign answer=42/>
${answer}
${answer?string}? <#-- the same as ${answer} -->
${answer?string.number}
${answer?string.currency}
${answer?string.percent}
輸出結(jié)果是：
$42.00
$42.00
42
$42.00
4,200%
?
?
????????? 插入日期值：根據(jù)缺省格式（由#setting指令設(shè)置）將表達式結(jié)果轉(zhuǎn)換成文本輸出；可以使用內(nèi)建函數(shù)string格式化單個Interpolation，下面是一個使用格式模式的例子：
${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')'")}?
輸出的結(jié)果類似下面的格式：
2003-04-08 21:24:44 Pacific Daylight Time
Tue, Apr 8, '03
Tuesday, April 08, 2003, 09:24:44 PM (PDT)
?
?
????????? 插入布爾值：根據(jù)缺省格式（由#setting指令設(shè)置）將表達式結(jié)果轉(zhuǎn)換成文本輸出；可以使用內(nèi)建函數(shù)string格式化單個Interpolation，下面是一個例子：
<#assign foo=true/>
${foo?string("yes", "no")}
輸出結(jié)果是：
yes
?
?
?
? 數(shù)字Interpolation的#{expr; format}形式可以用來格式化數(shù)字，format可以是：
????????? mX：小數(shù)部分最小X位
????????? MX：小數(shù)部分最大X位
????????? 例子：
?????????? <#-- If the language is US English the output is: -->
<#assign x=2.582/>
<#assign y=4/>
#{x; M2}?? <#-- 2.58 -->
#{y; M2}?? <#-- 4??? -->
#{x; m1}?? <#-- 2.6 -->
#{y; m1}?? <#-- 4.0 -->
#{x; m1M2} <#-- 2.58 -->
#{y; m1M2} <#-- 4.0? -->
?
?
使用import指令導(dǎo)入庫到模板中，Freemarker會為導(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:?jsmith@acme.com</p>
jsmith@acme.com
fred@acme.com?
轉(zhuǎn)載于:https://www.cnblogs.com/wwicked/articles/4466653.html
總結(jié)
以上是生活随笔為你收集整理的FreeMarker中文API手册(完整)的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： Individual Project
- 下一篇： python中join的用法