Velocity用戶手冊---中文版(學習修改版) 轉

Velocity的能力遠不止web站點開發這個領域，例如，它能夠從模板（template）產生SQL和PostScript、XML，它也能夠被當 做一個獨立工具來產生源代碼和報告，或者做爲其餘系統的集成組件使用。Velocity也能夠爲Turbine web開發架構提供模板服務（template service）。Velocity+Turbine提供一個模板服務的方式容許一個web應用以一個真正的MVC模型進行開發。

Velocity能爲咱們做什麼？
The Mud Store Example
假設你是一家專門出售Mud的在線商店的頁面設計人員，讓咱們暫且稱它爲「在線MUD商店」。大家的業務很旺，客戶下了各類類型和數量的mud訂單。他們 都是經過輸入用戶名和密碼後才登錄到你的網站，登錄後就容許他們查看訂單併購買更多的mud。如今，一種很是流行的mud正在打折銷售。另外有一些客戶規 律性的購買另一種也在打折可是不是很流行的Bright Red Mud，因爲購買的人並很少因此它被安置在頁面的邊緣。全部用戶的信息都是被跟蹤並存放於數據庫中的，因此某天有一個問題可能會冒出來：爲何不使用 velocity來使用戶更好的瀏覽他們感興趣的商品呢？
Velocity使得web頁面的客戶化工做很是容易。做爲一個web site的設計人員，你但願每一個用戶登錄時都擁有本身的頁面。
你會見了一些公司內的軟件工程師，你發現他們每一個人都贊成客戶應該擁有具備個性化的信息。那讓咱們把軟件工程師應該做的事情發在一邊，看一看你應該做些什 麼吧。

VTL意味着提供最簡單、最容易而且最整潔的方式合併頁面動態內容。
VTL使用references來在web site內嵌套動態內容，一個變量就是一種類型的reference。變量是某種類型的refreence，它能夠指向java代碼中的定義，或者從當前 頁面內定義的VTL statement獲得值。下面是一個VTL statement的例子，它能夠被嵌套到HTML代碼中：

#set ( $a = 「Velocity」 );

#set ( $a = 「Velocity」 );

和全部的VTL statement同樣，這個statement以＃字符開始而且包含一個directive：set。當一個在線用戶請求你的頁面時，Velocity Templating Engine將查詢整個頁面以便發現全部＃字符，而後肯定哪些是VTL statement，哪些不須要VTL做任何事情。
＃字符後緊跟一個directive：set時，這個set directive使用一個表達式（使用括號封閉）――一個方程式分配一個值給變量。變量被列在左邊，而它的值被列在右邊，最後他們之間使用＝號分割。
在上面的例子中，變量是$a，而它的值是Velocity。和其餘的references同樣以$字符開始，而值老是以雙引號封閉。Velocity中僅 有String能夠被賦值給變量。
記住如下的規則：
使用$字符開始的references用於獲得什麼；使用#字符開始的directives用於做些什麼。
Hello Velocity World!
一旦某個變量被分配了一個值，那麼你就能夠在HTML文件的任何地方引用它。在下面的例子中，一個值被分配給$foo變量，並在其後被引用。


#set ( $foo = 「Velocity」 )
Hello $foo World!


上面的實現結果是在頁面上打印「Hello Velocity World！」
爲了使包含VTL directives的statement更具備可讀性，咱們鼓勵你在新行開始每一個VTL statement，儘管你不是必須這麼做。Set directive將在後面詳細描述。
註釋
單行註釋：
## This is a single line comment.
多行註釋：
#*
   Thus begins a multi-line comment. Online visitors won’t
   see this text because the Velocity Templating Engine will
ignore it.
*#
文檔格式：
#**
   This is a VTL comment block and
   may be used to store such information
as the document author and versioning
   information:
   @version 5
   @author
*#

References
在VTL中有三種類型的references：變量(variables)、屬性(properties)、方法(methods)。做爲一個使用VTL 的頁面設計者，你和你的工程師必須就references的名稱達成共識，以便你能夠在你的template中使用它們。
Everything coming to and from a reference被做爲一個String對象處理。若是有一個對象$foo是一個Integer對象，那麼Velocity將調用它的 toString()方法將這個對象轉型爲String類型。
變量
格式要求同java。
屬性
例子：
    $customer.Address
    $purchase.Total
