java中Freemarker macro自定义指令详解

java Freemarker中macro可以用于实现自定义指令,通过使用自定义指令,可以将一段模板片段定义成一个用户指令。

定义

<#macro name param1 param2 ... paramN>
...
<#nested loopvar1, loopvar2, ..., loopvarN>
...
<#return>
...
</#macro>

name:指定的是该自定义指令的名字,使用自定义指令时可以传入多个参数

paramX:指定使用自定义指令时报参数,使用该自定义指令时,必须为这些参数传入值

nested:输出使用自定义指令时的中间部分

nested指令中的循环变量:这此循环变量将由macro定义部分指定,传给使用标签的模板

return:可用于随时结束该自定义指令.

例子

1. macro简单例子

<#macro test foo bar="Bar" baaz=-1>
Test 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 and the params: a, b, 23
Test and the params: a, b, -1
Test and the params: a, Bar, 23
Test and the params: a, Bar, -1

2. macro自定义循环输出的宏

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

3. macro包含nested的宏

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

执行输出：

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

4. macro定义输出html的自定义指令

//common.ftl 将一个HTML页面模板定义成一个page指令,则可以在其他页面中如此page指令
<#macro page title>
<html>
<head>
   <title>FreeMarker示例页面 - ${title?html}</title>
</head>
<body>
   <h1>${title?html}</h1>
   <#nested> //用于引入用户自定义指令的标签体
</body>
</html>
</#macro>

//引用自定义的page指令
<#import "/common.ftl" as com>
<@com.page title="book list">
<u1>
<li>spring</li>
<li>j2ee</li>
</ul>
</@com.page>

总结

1. macro是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量。

2. 在macro进行自定义指令中可以在宏变量之后定义参数，调用宏时，与使用FreeMarker的其他指令类似，只是使用@替代FTL标记中的#。