volecity语法

目 录
1.关于本指南... 3
2.语法参考... 3
1.变量定义... 3
2.访问属性... 3
命令调用... 3
3.动作指令... 3
1.#set – 建立变量对值的引用... 3
2.#if/#elseif/#else-条件判断... 4
3.#foreach---使用循环通过列表迭代对象... 5
4.#include – 在模板中引入本地文件，不用Velocity解析这个文件... 5
5.#parse – 在模板引用处使用Velocity解析另一个模板输出... 6
6.#stop – 中断模板解析... 6
7.#macro – 让用户可以定义宏操作(Velocimacro (VM):一组实现特定功能的VTL). 6
4.Comments 注解... 7
1.单行注解... 7
2.多行注解... 7
5.Feedback. 7




1.关于本指南
本文为Velocity的模板语言参考书,如需了解更多信息，请参见 Velocity User Guide.
2.语法参考
1.变量定义
变量名的有效字符集:
$ [ ! ][ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ][ } ]
Examples:
一般方式: $mud-Slinger_9
静态(输出原始字面): $!mud-Slinger_9
正规格式: ${mud-Slinger_9}
2.访问属性
格式规则:
$ [ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]* .[a..z, A..Z ][ a..z, A-Z, 0..9, -, _ ]* [ } ]
Examples:
一般格式: $customer.Address :调用customer对象的getAddress()命令.
正规格式: ${purchase.Total}
3.命令调用
格式规则:
$ [ { ][ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]* .[ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ]*( [ optional parameter list... ] ) [ } ]
Examples:
一般写码: $customer.getAddress()
正规写法: ${purchase.getTotal()}
传入调用参数: $page.setTitle( "My Home Page" )
VTL的属性调用可以理解为命令调用的简写方式,一般会调用对象的get/set命令.
3.动作指令
1.#set – 建立变量对值的引用
格式规则:
# [ { ] set [ } ] ( $ref = [ ", ' ]arg[ ", ' ] )
Examples:
变量引用: #set( $monkey = $bill )
引用原始字符串: #set( $monkey.Friend = 'monica' )
属性引用: #set( $monkey.Blame = $whitehouse.Leak )
命令引用: #set( $monkey.Plan = $spindoctor.weave($web) )
直接引用数字: #set( $monkey.Number = 123 )
列表赋值引用: #set( $monkey.Numbers = [1..3] )
对象数组: #set( $monkey.Say = ["Not", $my, "fault"] )
右值也可以做为一个表达式出现,如下加，减，cheng,除和取模:
Addition: #set( $value = $foo + 1 )
Subtraction: #set( $value = $bar - 1 )
Multiplication: #set( $value = $foo * $bar )
Division: #set( $value = $foo / $bar )
Remainder: #set( $value = $foo % $bar )
2.#if/#elseif/#else-条件判断
格式规则:
# [ { ] if [ } ] ( [条件表达式] ) [输出内容] [ # [ { ] elseif [ } ] ( [condition] ) [output] ]* [ # [ { ] else [ } ] [output] ] # [ { ] end [ } ]
Usage:
condition – 如果是boolean型，根据true或false决定,否则非null时认为是true.
output –可以包含VTL的输出内容.
Examples (showing different operators):
Operator Name Symbol Alternative Symbol Example
Equals Number == eq #if( $foo == 42 )
Equals String == eq #if( $foo == "bar" )
Object Equivalence == eq #if( $foo == $bar )
Not Equals != ne #if( $foo != $bar )
Greater Than > gt #if( $foo > 42 )
Less Than < lt #if( $foo < 42 )
Greater Than or Equal To >= ge #if( $foo >= 42 )
Less Than or Equal To <= le #if( $foo <= 42 )
Boolean NOT ! not #if( !$foo )

注意:
“== “操作可以用来比较数字，字符串，或同一个类的不同对象或不同类型的对象. 当是不同类的对象时，会调用它们的toString()命令结果来做比较看是否相等.
也可以如下用法，但注意else处，用{}括起.
#if( $foo == $bar)it's true!#{else}it's not!#end
3.#foreach---使用循环通过列表迭代对象
Format:
# [ { ] foreach [ } ] ($refinarg)statement# [ { ] end [ } ]
Usage:
$ref – 引用的要迭代的对象.
arg – 可能是:一个列表引用 (i.e. object array, collection, or map), an array list, 或其它列表.
statement – 当velocity发现下一个有效对像在列表中,输出可以是一个合法的VTL.
示例 #foreach()用法,:
引用: #foreach ( $item in $items )
数组列表: #foreach ( $item in ["Not", $my, "fault"] )
根据设定的界限: #foreach ( $item in [1..3] )
如下可以取得循环次数的当前值:

#foreach( $customer in $customerList )
$velocityCount $customer.Name

#end

默认的循环次数的引用变量名为 $velocityCount. 可以在配置文件velocity.properties中做如下修改成你想要的:
# Default name of the loop counter
# variable reference.
directive.foreach.counter.name = velocityCount

# Default starting value of the loop
# counter variable reference.
directive.foreach.counter.initial.value = 1
注意，可以对所有可循环的次数加一个最大值来控制，默认的是-1，表示元限制:
# The maximum allowed number of loops.
directive.foreach.maxloops = -1
4.#include – 在模板中引入本地文件，不用Velocity解析这个文件
Format:
# [ { ] include [ } ] ( arg[ arg2 ... argn] )
arg – 目录TEMPLATE_ROOT下面的有效文件名.
Examples:
直接写文件名: #include( "disclaimer.txt,"opinion.txt" ):如有多个文件时用逗号分开
使用变量引用的文件名: #include( $foo,$bar )
5.#parse – 在模板引用处使用Velocity解析另一个模板输出
Format:
# [ { ] parse [ } ] ( arg )
arg -目录TEMPLATE_ROOT下面的有效文件名.
Examples:
直接写文件名: #parse( "lecorbusier.vm" )
使用变量引用的文件名: #parse( $foo )
通过设置配置中的解析层次深度的最大值velocity.properties中项 parse_directive.maxdepth in可以防止死循环. (The default parse depth is 10.)
6.#stop – 中断模板解析
Format:
# [ { ] stop [ } ]
Usage:
在当前模板指令处停止解析，为方便调试用.
7.#macro – 让用户可以定义宏操作(Velocimacro (VM):一组实现特定功能的VTL)
Format:
# [ { ] macro [ } ] ( vmname $arg1 [ $arg2 $arg3 ... $argn ] ) [ VM VTL code... ] # [ { ] #end [ } ]
vmname – 宏名字 VM (#vmname)
$arg1 $arg2 [ ... ] – 要传给宏的参数VM..
[ VM VTL code... ] –宏代码，有效的VTL.
一次定义好了,就可以在其它模板的任何地方使用宏指令来应用.
#vmname( $arg1 $arg2 )
宏（VM）可以写在以下两个地方:
(模板库)Template library: 可以配置用户定义的库以便全站使用
Inline: 放入到一般的模板文件中, 仅当配置参数 velocimacro.permissions.allowInline=true 时生效.
4.Comments 注解
Comments不是运行时所必须的，但你一定要写.
1.单行注解
Example:
## This is a comment.
2.多行注解
Example:
#*
This is a multiline comment.
This is the second line
*#
5.Feedback
如果您有什么问题或建议，请联系 Velocity developers list. Thanks!

---------------------------------------------------ps-------------------------------------------------------------

1. 变量

(1)变量的定义：

#set($name = "hello") 说明：velocity中变量是弱类型的。

当使用#set 指令时，括在双引号中的字面字符串将解析和重新解释，如下所示：

#set($directoryRoot = "www" )

#set($templateName = "index.vm" )

#set($template = "$directoryRoot/$templateName" )

$template

输出将会是：www/index.vm

注：在velocity中使用$2.5这样的货币标识是没有问题得的，因为velocity中的变量总是以一个大写或者小写的字母开始的。

(2)变量规范的写法

${name} ，也可以写成：$name。提倡用前面的写法。

例如：你希望通过一个变量$vice来动态的组织一个字符串。

Jack is a $vicemaniac.

本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用规范的格式书写 ： Jack is a ${vice}maniac
现在Velocity知道变量是$vice而不是$vicemaniac。

注意：当引用属性的时候不能加{}

(3)变量的赋值:

$name="hello"

赋值的左边必须是一个变量或者是属性引用。右边可以是下面六种类型之一：

变量引用,字面字符串,属性引用,方法引用,字面数字,数组列表。

下面的例子演示了上述的每种类型：

#set( $monkey = $bill ) ## variable reference

#set( $monkey.Friend = "monica" ) ## string

#set( $monkey.Blame = $whitehouse.Leak ) ## property reference

#set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference

#set( $monkey.Number = 123 ) ##number

#set( $monkey.Say = ["Not", $my, "fault"] ) ## ArrayList

注意：①如果上述例子中的右值是null, 则左值不会被赋值，也就是说会保留以前的值。

②velocity模板中未被定义的变量将被认为是一个字符串。例如：

#set($foo = "gibbous")
$moon = $foo
输出结果为：
$moon = gibbous

③velocity模板中不会将reference解释为对象的实例变量。例如：$foo.Name将被解释为Foo对象的getName（）方法，而不是Foo对象的Name实例变量。例如：

$foo.getBar() 等同于$foo.Bar ；

$data.getUser("jon") 等同于$data.User("jon") ；

data.getRequest().getServerName() 等同于

$data.Request.ServerName等同于${data.Request.ServerName}



2. 循环

#foreach ($element in $list)
This is $element.
$velocityCount
#end

例子：

#set( $list = ["pine", "oak", "maple"])

#foreach ($element in $list)

$velocityCount

This is $element.

#end

输出的结果为：

1 This is pine.
2 This is oak.
3 This is maple.

每次循环$list中的一个值都会赋给$element变量。
$list可以是一个Vector、Hashtable或者Array。分配给$element的值是一个java对象，并且可以通过变量被引用。例如：如果$element t是一个java的Product类，并且这个产品的名字可以通过调用他的getName（）方法得到。

#foreach ( $key in $list.keySet())
Key: $key -> Value: $list.get($key)

#end

提示：velocity中大小写敏感。

Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。



例子：

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
上面三个例子的输出结果为：
First example：
1 2 3 4 5

Second example：
2 1 0 -1 -2

Third example：
0 1



3. 条件语句

#if (condition)

#elseif (condition)

#else

#end

4. 语句的嵌套

#foreach ($element in $list)

## inner foreach 内循环

#foreach ($element in $list)

This is $element. $velocityCount
inner


#end

## inner foreach 内循环结束

## outer foreach

This is $element.

$velocityCount
outer


#end

语句中也可以嵌套其他的语句，如#if…#else…#end等。

5. 注释
(1)单行注释：
## This is a single line comment.
(2)多行注释：
#*
Thus begins a multi-line comment. Online visitors won’t
see this text because the Velocity Templating Engine will
ignore it.
*#
(3)文档格式：
#**
This is a VTL comment block and
may be used to store such information
as the document author and versioning
information:
@version 1.1

@author xiao
*#

6. 关系和逻辑操作符

Velocity 也具有逻辑AND, OR 和 NOT 操作符。

如

## example for AND

#if($foo && $bar)

This AND that

#end

例子中#if() 指令仅在$foo 和$bar 斗为真的时候才为真。如果$foo 为假，则表达式也为假；并且 $bar 将不被求值。如果 $foo 为真，Velocity 模板引擎将继续检查$bar的值，如果 $bar 为真，则整个表达式为真。并且输出This AND that 。如果 $bar 为假，将没有输出因为整个表达式为假。

7.Velocity 中的宏

Velocity中的宏我们可以理解为函数。

①宏的定义

#macro(宏的名称 $参数1 $参数2 …)

语句体(即函数体)

#end

②宏的调用

#宏的名称($参数1 $参数2 …)

说明：参数之间用空格隔开。

8．#stop

停止执行模板引擎并返回,把它应用于debug是很有帮助的。

9．#include与#parse

#include和#parse的作用都是引入本地文件, 为了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目录下。

区别：

(1) 与#include不同的是，#parse只能指定单个对象。而#include可以有多个

如果您需要引入多个文件，可以用逗号分隔就行：
#include ("one.gif", "two.txt", "three.htm" )
在括号内可以是文件名，但是更多的时候是使用变量的：
#include ( “greetings.txt”, $seasonalstock )

(2) #include被引入文件的内容将不会通过模板引擎解析；

而#parse引入的文件内容Velocity将解析其中的velocity语法并移交给模板，意思就是说相当与把引入的文件copy到文件中。

#parse是可以递归调用的，例如：如果dofoo.vm包含如下行：

Count down.


#set ($count =

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

注意：在vm中使用#parse来嵌套另外一个vm时的变量共享问题。如：
->a.vm 里嵌套 b.vm；
->a.vm 里定义了变量 $param；
->b.vm 里可以直接使用$param，无任何限制。
但需要特别注意的是，如果b.vm里同时定义有变量$param，则b.vm里将使用b.vm里定义的值。

10．转义字符'\'的使用

如果reference被定义，两个’\’意味着输出一个’\’，如果未被定义，刚按原样输出。如：

#set($email = "foo" )

$email

\$email

\\$email

\\\$email

输出：

foo
$email
\foo
\$email

如果$email 未定义

$email

\$email

\\$email

\\\$email

输出：

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



11．内置对象
Velocity内置了一些对象，在vm模版里可以直接调用，列举如下：
$request、$response、$session，另外，模板内还可以使用 $msg内的消息工具访问 Struts 的国际化资源，达到简便实现国际化的方法。

12. 数组访问

对数组的访问在Velocity中存在问题，因为Velocity只能访问对象的方法，而数组又是一个特殊的Array，所以虽然数组可以进行循环列举，但却不能定位访问特定位置的元素，如 strs[2]，数组对固定位置元素的访问调用了Array的反射方法get(Object array, int index)，而Velocity没能提供这样的访问，所以数组要么改成List等其他类容器的方式来包装，要么就通过公用Util类的方式来提供，传入数组对象和要访问的位置参数，从而达到返回所需值的目的。




123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379 示例部分

1．Hello world的示例代码：

(1)Velocity模板(hello.html)

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<HTML>

<HEAD>

<TITLE> New Document </TITLE>

</HEAD>

<BODY>

    hello,$name!                 （注意：这里的name与VelocityTest.java中的名称要一致）

</BODY>

</HTML>

(2)将velocity模板的内容转换的类(VelocityTest.java)

import java.io.File;

import java.io.FileOutputStream;

import java.io.PrintWriter;

import java.io.Writer;

import org.apache.velocity.Template;

import org.apache.velocity.VelocityContext;

import org.apache.velocity.app.Velocity;

import org.apache.velocity.app.VelocityEngine;



/**

* Velocity转换

* @author

*/

public class VelocityTest

{

    /**

     * 主函数

     * @param args

     */

    public static void main(String[] args)

{

      //获取模板引擎

        VelocityEngine ve = new VelocityEngine();

        //模板文件所在的路径

        String path = "D:/java/jproject/regedit/webroot";      

        //设置参数

        ve.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path);

//处理中文问题

        ve.setProperty(Velocity.INPUT_ENCODING,"GBK");

        ve.setProperty(Velocity.OUTPUT_ENCODING,"GBK");

        try

        {

            //初始化模板

            ve.init();

            //获取模板(hello.html)

Velocity模板的名称

            Template template = ve.getTemplate("hello.html");   

            //获取上下文

            VelocityContext root = new VelocityContext();

            //把数据填入上下文

            root.put("name","world");                     （注意：与上面的对应）

//输出路径

            Strint outpath = "e:/helloworld.html";

            //输出

            Writer mywriter = new PrintWriter(new FileOutputStream(

                new File(outpath)));           

            template.merge(root, mywriter);

            mywriter.flush();          

        }

        catch (Exception e)

        {

            e.printStackTrace();

        }

    }

}