$customer.Address有兩種含義。它能夠表示：查找hashtable對象customer中以Address爲關鍵字的值；也能夠表示調 用customer對象的getAddress()方法。當你的頁面被請求時，Velocity將肯定以上兩種方式選用那種，而後返回適當的值。
方法
一個方法就是被定義在java中的一段代碼，而且它有完成某些有用工做的能力，例如一個執行計算和判斷條件是否成立、知足等。方法是一個由$開始並跟隨 VTL標識符組成的References，通常還包括一個VTL方法體。例如：
$customer.getAddress()
$purchase.getTotal()
$page.setTitle( 「My Home Page」 )
$person.setAttributes( [「Strange」, 「Weird」, 「Excited」] )
前兩個例子$customer.getAddress()和$purchase.getTotal()看起來挺想上面的屬 性$customer.Address 和 $purchase.Total。若是你以爲他們之間有某種聯繫的話，那你是正確的。
VTL屬性能夠做爲VTL方法的縮寫。$customer.Address屬性和使用$customer.getAddress()方法具備相同的效果。 若是可能的話使用屬性的方式是比較合理的。屬性和方法的不一樣點在於你可以給一個方法指定一個參數列表。
正式reference標記
reference的正是格式以下：
${mudSlinger}        變量
${customer.Address}    屬性
${purchase.getTotal()}    方法
非正是格式更見經常使用，可是有時仍是使用正是格式比較適合。例如：你但願經過一個變量$vice來動態的組織一個字符串。
Jack is a $vicemaniac.
原本變量是$vice如今卻變成了$vicemaniac，這樣Veloctiy就不知道您到底要什麼了。因此，應該使用正是格式書寫
Jack is a ${vice}maniac
如今Velocity知道變量是$vice而不是$vicemaniac。
Quiet reference notation
例如：

當頁面的form被初始加載時，變量$email尚未值，這時你確定是但願它可以顯示一個blank text來代替輸出」$email」這樣的字段。那麼使用quiet reference notation就比較合適。

這樣文本框的初始值就不會是email而是空值了。
正式和quiet格式的reference notation也可一同使用，像下面這樣：

Getting literal
Velocity使用特殊字符$和#來幫助它工做，因此若是要在template裏使用這些特殊字符要格外當心。本節將討論$字符。
貨幣字符
在VTL中使用$2.5這樣的貨幣標識是沒有問題得的，VTL不會將它錯認爲是一個reference，由於VTL中的reference老是以一個大寫 或者小寫的字母開始。
Escaping valid VTL reference
VTL中使用「\」做爲逃逸符。
例如：
#set( $email = 「foo」 )
$email
\$email
\\$email
\\\$email
將render爲：
foo
$email
\foo
\\$email
若是email變量沒有被定義則
$email
\$email
\\$email
\\\$email
將被render爲：
$email
\$email
\\$email
\\\$email
注意：VTL中未被定義的變量將被認爲是一個字符串，因此如下例子：
#set( $foo = 「gibbous」 )
$moon = $foo
的輸出結果是：
$moon = gibbous
Case substitution
如今你已經對reference比較熟悉了，你能夠將他們高效的應用於你的template了。Velocity利用了不少java規範以方便了設計人員 的使用。例如：
$foo
$foo.getBar()
## is the same as
$foo.Bar

$data.getUser(「jon」)
## is the same as
$data.User(「jon」)

$data.getRequest().getServerName()
# is the same as
$data.Request.ServerName
## is the same as
${data.Request.ServerName}
可是，注意VTL中不會將reference解釋爲對象的實例變量。例如：$foo.Name將被解釋爲Foo對象的getName（）方法，而不是 Foo對象的Name實例變量。
Directives
Reference容許設計者使用動態的內容，而directive使得你能夠應用java代碼來控制你的顯示邏輯，從而達到你所指望的顯示效果。
#set
#set directive被用於設置一個reference的值。例如：
    #set ( $primate = 「monkey」 )
    #set ( $customer.Behavior = $primate )
