轉 freemarker macro(宏)的使用
有人說用freemarker，但沒有用到它的宏（macro），就＝沒有真正用過freemarker。說的就是宏是freemarker的一大特色。
宏的定義可以查看相關的文檔，裏面介紹得很清楚，下面來看看它的一個用法。
/WEB-INF/template/common/common.ftl：
<#macro html title>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=GBK" />
<title>${title}</title>
<link rel="stylesheet" rev="stylesheet" href="/oa/file/css.css" type="text/css" media="all" />
</head>
<body>
<#nested/>
</body>
</html>
</#macro>
然後在freemarker.properties裏定義：
auto_import=/WEB-INF/template/common/common.ftl as c
然後其他的ftl文件就可以使用它了
test.ftl：
<@c.html title="OA">
你的內容
<[email protected]>
如果不在freemarker.properties裏定義，可以在每個文件裏包含這個ftl：
<#import "/WEB-INF/template/common/common.ftl" as c>
不同的場合有不同的運用。使用得好的話，將會大大節省你的開發時間。
macro, nested, return
語法
<#macro name param1 param2 ... paramN>
...
<#nested loopvar1, loopvar2, ..., loopvarN>
...
<#return>
...
</#macro>
用例
<#macro test foo bar="Bar" baaz=-1>
Test text, and the params: ${foo}, ${bar}, ${baaz}
</#macro>
<@test foo="a" bar="b" baaz=5*5-2/>
<@test foo="a" bar="b"/>
<@test foo="a" baaz=5*5-2/>
<@test foo="a"/>
輸出
Test text, and the params: a, b, 23
Test text, and the params: a, b, -1
Test text, and the params: a, Bar, 23
Test text, and the params: a, Bar, -1
定義循環輸出的宏
<#macro list title items>
<p>${title?cap_first}:
<ul>
<#list items as x>
<li>${x?cap_first}
</#list>
</ul>
</#macro>
<@list items=["mouse", "elephant", "python"] title="Animals"/>
輸出結果
<p>Animals:
<ul>
<li>Mouse
<li>Elephant
<li>Python
</ul>
包含body的宏
<#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>
<[email protected]>
輸出
1. 0.5
2. 1
3. 1.5
4. 2 Last!
--------------------------------------------------------------------------------
註意在使用的時候：別忘了雙引號。
<#import "/pagelibs/book.ftl" as book>
<@workorder.price value="${book.price}" />
宏Macro
宏是在模板中使用macro指令定義
l.1 基本用法
宏是和某個變量關聯的模板片斷，以便在模板中通過用戶定義指令使用該變量，下面是一個例子：
<#macro greet> <font size="+2">Hello Joe!</font></#macro>
調用宏時，與使用FreeMarker的其他指令類似，[email protected]#。
<@greet><[email protected]> <#--<@greet/>-->
在macro指令中可以在宏變量之後定義參數，如：
<#macro greet person> <font size="+2">Hello ${person}!</font></#macro>
可以這樣使用這個宏變量：
<@greet person="Fred"/>
但是下面的代碼具有不同的意思：
<@greet person=Fred/>
這意味著將Fred變量的值傳給person參數，該值不僅是字符串，還可以是其它類型，甚至是復雜的表達式。
宏可以有多參數，下面是一個例子：
<#macro greet person color> <font size="+2" color="${color}">Hello ${person}!</font></#macro>
可以這樣使用該宏變量，其中參數的次序是無關的：
<@greet person="Fred" color="black"/>
可以在定義參數時指定缺省值，否則，在調用宏的時候，必須對所有參數賦值：
<#macro greet person color="black"> <font size="+2" color="${color}">Hello ${person}!</font></#macro>
註意：宏的參數是局部變量，只能在宏定義中有效。
嵌套內容
FreeMarker的宏可以有嵌套內容，<#nested>指令會執行宏調用指令開始和結束標記之間的模板片斷，舉一個簡單的例子：
<#macro border> <table border=4 cellspacing=0 cellpadding=4><tr><td> <#nested> </td></tr></table></#macro>
執行宏調用：
<@border>The bordered text<[email protected]>
輸出結果：
<table border=4 cellspacing=0 cellpadding=4><tr><td> The bordered text </td></tr></table>
<#nested>指令可以被多次調用，每次都會執行相同的內容。
<#macro do_thrice> <#nested> <#nested> <#nested></#macro><@do_thrice> Anything.<[email protected]_thrice>
FMPP 輸出結果：
Anything.Anything.Anything.
嵌套內容可以是有效的FTL，下面是一個有些復雜的例子，我們將上面三個宏組合起來：
<@border> <ul> <@do_thrice> <li><@greet person="Joe"/> <[email protected]_thrice> </ul><[email protected]>
輸出結果：
<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>
宏定義中的局部變量對嵌套內容是不可見的，例如：
<#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("?")}<[email protected]>
輸出結果：
test 3/1: ? ? ?test 3/2: ? ? ?test 3/3: ? ? ?
在宏定義中使用循環變量
nestted指令也可以有循環變量（循環變量的含義見下節），調用宏的時候在宏指令的參數後面依次列出循環變量的名字，格式如下：
<@ macro_name paramter list; loop variable list[,]>
例如：
<#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><[email protected]>
這裏count是宏的參數，c, halfc,last則為循環變量，輸出結果：
1. 0.5 2. 1 3. 1.5 4. 2 Last!
循環變量和宏標記指定的不同不會有問題，如果調用時少指定了循環變量，那麽多余的值不可見。調用時多指定了循環變量，多余的循環變量不會被創建：
<@repeat count=4 ; c, halfc, last> ${c}. ${halfc}<#if last> Last!</#if><[email protected]><@repeat count=4 ; c, halfc> ${c}. ${halfc}<[email protected]><@repeat count=4> Just repeat it...<[email protected]>
在模板中定義變量
在模板中定義的變量有三種類型：
plain變量：可以在模板的任何地方訪問，包括使用include指令插入的模板，使用assign指令創建和替換。
局部變量：在宏定義體中有效，使用local指令創建和替換。
循環變量：只能存在於指令的嵌套內容，由指令（如list）自動創建；宏的參數是局部變量，而不是循環變量
局部變量隱藏（而不是覆蓋）同名的plain變量；循環變量隱藏同名的局部變量和plain變量，下面是一個例子：
<#assign x = "plain">${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>
輸出結果：
1. plain 2. plain 3. local 4. loop 5. local 6. plain 7. loop 8. loop 9. plain2
內部循環變量隱藏同名的外部循環變量，如：
<#list ["loop 1"] as x> ${x} <#list ["loop 2"] as x> ${x} <#list ["loop 3"] as x> ${x} </#list> ${x} </#list> ${x}</#list>
輸出結果：
loop 1 loop 2 loop 3 loop 2 loop 1
模板中的變量會隱藏（而不是覆蓋）數據模型中同名變量，如果需要訪問數據模型中的同名變量，使用特殊變量global，下面的例子假設數據模型中的user的值是Big Joe：
<#assign user = "Joe Hider">${user} <#-- prints: Joe Hider -->${.globals.user} <#-- prints: Big Joe -->
名字空間
通常情況，只使用一個名字空間，稱為主名字空間，但為了創建可重用的宏、變換器或其它變量的集合（通常稱庫），必須使用多名字空間，其目的是防止同名沖突
創建庫
下面是一個創建庫的例子（假設保存在lib/my_test.ftl中）：
<#macro copyright date> <p>Copyright (C) ${date} Julia Smith. All rights reserved. <br>Email: ${mail}</p></#macro> <#assign mail = "[email protected]">
使用import指令導入庫到模板中，Freemarker會為導入的庫創建新的名字空間，並可以通過import指令中指定的散列變量訪問庫中的變量：
<#import "/lib/my_test.ftl" as my><#assign mail="[email protected]"><@my.copyright date="1999-2002"/>${my.mail}${mail}
輸出結果：
<p>Copyright (C) 1999-2002 Julia Smith. All rights reserved. <br>Email: [email protected]</p>[email protected]@acme.com
可以看到例子中使用的兩個同名變量並沒有沖突，因為它們位於不同的名字空間。還可以使用assign指令在導入的名字空間中創建或替代變量，下面是一個例子：
<#import "/lib/my_test.ftl" as my>${my.mail}<#assign mail="[email protected]" in my>${my.mail}
輸出結果：
[email protected]@other.com
數據模型中的變量任何地方都可見，也包括不同的名字空間，下面是修改的庫：
<#macro copyright date> <p>Copyright (C) ${date} ${user}. All rights reserved.</p></#macro><#assign mail = "[email protected]">
假設數據模型中的user變量的值是Fred，則下面的代碼：
<#import "/lib/my_test.ftl" as my><@my.copyright date="1999-2002"/>${my.mail}
輸出結果：
<p>Copyright (C) 1999-2002 Fred. All rights reserved.</p>[email protected]
選擇Velocity還是FreeMarker?
Velocity是另外一個優秀的模板引擎，它是FreeMarker的有力競爭者。但是它的模板語言不夠強大，也不夠嚴謹。
除開FreeMarker內建的Velocity所沒有的強大函數外，FreeMarker還在以下方面更勝一籌：
與Velocity 相比，FreeMarker 對表現邏輯和業務邏輯的劃分更為嚴格，Freemarker在模板中不允許對Servlet API進行直接操作（而Velocity可以），如FreeMarker 中禁止對HttpServletRequest 對象直接訪問（但可以訪問HttpServletRequest對象中的Attribute）。通過更加嚴格的隔離機制，牽涉邏輯處理的操作被強制轉移到 邏輯層。從而完全保證了層次之間的清晰性。
另外一個Velocity無法實現的特性，也是最具備實際意義的特性：FreeMarker提供了強大的宏。
此外，FreeMarker對JSP Tag提供了良好支持。我們可以將FreeMarker看作是僅允許使用TAG的JSP頁面（實際上，FreeMarker的表達式語法與EL語法也非常 類似）。從開發角度而言，只允許使用TAG的JSP頁面，已經在很大程度上保證了頁面表現邏輯與業務邏輯的分離。程序員在JSP Script中混雜邏輯代碼的原因，大部分是出於慵懶，只要無法在頁面模板中直接編寫Java代碼，相信程序員也不會去專門編寫一個JSP TAG來刻意違反層次劃分原則。
轉 freemarker macro(宏)的使用