(3)环境的搭建

在lib目录内分别copy进：velocity-1.4.jar，velocity-dept.jar;

下载地址：http://jakarta.apache.org/velocity/

(4)运行后的结果如下：

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<HTML>

<HEAD>

<TITLE> New Document </TITLE>

</HEAD>

<BODY>

hello,world!

</BODY>

</HTML>



2．Servlet和Velocity结合示例

(1)example.html

<html>
  <head><title>Velocity</title></head>
  <body bgcolor="#ffffff">
    <center>
    <h2>Welcom to Velocity!</h2>
    <i>Here's the list of people</i>
    <table cellspacing="0" cellpadding="5" width="20%" >
    <tr>
    <td bgcolor="#eeeeee" align="center">
    Names：
    </td>
    </tr>
    #foreach ($name in $theList)
    <tr>
    <td bgcolor="#eeeeee" align="center">$name</td>
    </tr>
    #end
    </table>
    </center>
  </body>
</html>

(2)servlet

package com.koal.velocity;



import java.io.IOException;

import java.io.FileNotFoundException;

import java.util.ArrayList;

import java.util.Properties;

import java.util.Vector;

import javax.servlet.ServletConfig;

import javax.servlet.http.HttpServletRequest;

import javax.servlet.http.HttpServletResponse;

