宏調用

#macro 腳本元素準許模板設計者定義一個可重用的VTL模板片段. Velocimacros(宏調用)被廣泛用在簡單和復雜的場景中.Velocimacro可以用來保存用戶的點擊次數和最少的板式錯誤, 提供一個簡單的概念介紹。

#macro( d )
<tr><td></td></tr>
#end

上個實例中Velocimacro被定義為d, 它可以像其他VTL方式一樣被調用:

#d()

當#d()被調用的時, Velocity將用定義的一行內容來替換#d().如果你想在行里面添加內容, 你也可以向下面這樣來改變macro的定義:

#macro( d )
<tr><td>$!bodyContent</td></tr>
#end

現在, 如果你想調用macro會和之前有點不同, 名字之前需要加上#@ 加上一個內容體,同時以#end調用, 當Velocity加載時遇見 $!bodyContent會進行顯示:

#@d()Hello!#end

如果你一直堅持像之前那種方式調用, 我們使用隱形的引用代替body引用($!bodyContent 代替$bodyContent), 它將一直顯示一個空的單元格.

Velocimacro也可以攜帶許多參數 — 甚至是不帶參數, 如同第一個實例中, 參數是可選項– 但是當Velocimacro執行時, 它必須調用和你定義的方法的參數匹配. 被執行的Velocimacros要多于上面定義的. 下面實例所示一個Velocimacro攜帶兩個參數一個是color和一個數組.

#macro( tablerows $color $somelist )
#foreach( $something in $somelist )
    <tr><td bgcolor=$color>$something</td></tr>
#end
#end

上面的Velocimacro實例中, 定義一個tablerows,帶兩個參數. 第一個參數是$color, 第二個參數是 $somelist.

任何可以被放到VTL模板中都可以作為Velocimacro的函數體.  tablerows 是Velocimacro的一個 foreach語句. 這里有兩個 #end語句被定義在#tablerows中; 第一個是屬于 #foreach, 第二個是屬于Velocimacro .

#set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )
#set( $color = "blue" )
<table>
    #tablerows( $color $greatlakes )
</table>

注意$greatlakes 代替 $somelist. 當 #tablerows被調用時, 將輸出以下內容:

<table>
    <tr><td bgcolor="blue">Superior</td></tr>
    <tr><td bgcolor="blue">Michigan</td></tr>
    <tr><td bgcolor="blue">Huron</td></tr>
    <tr><td bgcolor="blue">Erie</td></tr>
    <tr><td bgcolor="blue">Ontario</td></tr>
</table>

Velocimacros能夠定義在Velocity模板的行內，意味著在同一個網頁上它不可以使用其他的Velocity模板。定義一個Velocimacro并在所有模板中共享,這使它具有明顯的優勢: 它避免了在各個頁面中重復定義Velocimacro, 減少工作量并且可以避免錯誤, 這種也可以通過改變一個地方而達到其他地方一起修改的目的.

#tablerows($color $list) Velocimacro 被定義在 Velocimacros 模板的依賴包中, 它可以保證在其他地方被大量使用. 它能夠被多次重復使用來解決不同的問題. 在模板 mushroom.vm 中專注與正真的事情,#tablerows Velocimacro 能夠被遍歷,顯示所有部分:

#set( $parts = ["volva","stipe","annulus","gills","pileus"] )
#set( $cellbgcol = "#CC00FF" )
<table>
#tablerows( $cellbgcol $parts )
</table>

當你請求mushroom.vm, Velocity 將在模板依賴包中查詢#tablerows  (在 velocity.properties 定義的) 并輸出下面內容:

<table>
    <tr><td bgcolor="#CC00FF">volva</td></tr>
    <tr><td bgcolor="#CC00FF">stipe</td></tr>
    <tr><td bgcolor="#CC00FF">annulus</td></tr>
    <tr><td bgcolor="#CC00FF">gills</td></tr>
    <tr><td bgcolor="#CC00FF">pileus</td></tr>
</table>

Velocimacro ArgumentsVelocimacros可以攜帶下面的VTL元素作為參數 :

• Reference : anything that starts with ‘$’
• String literal : something like “$foo” or ‘hello’
• Number literal : 1, 2 etc
• IntegerRange : [ 1..2] or [$foo .. $bar]
• ObjectArray : [ “a”, “b”, “c”]
• boolean value true
• boolean value false

當傳遞一個引用作為Velocimacros的參數時,注意引用是通過名字傳遞的. 這意味著它們的值是在Velocimacro中已經生成了. 這個特性準許你傳遞一個方法的調用引用在方法中也可以使用方法調用. 例如, 當我們調用下面的Velocimacro將顯示

#macro( callme $a )
         $a $a $a
     #end

     #callme( $foo.bar() )

在方法中 bar() 的結果將被調用三次.

第一次看到這個特性會發現很驚奇, 當你仔細的思考Velocimacros背后的動機–消除VTL中公共的重復使用 –它變的有意義. 它準許你做一些事情,比如傳遞一個對象的狀態, 例如在Velocimacro中重復生成有顏色的表格對象.

如果你不想使用這個特性,你就想從一個引用的方法中獲取值,你可以這樣做 :

#set( $myval = $foo.bar() )
     #callme( $myval )

Velocimacro Properties在 velocity.properties 文件中準許靈活的實現Velocimacros. 這里也提供了開發者文檔Developer Guide.

