Freemarker定义宏的⽤法
Freemarker宏
⼀.什么是宏:macro
引⽤
宏是在模板中使⽤macro指令定义
基本⽤法
宏是和某个变量关联的模板⽚断，以便在模板中通过⽤户定义指令使⽤该变量，
Java代码
1. <#macro greet>
2. <font size="+2">Hello Joe!</font>
3. </#macro>
4. <#macro greet>
5. <font size="+2">Hello Joe!</font>
6. </#macro>
调⽤宏时，与使⽤FreeMarker的其他指令类似，只是使⽤@替代FTL标记中的#。
<@greet></@greet> <#--<@greet/>-->
在macro指令中可以在宏变量之后定义参数，如：
Java代码
1. <#macro greet person>
2. <font size="+2">Hello ${person}!</font>
3. </#macro>
4. <#macro greet person>
5. <font size="+2">Hello ${person}!</font>
6. </#macro>
可以这样使⽤这个宏变量：
<@greet person="Fred"/>
但是下⾯的代码具有不同的意思：
<@greet person=Fred/>
这意味着将Fred变量的值传给person参数，该值不仅是字符串，还可以是其它类型，甚⾄是复杂的表达式。
宏可以有多参数，下⾯是⼀个例⼦：
Java代码
1. <#macro greet person color>
2. <font size="+2" color="${color}">Hello ${person}!</font>
3. </#macro>
4. <#macro greet person color>
5. <font size="+2" color="${color}">Hello ${person}!</font>
6. </#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>
</tr></td></table>
</#macro>
执⾏宏调⽤：
引⽤
<@border>The bordered text</@border> 输出结果：
<table border=4 cellspacing=0 cellpadding=4><tr><td>
The bordered text
</tr></td></table>
<#nested>指令可以被多次调⽤，每次都会执⾏相同的内容。
<#macro do_thrice>
<#nested>
<#nested>
<#nested>
</#macro>
<@do_thrice>
Anything.
</@do_thrice>
FMPP 输出结果：
Anything.
Anything.
Anything.
引⽤
嵌套内容可以是有效的FTL，下⾯是⼀个有些复杂的例⼦，我们将上⾯三个宏组合起来：
<@border>
<ul>
<@do_thrice>
<li><@greet person="Joe"/>
</@do_thrice>
</ul>
</@border>
输出结果：
<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>
<table border=4 cellspacing=0 cellpadding=4><tr><td>
引⽤
宏定义中的局部变量对嵌套内容是不可见的，例如：
<#macro repeat count>
<#local y = "test">
<#unt as x>
${y} ${count}/${x}: <#nested>
</#list>
</#macro>
<@repeat count=3>${y?default("?")} ${x?default("?")} ${count?default("?")}</@repeat>
输出结果：
test 3/1: ? ? ?
test 3/2: ? ? ?
test 3/3: ? ? ?
引⽤
在宏定义中使⽤循环变量
nestted指令也可以有循环变量（循环变量的含义见下节），调⽤宏的时候在宏指令的参数后⾯依次列出循环变量的名字，格式如下：
<@ macro_name paramter list; loop variable list[,]>
例如：
<#macro repeat count>
<#unt as x>
<#nested x, x/2, x==count>
</#list>
</#macro>
<@repeat count=4 ; c, halfc, last>
${c}. ${halfc}<#if last> Last!</#if>
</@repeat>
这⾥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>
</@repeat>
<@repeat count=4 ; c, halfc>
${c}. ${halfc}
</@repeat>
<@repeat count=4>
Just
</@repeat>
在模版中定义变量
在模板中定义的变量有三种类型：
引⽤
plain变量：可以在模板的任何地⽅访问，包括使⽤include指令插⼊的模板，使⽤assign指令创建和替换。
局部变量：在宏定义体中有效，使⽤local指令创建和替换。
循环变量：只能存在于指令的嵌套内容，由指令（如list）⾃动创建；宏的参数是局部变量，⽽不是循环变量
局部变量隐藏（⽽不是覆盖）同名的plain变量；循环变量隐藏同名的局部变量和plain变量，下⾯是⼀个例⼦：
<#assign x = "plain">
${x} <#-- we e 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 e 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 e 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
