Velocity用户指南（四）

（7）#macro

 

#macro指令允许定义一段重复使用的VTL模板（称Velocimacros）。

 

l         Velocimacros可以有0或多个参数。下面是一个例子：

 

#macro( tablerows $color $somelist )
 

#foreach( $something in $somelist )
 

     $something
 

#end
 

#end
 

这个叫tablerows的Velocimacro带2个参数：一个color和一个array。下面的代码包含对

 

tablerows的调用：

 

#set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )
 

#set( $color = "blue" )
 

输出结果为：

 

 

   
   
Superior
Michigan
Huron
Erie
Ontario
 

l         Velocimacros可以在VTL模板中定义为inline，这样对其它的VTL模板是无效的；要使Velocimacros在所有VTL模板中共享，可以将Velocimacros定义在Velocimacros模板库（全局）中。

 

l         Velocimacros属性在velocity.properties文件中定义，提供实现Velocimacros的灵活性：

 

velocimacro.library = VM_global_library.vm
 

velocimacro.permissions.allow.inline = true
 

velocimacro.permissions.allow.inline.to.replace.global = false
 

velocimacro.permissions.allow.inline.local.scope = false
 

velocimacro.context.localscope = false
 

velocimacro.library.autoreload = false
 

velocimacro.library：定义逗号分隔的Velocimacros全局模板库，缺省是VM_global_library.vm，可以增加自定义的模板库；

 

velocimacro.permissions.allow.inline：指定是否允许在VTL模板中定义Velocimacros，缺省是true（允许）；

 

velocimacro.permissions.allow.inline.to.replace.global：指定是否允许inline定义的Velocimacros替换同名的全局Velocimacros，缺省是false（不允许）；

 

velocimacro.permissions.allow.inline.local.scope：指定inline定义是否是定义的模板中可见，缺省是false；

 

velocimacro.context.localscope：指定context内容是否是本地范围的，缺省是false；如果设为true，则使用#set指令对context做的修改只在本地范围有效，不会永久性的影响context；

 

velocimacro.library.autoreload：指定是否自动装载Velocimacros模板库，缺省是false；如果设为true，则在调用Velocimacros模板库中的Velocimacro时，会检查模板库是否更新，并在需要时重新装载；使用前提是file.resource.loader.cache = false；该属性应该在开发时使用，而不是产品阶段；

 

l         Velocimacros必须在第一次使用之前进行定义。因此#parse指令包含inline定义的Velocimacros的模板会有问题，简单的解决方法就是将Velocimacros定义到模板库中，以便Velocity启动时装载。

 

l         引用作为Velocimacros的参数时，是使用by name形式的，这意味在Velocimacros内部每次使用时才会获得其值

 

l         Velocimacros的不能作为参数传递给另一个Velocimacros，如：

 

#center( #bold("hello") ) ##invalid
 

你可以采用下面的形式达到同样的目的：

 

#center( "#bold( 'hello' )"  ) ##right
 

下面是一个嵌套调用的例子：

 

#macro( inner $foo )
 

  inner : $foo
 

#end
 

#macro( outer $foo )
 

   #set($bar = "outerlala")
 

   outer : $foo
 

#end
 

#set($bar = 'calltimelala')
 

#outer( "#inner($bar)" )
 

输出的结果是：Outer : inner : outerlala

因为参数以by name形式传递，在#outer内部先设置$bar的值，再调用#inner