freemarker Macro使用小记

现在项目中不少的地方都用到的freemarker，但是自己一直都是调用别人已经写好的Macro，没怎么过多的去关注它，近期在开发一个新的功能的时候自己终于有机会来写了。

引用

我这个Macro主要是用于数据的分页功能。

一、Macro介绍
Macro又叫宏，宏是在模板中使用macro指令定义
1、基本用法
宏是和某个变量关联的模板片断，以便在模板中通过用户定义指令使用该变量，下面是一个例子：
macro代码

<#--
	UNT列表Macro
	orderBy：排序方式。【0：留言时间从新到旧；1：留言时间从旧到新；】（默认0）

	firstResult：第一条记录。（默认0）
	count：记录数。（默认20）
	isPage：是否分页。【0：不分页；1：分页】（默认0）
	pageNo：页号。（默认当前页）

	cssClass：容器class
	cssStyle：容器style
	
	style：标签内部样式。如果指定sysContent或userContent，则该项无效。【1：普通列表；】（默认1）
	
	inner：是否使用标签中直接编写html代码。【0：否；1：是】（默认0）
	isLoop：内容是否循环。【0：不循环；1：循环】（默认1）
	
	sysTpl：使用系统模板。【0：不使用；1：使用】（默认1）
	sysContent：系统内容样式。（默认0）
	userContent：自定义内容文件名。如果指定了系统内容样式，则该项无效。（默认空）
	sysPage：系统分页样式。【0：不分页；1：样式一；2：样式二】（默认0）
	userPage：自定义分页样式文件名。如果指定了系统分页样式，则该项无效。（默认空）
	custom：字符串数组。用于个性化处理。（默认空数组）
-->
<#macro UntList method="/jsca/tag/unt" untId="" orderBy="0"
	isPage="1" count="6" firstResult="0" pageNo=pageNo
	style="1" inner="0" isLoop="1" sysTpl="1" cssClass="" cssStyle="" custom=[]
	sysContent="0" userContent="" sysPage="0" userPage="">
<#if inner=="0">
	<@s.action name="UntList" namespace=method executeResult="true"
		untId=untId orderBy=orderBy
		isPage=isPage count=count firstResult=firstResult pageNo=pageNo
		style=style sysTpl=sysTpl cssClass=cssClass cssStyle=cssStyle custom=custom
		sysContent=sysContent userContent=userContent sysPage=sysPage userPage=userPage
		/>
<#else>
	<@s.action name="UntList" namespace="/jsca/tag/unt" executeResult="false"
		ctgId=ctgId recommend=recommend orderBy=orderBy
		isPage=isPage count=count firstResult=firstResult pageNo=pageNo
		/>
	<#if isLoop=="1">
  		<#list n_pagination.list as item>
			<#nested item,item_index,item_has_next/>
		</#list>
	<#else>
		<#nested n_pagination/>
	</#if>
</#if>
</#macro>

在这里我定义了一个叫"UntList"的Macro，其中有2个地方值得注意下：
a."method"属性与我在struts2的配置文件中定义的一个"namespace"值一直即可，其他的属性都是作为分页的一些辅助属性可以自行修改。
b."<@s.actioin>"这个是调用的struts2的标签，"name"属性对于的Macro的名称，"namespace=method"这个很明了，将在Macro里面定义的"method"属性的值赋值给"namespace"。

struts2.xml配置

<package name="front.untManager" namespace="/jsca/tag/unt" extends="tag-default">
		<action name="UntList" method="untList" class="unt.untPartAct">
			<result>${tplPath}</result>			
		</action>
</package>

namespace="/jsca/tag/unt":对应macro的值
extends="tag-default":自定义的一个标签拦截器

二、调用Macro

调用宏时，与使用FreeMarker的其他指令类似，只是使用@替代FTL标记中的#。

[@cms.UntList isPage='1' sysPage='7'  count='8' sysTpl='0'/]  

运行完后就会将数据进行已每8条一页的进行分页显示。