velocimacro.library – 一個通用的和其他依賴包分開的 Velocimacro模板依賴包. 默認, Velocity看起來想一個單獨的 函數庫: VM_global_library.vm. 配置模板的路徑用來使用找到Velocimacro 函數庫.

velocimacro.permissions.allow.inline – 這個屬性的值可以是true或者false, 決定是否可以在模板中定義Velocimacros. 默認情況是, true, 準許模板設計者可以自行定義Velocimacros.

velocimacro.permissions.allow.inline.to.replace.global -它的值可以設定為true或者false, 這個設置準許用戶指定一個模板中定義的Velocimacro能代替全局定義, 它在啟動的時候被 velocimacro.library屬性加載. 默認是, false, 避免在啟動時候模板中定義的Velocimacros成為全局Velocimacros.

velocimacro.permissions.allow.inline.local.scope – 這個屬性可能值為true 或者 false, 默認為 false, 控制 定義的Velocimacros對定義中的模板是可見的.簡而言之, 如果這個屬性設置為 true, 一個模板能夠定義能夠被定義的模板使用的VMs內 . You can use this for fancy VM tricks – if a global VM calls another global VM, 在行內的作用域內, 一個模板能夠定義一個私有的實現第二個VM,它能被第一個VM調用. 但是對其他模板沒有影響.

velocimacro.library.autoreload – 這個屬性控制Velocimacro依賴包自動加載. 這個默認是的是false.當把屬性設置為 true,當Velocimacro被執行時它將檢查Velocimacro是否改變, 它重載很有必要的.它準許你改變和測試Velocimacro 不需要重慶你的應用和服務器容器, 僅僅像你可以用普通的模板. 這個模式需要關閉緩存才起作用(e.g.file.resource.loader.cache = false ). 這個特征主要用于開發模式, 而不是生產模式.

</div>

#set( $email = "foo" )
$email

## The following line defines $email in this template:
#set( $email = "foo" )
$email
\$email

foo
$email

## The following line defines $email in this template:
#set( $email = "foo" )
\\$email
\\\$email

\foo
\$email

$email
\$email
\\$email
\\\$email

$email
\$email
\\$email
\\\$email

#set( $foo = "gibbous" )
$moon = $foo

${my:invalid:non:reference}

#set( $D = '$' )
${D}{my:invalid:non:reference}

${esc.d}{my:invalid:non:reference}

## #include( "a.txt" ) renders as <contents of a.txt>
#include( "a.txt" )

## \#include( "a.txt" ) renders as #include( "a.txt" )
\#include( "a.txt" )

## \\#include ( "a.txt" ) renders as \<contents of a.txt>
\\#include ( "a.txt" )

#if( $jazz )
    Vyacheslav Ganelin
#end

Vyacheslav Ganelin

\#if( $jazz )
    Vyacheslav Ganelin
\#end

#if( true )
     Vyacheslav Ganelin
 #end

\\#if( $jazz )
   Vyacheslav Ganelin
\\#end

\ Vyacheslav Ganelin
\

\

\\\#if( $jazz )
    Vyacheslave Ganelin
\\#end

#set( $imperial = ["Munetaka","Koreyasu","Hisakira","Morikune"] )
#foreach( $shogun in $imperial )
    $shogun
#end

Send me #set($foo=["$10 and ","a pie"])#foreach($a in $foo)$a#end please.

Send me
#set( $foo = ["$10 and ","a pie"] )
#foreach( $a in $foo )
$a
#end
please.

Send me
#set($foo       = ["$10 and ","a pie"])
                 #foreach           ($a in $foo )$a
         #end please.

#set( $foo = $bar + 3 )
#set( $foo = $bar - 4 )
#set( $foo = $bar * 6 )
#set( $foo = $bar / 2 )

#set( $foo = $bar % 5 )

[n..m]

第一個實例:
#foreach( $foo in [1..5] )
$foo
#end

第二個實例:
#foreach( $bar in [2..-2] )
$bar
#end

第三個實例:
#set( $arr = [0..1] )
#foreach( $i in $arr )
$i
#end

第四個實例:
[1..3]

First example:
1 2 3 4 5

Second example:
2 1 0 -1 -2

Third example:
0 1

Fourth example:
[1..3]

#set( $foo = "bar" )
$\!foo
$\!{foo}
$\\!foo
$\\\!foo

$!foo
$!{foo}
$\!foo
$\\!foo

\$foo
\$!foo
\$!{foo}
\\$!{foo}

$foo
$!foo
$!{foo}
\bar

#set($stuff = "#bold('hello')" )
#center( $stuff )

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

#macro( inner $foo )
  inner : $foo
#end

#macro( outer $foo )
   #set($bar = "outerlala")
   outer : $foo
#end

#set($bar = 'calltimelala')
#outer( "#inner($bar)" )

Outer : inner : outerlala

#macro( foo $color )
  <tr bgcolor=$color><td>Hi</td></tr>
  <tr bgcolor=$color><td>There</td></tr>
#end

#foo( $bar.rowColor() )

#set($color = $bar.rowColor())
#foo( $color )

file.resource.loader.path = templates
    file.resource.loader.cache = false
    velocimacro.library.autoreload = true

#set( $size = "Big" )
       #set( $name = "Ben" )

      The clock is $size$name.

#set( $size = "Big" )
      #set( $name = "Ben" )

      #set($clock = "$size$name" )

      The clock is $clock.

#set( $size = "Big" )
      #set( $name = "Ben" )

      #set($clock = "${size}Tall$name" )

      The clock is $clock.