賦值左側的（LHS）必須是一個變量或者屬性reference。右側（RHS）能夠是如下類型中一種：
l 變量reference
l String literal
l 屬性reference
l 方法reference
l number literal
l ArrayList
下面是應用各類類型的RHS的例子：
＃set ( $monkey = $bill ) ##變量reference
＃set ( $monkey.Friend = 「monica」 ) ##String literal
＃set ( $monkey.Blame = $whitehouse.Leak )##屬性reference
＃set ( $monkey.Plan = $spindoctor.weave($web) )##方法reference
＃set ( $monkey.Number = 123 )##Number literal
＃set ( $monkey.Say = [「Not」, $my, 「fault」] )##ArrayList
注意：最後一個例子的取值方法爲：$monkey.Say.get(0)
RHS也能夠是一個簡單的算術表達式：
#set ( $value = $foo + 1 )
#set ( $value = $bar -1 )
#set ( $value = $foo * $bar )
#set ( $value = $foo / $bar )
若是你的RHS是一個null，VTL的處理將比較特殊：它將指向一個已經存在的reference，這對初學者來說多是比較費解的。例如：
#set ( $resut = $query.criteria(「name」) )
The result of the first query is $result

#set ( $resut = $query.criteria(「address」) )
The result of the second query is $result
若是$query.criteria(「name」)返回一個「bill」，而$query.criteria(「address」)返回的是null， 則顯示的結果以下：
The result of the first query is bill
The result of the first query is bill
看看下面的例子：
#set( $criteria = ["name", "address"] )
#foreach( $criterion in $criteria )
#set( $result = $query.criteria($criterion) )
#if( $result )
Query was successful
     #end
#end
在上面的例子中，程序將不能智能的根據$result的值決定查詢是否成功。在$result被#set後（added to the context），它不能被設置回null（removed from the context）。打印的結果將顯示兩次查詢結果都成功了，可是實際上有一個查詢是失敗的。
爲了解決以上問題咱們能夠經過預先定義的方式：
#set( $criteria = [「name」, 「address」] )
#foreach( $criterion in $criteria )
    #set( $result = false )
    #set( $result = $query.criteria( $criterion ) )
    #if( $result )
      Query was successful
    #end
#end
String Literals
當你使用#set directive，String literal封閉在一對雙引號內。
    #set ( $directoryRoot = 「www」 )
    #set ( $templateName = 「index.vm」 )
    #set ( $template = 「$directoryRoot/$tempateName」 )
    $template
上面這段代碼的輸出結果爲：www/index.vm
可是，當string literal被封裝在單引號內時，它將不被解析：
    #set ( $foo = 「bar」 )
    $foo
    #set ( $blargh = ‘$foo’ )
結果：
    bar
    $foo
上面這個特性能夠經過修改velocity.properties文件的stringliterals.interpolate = false的值來改變上面的特性是否有效。
條件語句
if/elseif/else
當一個web頁面被生成時使用Velocity的#if directrive，若是條件成立的話能夠在頁面內嵌入文字。例如：
#if ( $foo )
    Velocity!
#end
上例中的條件語句將在如下兩種條件下成立：
l $foo是一個boolean型的變量，且它的值爲true
l $foo變量的值不爲null
這裏須要注意一點：Velocity context僅僅可以包含對象，因此當咱們說「boolean」時實際上表明的時一個Boolean對象。即使某個方法返回的是一個boolean 值，Velocity也會利用內省機制將它轉換爲一個Boolean的相同值。
若是條件成立，那麼#if和#end之間的內容將被顯示。
#elseif和#else元素能夠同#if一同使用。例如：
#if( $foo < 10 )
    Go North
#elseif( $foo == 10 )
    Go East
#elseif( $foo == 6 )
    Go South
#else
    Go West
#end
注意這裏的Velocity的數字是做爲Integer來比較的――其餘類型的對象將使得條件爲false，可是與java不一樣它使用「＝＝」來比較兩個 值，並且velocity要求等號兩邊的值類型相同。
關係、邏輯運算符
Velocity中使用等號操做符判斷兩個變量的關係。例如：
#set ( $foo = 「deoxyribonucleic acid」 )
#set ( $bar = 「ribonucleic acid」 )
#if ( $foo == $foo )
In this case it’s clear they aren’t equivalent.So…
#else
They are not equivalent and this will be the output.
#end

