一、什么是宏？

宏是在freemarker模板中使用macro指令定义。

二、宏的基本用法

宏是和某个变量关联的模板片断，以便在模板中通过用户定义的指令使用该变量，而该变量表示模板片段。

<#macro greet>     
     <font size="+2">Hello World!</font>     
</#macro>

调用宏时，与使用FreeMarker的其他指令类似，只是使用@替代FTL标记中的#：<@greet></@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宏的嵌套内容

FreeMarker的宏可以有嵌套内容，<#nested>指令会执行宏调用指令开始和结束标记之间的模板片断，举一个简单的例子：

<#macro border> 
    <table border=4 cellspacing=0 cellpadding=4>
    <tr>
    <td> 
        <#nested>
    </td>        
    </tr>
    </table> 
</#macro>

执行宏调用： <@border>Hello World!</@border>，输出结果：

<table border=4 cellspacing=0 cellpadding=4>
<tr>
<td> 
    Hello World!
</td>        
</tr>
</table>

4.1、<#nested>指令可以被多次调用，每次都会执行相同的内容。

<#macro do_thrice> 
    <#nested> 
    <#nested> 
    <#nested> 
</#macro>
   
<@do_thrice> 
    Anything. 
</@do_thrice>

输出结果：

Anything.
Anything.
Anything.

4.2、嵌套内容可以是有效的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> 
</td>
</tr>
</table>

4.3、宏定义中的局部变量对嵌套内容是不可见的，例如：

<#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>

输出结果：

test 3/1: ? ? ?
test 3/2: ? ? ?
test 3/3: ? ? ?

4.4、在宏定义中使用循环变量

nested指令也可以有循环变量（循环变量的含义见下节），调用宏的时候在宏指令的参数后面依次列出循环变量的名字，格式如下：

<@ 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> 
</@repeat>

这里count是宏的参数，c，halfc，last则为循环变量，输出结果：

  1. 0.5
  2. 1
  3. 1.5
  4. 2
    Last!