import org.apache.velocity.Template;

import org.apache.velocity.context.Context;

import org.apache.velocity.servlet.VelocityServlet;

import org.apache.velocity.app.Velocity;

import org.apache.velocity.exception.ResourceNotFoundException;

import org.apache.velocity.exception.ParseErrorException;



public class SampleServlet extends VelocityServlet 

{

    /**

     *   由VelocityServlet.init()调用，

     *   在此找出模版的路径

     */

    protected Properties loadConfiguration(ServletConfig config )

        throws IOException, FileNotFoundException {

        Properties p = new Properties();

        //取得路径

        String path = config.getServletContext().getRealPath("/");

        if (path == null)

        {

            System.out.println(" SampleServlet.loadConfiguration() : unable to "

                    + "get the current webapp root.  Using '/'. Please fix.");

            path = "/";

        }

        //设置路径

        p.setProperty( Velocity.FILE_RESOURCE_LOADER_PATH, path);

       

        return p;

    }

    /**

     *  Velocity主要的商业逻辑处理方法，由VelocityServlet自动调用

     *  @param ctx 模板上下文            

     *  @return Template 模板信息

     */  

    public Template handleRequest( HttpServletRequest request,

       HttpServletResponse response, Context ctx )

   {       

        //主要在此设置演示用的数据，开发中在此调用相应的业务处理流程，

        //并设置返回到页面的数据

        //待展示的列表数据
        String p1 = "第一位：LiuDong";
        String p2 = "第二位：Liang.xf";
        Vector personList = new Vector();
        //中文需要转换
        try {
            personList.addElement(new String(p1.getBytes(), "ISO-8859-1") );
            personList.addElement(new String(p2.getBytes(), "ISO-8859-1") );
        } catch (Exception e) {
            System.out.println("数据转换异常："+e);   
        }
        //设置数据，供页面模版替换成显示的数据
        ctx.put("theList", personList );  

        //定义模板       

        Template outty = null;       

        try

        {

            //取模板

            outty =  getTemplate("example.html");           

        }

        catch( ParseErrorException pee )

        {

            System.out.println("SampleServlet: parse error for template " + pee);

        }

        catch( ResourceNotFoundException rnfe )

        {

            System.out.println("SampleServlet: template not found " + rnfe);

        }

        catch( Exception e )

        {

            System.out.println("Error " + e);

        }

        return outty;

}



(3)在web.xml中的配置：

<web-app>

<servlet> 

       <servlet-name>SampleServlet</servlet-name>

       <servlet-class>com.koal.velocity.SampleServlet</servlet-class>

</servlet>

    <servlet-mapping>

       <servlet-name>SampleServlet</servlet-name>

       <url-pattern>/SampleServlet</url-pattern>

</servlet-mapping>

</web-app>

(4)环境的搭建

在lib目录内分别copy进：commons-collections.jar,velocity-1.4.jar，velocity-dept.jar;
    Tomcat运行环境正常。
    启动Tomcat，在IE上输入：http://localhost:8080/example，页面显示数据列表：

Here's the list of people

Names:

评论

1 楼 yyyyy5101 2009-08-06  

使用velocity格式化日期

在页面:$date.format('yyyy-MM-dd',$!travel.endDate)

配置文件： <bean id="viewResolver" class="org.springframework.

          ➥web.servlet.view.velocity.VelocityViewResolver">

  …

    <property name="dateToolAttribute">

      <value>dateTool</value>

    </property>

    <property name="numberToolAttribute">

      <value>numberTool</value>

    </property>

  </bean>