Velocity有AND、OR和NOT邏輯運算符。下面是一些例子：
## logical AND
#if( $foo && $bar )
    This AND that
#end

## logical OR
#if ( $foo || $bar )
    This OR That
#end

##logical NOT
#if ( !$foo )
    NOT that
#end
循環
Foreach循環
例子：
   

      #foreach ( $product in $allProducts )
       
• $product

      #end
   

每次循環$allProducts中的一個值都會賦給$product變量。
$allProducts能夠是一個Vector、Hashtable或者Array。分配給$product的值是一個java對象，而且能夠經過變量 被引用。例如：若是$product是一個java的Product類，而且這個產品的名字能夠經過調用他的getName（）方法獲得。
如今咱們假設$allProducts是一個Hashtable，若是你但願獲得它的key應該像下面這樣：

#foreach ( $key in $allProducts.keySet() )

• Key: $key -> Value: $allProducts.get($key)

#end

Velocity還特別提供了獲得循環次數的方法，以便你能夠像下面這樣做：




#foreach ( $customer in $customerList ) #end

$velocityCount

$customer.Name

$velocityCount變量的名字是Velocity默認的名字，你也能夠經過修改velocity.properties文件來改變它。默認狀況 下，計數從「1」開始，可是你能夠在velocity.properties設置它是從「1」仍是從「0」開始。下面就是文件中的配置：
# Default name of loop counter
# variable reference
directive.foreach.counter.name = velocityCount

# Default starting value of the loop
# counter variable reference
directive.foreach.counter.initial.value = 1

include
#include script element容許模板設計者引入本地文件。被引入文件的內容將不會經過模板引擎被render。爲了安全的緣由，被引入的本地文件只能在 TEMPLATE_ROOT目錄下。
#inclued ( 「one.txt」 )
若是您須要引入多個文件，能夠用逗號分隔就行：
#include ( 「one.gif」, 「two.txt」, 「three.htm」 )
在括號內能夠是文件名，可是更多的時候是使用變量的：
#inclue ( 「greetings.txt」, $seasonalstock )

parse
#parse script element容許模板設計者一個包含VTL的本地文件。Velocity將解析其中的VTL並render模板。
#parse( 「me.vm」 )
就像#include，#parse接受一個變量而不是一個模板。任何由#parse指向的模板都必須包含在TEMPLATE_ROOT目錄下。 與#include不一樣的是，#parse只能指定單個對象。
你能夠經過修改velocity.properties文件的parse_direcive.maxdepth的值來控制一個template能夠包含的 最多#parse的個數――默認值是10。#parse是能夠遞歸調用的，例如：若是dofoo.vm包含以下行：
Count down.
#set ( $count = 8 )
#parse ( 「parsefoo.vm」 )
All done with dofoo.vm!
那麼在parsefoo.vm模板中，你能夠包含以下VTL：
$count
#set ( $count = $count – 1 )
#if ( $count > 0 )
    #parse( 「parsefoo.vm」 )
#else
    All done with parsefoo.vm!
#end
的顯示結果爲：
Count down.
8
7
6
5
4
3
2
1
0
All done with parsefoo.vm!
All done with dofoo.vm!

Stop
#stop script element容許模板設計者中止執行模板引擎並返回。把它應用於debug是頗有幫助的。
#stop

Velocimacros
#macro script element容許模板設計者定義一段可重用的VTL template。例如：
#macro ( d )

#end
在上面的例子中Velocimacro被定義爲d，而後你就能夠在任何VTL directive中以以下方式調用它：
#d()
當你的template被調用時，Velocity將用替換 爲#d()。
每一個Velocimacro能夠擁有任意數量的參數――甚至0個參數，雖然定義時能夠隨意設置參數數量，可是調用這個Velocimacro時必須指定正 確的參數。下面是一個擁有兩個參數的Velocimacro，一個參數是color另外一個參數是array：
#macro ( tablerows $color $somelist )
#foreach ( $something in $somelist )
    $something
#end
#end
調用#tablerows Velocimacro：
#set ( $greatlakes = [ 「Superior」, 「Michigan」, 「Huron」, 「Erie」, 「Ontario」 ] )
#set ( $color = 「blue」 )


    #tablerows( $color $greatlakes )
通過以上的調用將產生以下的顯示結果：






                   

Superior

Michigan

Huron

Erie

Ontario

Velocimacros能夠在Velocity模板內實現行內定義（inline），也就意味着同一個web site內的其餘Velocity模板不能夠得到Velocimacros的定義。定義一個能夠被全部模板共享的Velocimacro顯然是有不少好處 的：它減小了在一大堆模板中重複定義的數量、節省了工做時間、減小了出錯的概率、保證了單點修改。
上面定義的#tablerows( $color $list )Velocimacro被定義在一個Velocimacros模板庫(在velocity.properties中定義)裏，因此這個macro能夠在 任何規範的模板中被調用。它能夠被屢次應用而且能夠應用於不一樣的目的。例以下面的調用：
#set ( $parts = [ 「volva」, 「stipe」, 「annulus」, 「gills」, 「pileus」 ] )
#set ( $cellbgcol = 「#CC00FF」 )


    #tablerows( $cellbgcol $parts )
上面VTL將產生以下的輸出：

   

volva

stipe

annulus

gills

pileus

Velocimacro arguments
Velocimacro可使用如下任何元素做爲參數：
l Reference：任何以$開頭的reference
l String literal：
l Number literal：
l IntegerRange：[1….3]或者[$foo….$bar]
l 對象數組：[「a」,」b」,」c」]
l boolean值：true、false
當將一個reference做爲參數傳遞給Velocimacro時，請注意reference做爲參數時是以名字的形式傳遞的。這就意味着參數的值在每 次Velocimacro內執行時纔會被產生。這個特性使得你能夠將一個方法調用做爲參數傳遞給Velocimacro，而每次Velocimacro執 行時都是經過這個方法調用產生不一樣的值來執行的。例如：
#macro ( callme $a )
    $a $a $a
#end
#callme( $foo.bar() )
執行的結果是：reference $foo的bar（）方法被執行了三次。
若是你不須要這樣的特性能夠經過如下方法：
#set ( $myval = $foo.bar() )
#callme ( $myval )

Velocimacro properties
Velocity.properties文件中的某幾行可以使Velocimacros的實現更加靈活。注意更多的內容能夠看Developer Guide。
Velocity.properties文件中的velocimacro.libraary：一個以逗號分隔的模板庫列表。默認狀況下，velocity 查找惟一的一個庫：VM_global_library.vm。你能夠經過配置這個屬性來指定本身的模板庫。
Velocity.properties文件中的velocimacro.permissions.allow.inline屬性：有兩個可選的值 true或者false，經過它能夠肯定Velocimacros是否能夠被定義在regular template內。默認值是ture――容許設計者在他們本身的模板中定義Velocimacros。
Velocity.properties文件中的
velocimacro.permissions.allow.inline.replace.global屬性有兩個可選值true和false，這個 屬性容許使用者肯定inline的Velocimacro定義是否能夠替代全局Velocimacro定義（好比在 velocimacro.library屬性中指定的文件內定義的Velocimacro）。默認狀況下，此值爲false。這樣就阻止本地 Velocimacro定義覆蓋全局定義。
Velocity.properties文件中的
velocimacro.permissions.allow.inline.local.scale屬性也是有true和false兩個可選值，默認是 false。它的做用是用於肯定你inline定義的Velocimacros是否僅僅在被定義的template內可見。換句話說，若是這個屬性設置爲 true，一個inline定義的Velocimacros只能在定義它的template內使用。你可使用此設置實現一個奇妙的VM敲門：a template can define a private implementation of the second VM that will be called by the first VM when invoked by that template. All other templates are unaffected。
Velocity.properties文件中的velocimacro.context.localscope屬性有true和false兩個可選值， 默認值爲false。當設置爲true時，任何在Velocimacro內經過#set()對context的修改被認爲是針對此velocimacro 的本地設置，而不會永久的影響內容。
Velocity.properties文件中的velocimacro.library.autoreload屬性控制Velocimacro庫的自動 加載。默認是false。當設置爲ture時，對於一個Velocimacro的調用將自動檢查原始庫是否發生了變化，若是變化將從新加載它。這個屬性使 得你能夠不用從新啓動servlet容器而達到從新加載的效果，就像你使用regular模板同樣。這個屬性可使用的前提就是resource loader緩存是off狀態（file.resource.loader.cache = false）。注意這個屬性其實是針對開發而非產品的。
Velocimacro Trivia
Velocimacro必須被定義在他們被使用以前。也就是說，你的#macro()聲明應該出如今使用Velocimacros以前。
特別要注意的是，若是你試圖#parse()一個包含#macro()的模板。由於#parse()發生在運行期，可是解析器在parsetiem決定一 個看似VM元素的元素是不是一個VM元素，這樣#parse()-ing一組VM聲明將不按照預期的樣子工做。爲了獲得預期的結果，只須要你簡單的使用 velocimacro.library使得Velocity在啓動時加載你的VMs。
Escaping VTL directives
VTL directives can be escaped with 「\」號，使用方式跟VTL的reference使用逃逸符的格式差很少。
## #include( 「a.txt」 ) renders as (註釋行)
#include( 「a.txt」 )

## \#include( 「a.txt」 ) renders as \#include( 「a.txt」 )
\#include( 「a.txt」 )

## \\#include ( 「a.txt」 ) renders as \
\\#include( 「a.txt」 )
在對在一個directive內包含多個script元素的VTL directives使用逃逸符時要特別當心（好比在一個if-else-end statement內）。下面是VTL的if-statement的典型應用：
#if ( $jazz )
    Vyacheslav Ganelin
#end
若是$jazz是ture，輸出將是：
Vyacheslav Ganelin
若是$jazz是false，將沒有輸出。使用逃逸符將改變輸出。考慮一下下面的狀況：
\#if ( $jazz )
    Vyacheslav Ganelin
\#end
如今不管$jazz是true仍是false，輸出結果都是：
#if ( $jazz )
    Vyacheslav Ganelin
#end
事實上，因爲你使用了逃逸符，$jazz根本就沒有被解析爲boolean型值。在逃逸符前使用逃逸符是合法的，例如：
\\#if ( $jazz )
    Vyacheslav Ganelin
\\#end
以上程序的顯示結果爲：
\ Vyacheslav Ganelin
\
可是若是$jazz爲false，那麼將沒有輸出。（書上說會沒有輸出，可是我以爲應該還有有「\」字符被輸出。）
VTL：Formatting issues
儘管在此用戶手冊中VTL一般都開始一個新行，以下所示：
#set ( $imperial = [ 「Munetaka」, 「Koreyasu」, 「Hisakira」, 「Morikune」 ] )
#foreach ( $shogun in $imperial )
    $shogun
#end
可是像下面這種寫法也是能夠的：
Send me #set($foo = [「$10 and」,」a cake」])#foreach($a in $foo)$a #end please.
上面的代碼能夠被改寫爲：
Send me
#set ( $foo = [「$10 and 「,」a cake」] )
#foreach ( $a in $foo )
    $a
#end
please.
或者
Send me
#set($foo = [「$10 and 「,」a cake」])
        #foreach （$a in $foo ）$a
      #end please.
這兩種的輸出結構將同樣。
其餘特性和雜項
math   在模板中可使用Velocity內建的算術函數，如：加、減、乘、除
    #set ( $foo = $bar + 3 )
    #set ( $foo = $bar - 4 )
    #set ( $foo = $bar * 6 )
    #set ( $foo = $bar / 2 )
當執行除法時將返回一個Integer類型的結果。而餘數你可使用%來獲得：
    #set ( $foo = $bar % 5 )
在Velocity內使用數學計算公式時，只能使用像-n,-2,-1,0,1,2,n這樣的整數，而不能使用其它類型數據。當一個非整型的對象被使用時 它將被logged而且將以null做爲輸出結果。
Range Operator
Range operator能夠被用於與#set和#foreach statement聯合使用。對於處理一個整型數組它是頗有用的，Range operator具備如下構造形式：
[n..m]
m和n都必須是整型，而m是否大於n則可有可無。例子：
First example:
#foreach ( $foo in [1..5] )
    $foo
#end

Second example:
#foreach ( $bar in [2..-2] )
    $bar
#end

Third example:
#set ( $arr = [0..1] )
#foreach ( $i in $arr )
    $i
#end

Fourth example:
[1..3]
上面四個例子的輸出結果爲：
First example：
1 2 3 4 5

Second example：
2 1 0 -1 -2

Third example：
0 1

Fourth example：
[1..3]
注意：range operator只在#set和#foreach中有效。
Advanced Issue：Escaping and！
當一個reference被「！」分隔時，而且在它以前有逃逸符時，reference將以特殊的方式處理。注意這種方式與標準的逃逸方式時不一樣的。對照 以下：
#set ( $foo = 「bar」 )
特殊形式 標準格式
Render前 Render後 Render前 Render後
$\!foo $!foo \$foo \$foo
$\!{foo} $!{foo} \$!foo \$!foo
$\\!foo $\!foo \$!{foo} \$!{foo}
$\\\!foo $\\!foo \\$!{foo} \bar
Velocimacro雜記
Can I user a directive or another VM as an argument to a VM?
例如：#center ( #bold( 「hello」 ) )
不能夠。一個directive的參數使用另一個directive是不合法的。
可是，仍是有些事情你能夠做的。最簡單的方式就是使用雙引號：
    #set ( $stuff = 「#bold( ‘hello’ )」 )
    #center ( $stuff )
上面的格式也能夠縮寫爲一行：
    #center ( 「#bold( ‘hello’ ) )
請注意在下面的例子中參數被evaluated在Velocimacro內部，而不是在calling level。例子：
#macro ( inner $foo )
    inner : $foo
#end

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

#set ( $bar = ‘calltimelala’ )
#outer( 「#inner($bar)」 )
輸出結果爲：
outer : inner : outerlala
記住Veloctiy的特性：參數的傳遞是By Name的。例如：
#macro ( foo $color )
    Hi
    There
#end

#foo ( $bar.rowColor() )
以上代碼將致使rowColor()方法兩次調用，而不是一次。爲了不這種現象的出現，咱們能夠按照下面的方式執行：
#set ( $color = $bar.rowColor() )
#foo ( $color )
can I register velocimacros via #parse()?
目前，Velocimacros必須在第一次被模板調用前被定義。這就意味着你的#macro()聲明應該出如今使用Velocimacros以前。
若是你試圖#parse()一個包含#macro() directive的模板，這一點是須要牢記的。由於#parse()發生在運行期，可是解析器在parsetiem決定一個看似VM元素的元素是不是一 個VM元素，這樣#parse()-ing一組VM聲明將不按照預期的樣子工做。爲了獲得預期的結果，只須要你簡單的使用 velocimacro.library使得Velocity在啓動時加載你的VMs。
What is velocimacro autoreloading？
velocimacro.library.autoreload是專門爲開發而非產品使用的一個屬性。此屬性的默認值是false。
String concatenation
開發人員最常問的問題是我如何做字符拼接？在java中是使用「＋」號來完成的。
在VTL裏要想實現一樣的功能你只須要將須要聯合的reference放到一塊兒就好了。例如：
#set ( $size = 「Big」 )
#set ( $name = 「Ben」 )
The clock is $size$name.
輸出結果將是：The clock is BigBen.。更有趣的狀況是：
#set ( $size = 「Big」 )
#set ( $name = 「Ben」 )
#set ( $clokc = 「$size$name」 )
The clock is $clock.
上例也會獲得一樣的結果。最後一個例子，當你但願混合固定字段到你的reference時，你須要使用標準格式：
#set ( $size = 「Big」 )
#set ( $name = 「Ben」 )
#set ( $clock = 「${size}Tall$name」 )
The clock is $clock.
輸出結果是：The clock is BigTallBen.。使用這種格式主要是爲了使得$size不被解釋爲$sizeTall。

asdtiang 2010-01-12 18:01 發表評論