Velocity 语法示例

一、简介： 

 

1)它允许任何人使用简单而强大的模板语言来引用定义在 java 代码中的对象"
2)Velocity是一个基于java的模板引擎，简称VTL(Velocity Template Language)。
3)主要目的是弥补JSP的不足，把页面设计从繁重的java编码中解脱出来。
4)使用新颖的语法格式，简洁、高效。
5)语法虽然不完全类似于java但也基于面向对象的语法规范。
5)它很容易集成在各种各样的程序领域中。
5)它为网页制作人员提供了一种清晰而又简单的语法
5)因为模板和代码是分离的，所以你可以分别独立的开发和维护它们。
5)Velocity 引擎可以很容易的集成到一些 Java 运行环境，特别是 Servlet.
5)Velocity 使得模板可以访问任何环境对象中的共有方法。

Velocity 最擅长做哪些方面的工作呢？
1： 基于 servlet 的网站制作
2： Java 和 Sql 代码生成
3： XML 处理和转换
4： 文字处理，比如生成 TRF 文件。

 

Velocity 的强大之处在于它严格的区分程序开发功能的职责划分。 它限制模板可能访问的 
对象（也就是后台程序允许它得到的对象）来实现这一点。这意味着，网页设计人员可以只 
把精力放在数据的显示部分（View 视图）而程序员则只要关注如何写好程序的控制层 
（Controller,控制器）和商业逻辑和数据管理（模型 Model）, 这就是 MVC 开发模式。MVC 
现在已经是广泛接受的一种开发模式，它简化了开发和日益复杂的应用和维护工作。 
它允许web 页面设计者引用JAVA代码预定义的方法。Web 设计者可以根据MVC模式和JAVA程序员并行工作，这意味着Web设计者可以单独专注于设计良好的站点，而程序员则可单独专注于编写底层代码。Velocity 将Java 代码从web页面中分离出来，使站点在长时间运行后仍然具有很好的可维护性，并提供了一个除JSP和PHP之外的可行的被选方案。 
Velocity可用来从模板产生web 页面，SQL, PostScript以及其他输出。他也可用于一个独立的程序以产生源代码和报告，或者作为其它系统的一个集成组件。这个项目完成后，Velocity将为Turbine web 应用程序框架提供模板服务。Velocity+Turbine 方案提供的模板服务将允许web 应用按真正的mvc模式进行开发。 

 

Velocity 真正的工作原理：

 Velocity 解决了如何在 Servlet 和 网页之间传递数据的问题，当然这种传输数据的机制是
在 MVC 模式上进行的，也就是View 和 Modle , Controller 之间相互独立工作，一方的修
改不影响其他方变动，他们之间是通过环境变量（Context）来实现的，当然双方网页制作
一方和后台程序一方要相互约定好对所传递变量的命名约定，比如上个程序例子中的 site, 
name 变量，它们在网页上就是 $name ,$site 。 这样只要双方约定好了变量名字，那么双
方就可以独立工作了。 无论页面如何变化，只要变量名不变，那么后台程序就无需改动，
前台网页也可以任意由网页制作人员修改。这就是 Velocity 的工作原理。

二、基本概念：

1.‘#’所有的Velocity语句都是由它开始，结尾不需要特殊符号； 

Java代码  收藏代码
  1. 例如：  
  2.  #if( $foo == $bar )   
  3.  #if( $foo > 42 )   
  4.  #if( $foo < 42 )  


2.‘$’所有的变量，属性，对象的使用都有它开始； 

Java代码  收藏代码
  1. 引用（Reference）: 以 '$' 打头的元素  
  2. 字面字符串（String literal） : 比如"$foo" 或 'hello'  
  3. 字面数字: 1, 2 ….  
  4. 整数范围: [ 1..2] 或 [$foo .. $bar]  
  5. 对象数组: [ "a", "b", "c"]  
  6. 布尔真  
  7. 布尔假  
  8. 例如：  
  9. reference的正是格式如下：  
  10.   ${mudSlinger}        变量  
  11.   ${customer.Address}    属性  
  12.   ${purchase.getTotal()}    方法  


3.变量； 

Java代码  收藏代码
  1. 正则表达式：  
  2. $ [ ! ][ { }[ a..z, A..Z ][ a..z, A..Z, 0..9, -, _ ][ ] ]  
  3. 例如：  
  4. Normal notation: $mud-Slinger_9   
  5. Silent notation: $!mud-Slinger_9   
  6. Formal notation: ${mud-Slinger_9}  
  7. 变量分为三种基本形式：  
  8. 普通型（Normal notation），这是Velocity中最常用的变量类型，可适用于绝大多数情况；$message  
  9.   
  10. 哑元型（Silent notation），主要用在当你使用一个变量，可是它还没有值时，哑元型会为你输出一个空字符串；$!message  
  11.   
  12. 正式型（Formal notation），这种类型主要用载需要区分变量名称时，如使用变量$test但在页面中后面紧跟着页面内容，如：$testHello，变量会被误认为是$testHello，所以改变如下：${message}Hello，即可正常使用；  
  13.   
  14. 变量的注释：  
  15. 在Velocity中‘$’是保留字，所以页面中对它的使用就会受到一定的限制，如下的页面内容：  
  16. $2003year，是不会有问题的，因为在Velocity中变量必须使用字母开头（’!’、’{‘除外}所以这个字串会被正常显示；  
  17. $year2003，出现这样的字串，分两种情况：1.但当前并没有定义这个变量名，系统一样会正常显示；换言之如果要使用变量但没有定义系统都会将其当作一般字符串打印出来；2. 当前已定义这个变量名，则系统会把所有出现的此字串当作变量处理，为避免这种情况，Velocity给出了特殊符号修饰符’\’，假设给此变量赋值good year，结果如下：  
  18. $year2003            good year  
  19. \$year2003           $year2003  
  20. \\$year2003           \good year  
  21. \\\$year2003          \$year2003  
  22. 以此类推。  
  23. 注：单独使用变量，如：<input type="text" name="email" value="$email"/>，不算完整语句，不需要在行首加’#’  



4.属性： 
${aA32_E.ad-mo_mo23} 

Java代码  收藏代码
  1. $[{] [ a..z, A..Z ] [ a..z, A..Z, 0..9, -, _ ]* .[a..z, A..Z ] [ a..z, A-Z, 0..9, -, _ ] * [}]  



5.标示符： 

Java代码  收藏代码
    1. [ a..z, A..Z ] [ a..z, A..Z, 0..9, -, _ ]*  
    2. 如：ad-mo_mo23  
    3. 一个 VTL 标识符（Identifier.）组成。一个VTL 标识符必须以一个字母开始(a .. z或 A .. Z)。剩下的字符将由以下类型的字符组成：  
    4. 字母 (a .. z, A .. Z)  
    5. 数字 (0 .. 9)  
    6. 连字符("-")  
    7. 下划线 ("_")  

 

 

HelloController.java类： 
示例01： 

package com.xiaonei.rose.gettingStarted.controllers;

import java.util.ArrayList;
import java.util.Date;
import java.util.Hashtable;
import java.util.List;

import net.paoding.rose.web.Invocation;
import net.paoding.rose.web.annotation.Path;
import net.paoding.rose.web.annotation.rest.Get;

import com.xiaonei.rose.model.User;

@Path("/")
public class HelloController {
    @Get("")
    public String world(Invocation inv) {
        inv.addModel("now", new Date()); // 显示页面hello-world.vm: $date.format("yy-MM-dd HH:mm:ss",$now)
        
        inv.addModel("flag", "Rose-属性");
        
        User user = new User();
        user.setAge(23);
        user.setName("momo");
        inv.addModel("user", user);
        
        Hashtable mytable = new Hashtable<String, String>() ;
        mytable.put("key1", "HashTable-值1") ;
        inv.addModel("mytable", mytable);
        
        inv.addModel("email","398875193@qq.com") ;
        
        User user1 = new User() ;
        User user2 = new User() ;
        user1.setName("momo1") ;
        user2.setName("momo2") ;
        List<User> users = new ArrayList<User>() ;
        users.add(user1) ;
        users.add(user2) ;
//        User users[] = {user1,user2} ;
        inv.addModel("users", users) ;
    
        return "hello-world"; // 跳转到页面hello-world.vm||返回指定字符串：return "@mohaiyong" ;
    }
}

hello-world.vm页面： 

<html>
        <head></head>
        <body>
      0.注释：
            ## 当行注释
            
            #*
                                    多行注释
            *#
            
            #**
                           注释快
                @author mohaiyong
                @version 1.0
            *#<br><hr>
        
    1.取messages文件里的值和变量格式化输出：<br>
            #msg("hello")-#msg("hellorose"), it's $date.format("yy-MM-dd HH:mm:ss", $now)<hr>
            
    2.set 赋值：<br>
            ##当set语句和控制层java语句里都设置了变量verValue,该界面优先显示set语句设置的变量值
            #set( $velValue = "Velocity" )
            Hello $velValue World!<hr>
            
    3.形式引用符：<br>
            my name is  ${flag}-ewf_momo<br>
            my name is  ${flag}-Rose<hr>
            
    4.安静引用符：<br>
            <input type="text" name="email" value="$email"/><br>
            <input type="text" name="email" value="$!email"/><hr>
            
    5.单选按钮：<br>  
            <input type="radio" name="a" value="$!name"/>
            <input type="radio" name="a" value="$!age"/><hr>
            
    6.属性：<br>
            ##(HashTable|默认属性的方法)
            $mytable.key1<br>
            ## 首先尝试$getname()如果失败，再尝试 $getName().如果是$user.Name则先尝试$user.getName()后尝试$user.getname()         
            $user.name<hr>
        
    7.方法：<br>
            $user.name == $user.getName()
            $user.getAge()
            $user.setAddress("方法设置地址setAddress()")
            $user.getAddress()
            #set( $user.telephone = "18801491886" )
            $user.getTelephone()
            $user.setAttributes( ["Strange", "Weird", "Excited"] )
            <hr>
            
    8.取得语义：<br>
            $10.5<br>
            $flag<br>
            \$flag<br>
            \\$flag<br>
            \\\$flag<hr>
            
    9.#set赋值：<br>
            #set( $fuzhi = "赋值")
            $newValue = $fuzhi <br>
            
            #set( $monkey = $bill ) ## variable reference
            #set( $monkey.Friend = "monica" ) ## string literal
            #set( $monkey.Blame = $whitehouse.Leak ) ## property reference
            #set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference
            #set( $monkey.Number = 123 ) ##number literal
            #set( $monkey.Say = ["Not", $my, "fault"] )
            $monkey.Say.get(0)<br>
            #set( $value = $foo + 1 )
            #set( $value = $bar - 1 )
            #set( $value = $foo * $bar )
            #set( $value = $foo / $bar )
            
            #set( $result = $query.criteria("name") )
            The result of the first query is $result
            #set( $result = $query.criteria("address") )
            The result of the second query is $result<br>
            #set( $criteria = ["name", "address"] )
            #foreach( $criterion in $criteria )
                #set( $result = $query.criteria($criterion) )
                #if( $result )
                    Query was successful
                #end
            #end
            
            #set( $criteria = ["name", "address"] )
            #foreach( $criterion in $criteria )
                #set( $result = false )
                #set( $result = $query.criteria($criterion) )
                #if( $result )
                        Query was successful
                #end
            #end        
            
            #set( $directoryRoot = "www" )
            #set( $templateName = "index.vm" )
            #set( $template = "$directoryRoot/$templateName" )
            $template<br>
            #set( $blargh = '$templateName' )
            $blargh<hr>
            
    10.If/ElseIf/Else：<br>
             #if( $user.age )
             <strong>Velocity!</strong><br>
             #end
            
            #if( $user.age < 18 )
            <strong>未成年</strong>
            #elseif( $user.age >= 18 && $user.age<=60 )
                <strong>成年人</strong>
            #else
                <strong>老年人</strong>
            #end<br>
            
            #set ($flag01 = "rose")
            #set ($flag02 = "rose")
            &nbsp;
            #if ($flag01 == $flag02)
              flag01 == flag02
            #else
              flag01 != flag02
            #end<br>
            
            #if( $flag01 && $flag02 )
            <strong> flag01 AND flag02</strong>
            #end<br>
            #if( $flag01 || $flag03 )
            <strong> flag01 OR flag03</strong>
            #end<br>
            
            #if( !$flag03 )
            <strong>NOT flag03</strong>
            #end<br>
            
            <ul>
            #foreach( $key in $mytable.keySet() )
                <li>Key: $key -> Value: $mytable.get($key)</li>
            #end
            </ul>
            
            <ul>
            #foreach( $employee in $users )
                <tr><td>$velocityCount</td>
                    <td>$employee.getName()</td>
                </tr>
                ##或者 $employee.name/$employee.Name
            #end
            </ul><hr>
            
    11.包含：<br>
            ##include( "data.txt" )
           
    12.解析：<br>
            　　        ##parse("data.vm")<hr>
                            解析<hr>
            
    13.宏：<br>
            #macro( tablerows $color $somelist )
                #foreach( $something in $somelist )
                    <tr><td bgcolor=$color>$something</td></tr>
                #end
            #end
            #set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )
            #set( $color = "#CC00FF" )
            <table>
                #tablerows( $color $greatlakes )
            </table>
            
            #macro( callThree $a )
              $a $a $a
            #end
              #set( $hong = $user.getName())
              #callThree( $hong )<hr>
              
    14.转义 VTL 指令：<br>
            \#if( $jazz )
                                  转义if else
            \#end<hr>
            
    15.格式化：<br>
            #set( $imperial = ["momo1","momo2","momo3","momo4"] )
            #foreach( $shogun in $imperial )
                $shogun
            #end<br>
              
            Send me
            #set( $foo = ["$10 and ","a cake"] )
            #foreach( $a in $foo )
            $a
            #end
            please.<hr>
            
    16.数学特征：<br>
            #set( $bar = $user.age )   age：$bar
            #set( $foo = $bar + 3 )         $foo
            #set( $foo = $bar - 4 )         $foo
            #set( $foo = $bar * 6 )         $foo
            #set( $foo = $bar / 2 )         $foo
            #set( $foo = $bar % 5 )         $foo
            <hr>
            
    17.范围操作符：<br>
            #foreach( $foo in [1..5] )
            $foo
            #end
            &nbsp;
            #foreach( $bar in [2..-2] )
            $bar
            #end
            &nbsp;
            #set( $arr = [0..1] )
            #foreach( $i in $arr )
            $i
            #end
            &nbsp;
            [1..3]<hr>
            
    18.进阶：<br>
            #set( $foo = "bar" )
            $\!foo<br>
            $\!{foo}<br>
            $\\!foo<br>
            $\\\!foo<br>
            \$foo<br>
            \$!foo<br>
            \$!{foo}<br>
            \\$!{foo}<hr>
            
    19.字符串拼接：<br>
            #set( $size = "莫" )
            #set( $name = "涌" )
            #set($clock = "${size}-海-$name" )
            $clock   
        </body>  
</html>

示例02：

目   录
1.变量………………………………………………………………………………1
2.循环………………………………………………………………………………2
3.条件语句…………………………………………………………………………2
4.语句的嵌套………………………………………………………………………2
5.注释………………………………………………………………………………2
6.关系和逻辑运算符………………………………………………………………3
7.宏…………………………………………………………………………………3
8. #stop.................................................4
9. #include与#parse......................................4
10.转义字符的使用 ………………………………………………………………4
11.内置对象 ………………………………………………………………………5
12.数组的访问 ……………………………………………………………………5
示例部分……………………………………………………………………………5








Velocity语法
变量
变量的定义：
　　#set($name = "hello")      说明：velocity中变量是弱类型的。
当使用#set 指令时，括在双引号中的字面字符串将解析和重新解释，如下所示：
　#set($directoryRoot = "www" )
　#set($templateName = "index.vm" )
　#set($template = "$directoryRoot/$templateName" )
　$template
　输出将会是：www/index.vm
注：在velocity中使用$2.5这样的货币标识是没有问题得的，因为velocity中的变量总是以一个大写或者小写的字母开始的。
变量规范的写法
　　${name} ，也可以写成：$name。提倡用前面的写法。
例如：你希望通过一个变量$vice来动态的组织一个字符串。
&nbsp;Jack&nbsp;is&nbsp;a&nbsp;$vicemaniac.
本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用规范的格式书写&nbsp;：&nbsp;Jack&nbsp;is&nbsp;a&nbsp;${vice}maniac现在Velocity知道变量是$vice而不是$vicemaniac。
注意：当引用属性的时候不能加{}
变量的赋值:  
　　$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&nbsp;=&nbsp;"gibbous")&nbsp;$moon&nbsp;=&nbsp;$foo输出结果为：$moon&nbsp;=&nbsp;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}

循环
#foreach&nbsp;($element&nbsp;in&nbsp;$list)&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;is&nbsp;$element.&nbsp;&nbsp;&nbsp;&nbsp; $velocityCount&nbsp;#end
例子：
#set( $list = ["pine", "oak", "maple"])
#foreach&nbsp;($element&nbsp;in&nbsp;$list)
　　　$velocityCount
　　　This&nbsp;is&nbsp;$element.<br>#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) <br>#end
提示：velocity中大小写敏感。
Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。

例子：
First example:&nbsp;&nbsp;#foreach ( $foo in [1..5] )&nbsp;&nbsp;&nbsp;&nbsp;$foo&nbsp;&nbsp;#end&nbsp;&nbsp;Second example:&nbsp;&nbsp;#foreach ( $bar in [2..-2] )&nbsp;&nbsp;&nbsp;&nbsp;$bar&nbsp;&nbsp;#end&nbsp;&nbsp;Third example:&nbsp;&nbsp;#set ( $arr = [0..1] )&nbsp;&nbsp;#foreach ( $i in $arr )&nbsp;&nbsp;&nbsp;&nbsp;$i&nbsp;&nbsp;#end上面三个例子的输出结果为：&nbsp;&nbsp;First example：&nbsp;&nbsp;1 2 3 4 5&nbsp;&nbsp;Second example：&nbsp;&nbsp;2 1 0 -1 -2&nbsp;&nbsp;Third example：&nbsp;&nbsp;0 1
条件语句
#if (condition) 
#elseif (condition) 
#else 
#end
语句的嵌套
    #foreach ($element in $list) 
        ## inner foreach 内循环 
        #foreach ($element in $list) 
        This is $element. $velocityCount <br>inner<br>
        #end 
        ## inner foreach 内循环结束 
    ## outer foreach 
    This is $element. 
    $velocityCount <br>outer<br>
　　    #end
　　语句中也可以嵌套其他的语句，如#if…#else…#end等。
注释(1)单行注释：&nbsp;&nbsp;##&nbsp;This&nbsp;is&nbsp;a&nbsp;single&nbsp;line&nbsp;comment.(2)多行注释：&nbsp;&nbsp;#*&nbsp;&nbsp;&nbsp;Thus&nbsp;begins&nbsp;a&nbsp;multi-line&nbsp;comment.&nbsp;Online&nbsp;visitors&nbsp;won’t&nbsp;&nbsp;&nbsp;see&nbsp;this&nbsp;text&nbsp;because&nbsp;the&nbsp;Velocity&nbsp;Templating&nbsp;Engine&nbsp;will  ignore&nbsp;it.&nbsp;&nbsp;*#(3)文档格式：&nbsp;&nbsp;#**&nbsp;&nbsp;&nbsp;This&nbsp;is&nbsp;a&nbsp;VTL&nbsp;comment&nbsp;block&nbsp;and&nbsp;&nbsp;&nbsp;may&nbsp;be&nbsp;used&nbsp;to&nbsp;store&nbsp;such&nbsp;information  as&nbsp;the&nbsp;document&nbsp;author&nbsp;and&nbsp;versioning&nbsp;&nbsp;&nbsp;information:&nbsp;&nbsp;&nbsp;@version&nbsp;1.1
　　&nbsp;&nbsp;&nbsp;@author  xiao&nbsp;   &nbsp;*#
关系和逻辑操作符
　　Velocity 也具有逻辑AND, OR 和 NOT 操作符。    
　　如
　　## example for AND
　　#if($foo && $bar)
   <strong> This AND that</strong>
　　#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.<br>
　　#set ($count = 8)
　　#parse ("parsefoo.vm")
<br>All done with dofoo.vm!
那么在parsefoo.vm模板中，你可以包含如下VTL：
　　$count
　　#set($count = $count - 1)
　　#if ( $count > 0 )<br>
　　#parse( "parsefoo.vm" )
　　#else
　　<br>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类的方式来提供，传入数组对象和要访问的位置参数，从而达到返回所需值的目的。


示例部分
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)
            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>&nbsp; <head><title>Velocity</title></head>&nbsp; <body bgcolor="#ffffff">&nbsp;&nbsp;&nbsp; <center>&nbsp;&nbsp;&nbsp; <h2>Welcom to Velocity!</h2>&nbsp;&nbsp;&nbsp; <i>Here's the list of people</i>&nbsp;&nbsp;&nbsp; <table cellspacing="0" cellpadding="5" width="20%" >&nbsp;&nbsp;&nbsp; <tr>&nbsp;&nbsp;&nbsp; <td bgcolor="#eeeeee" align="center">&nbsp;&nbsp;&nbsp; Names：&nbsp;&nbsp;&nbsp; </td>&nbsp;&nbsp;&nbsp; </tr>&nbsp;&nbsp;&nbsp; #foreach ($name in $theList)&nbsp;&nbsp;&nbsp; <tr>&nbsp;&nbsp;&nbsp; <td bgcolor="#eeeeee" align="center">$name</td>&nbsp;&nbsp;&nbsp; </tr>&nbsp;&nbsp;&nbsp; #end&nbsp;&nbsp;&nbsp; </table>&nbsp;&nbsp;&nbsp; </center>&nbsp; </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 )
   {        
        //主要在此设置演示用的数据，开发中在此调用相应的业务处理流程，

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

 

Velocity示例 

HelloController.java类： 
示例01： 

Java代码  收藏代码
  1. package com.xiaonei.rose.gettingStarted.controllers;  
  2.   
  3. import java.util.ArrayList;  
  4. import java.util.Date;  
  5. import java.util.Hashtable;  
  6. import java.util.List;  
  7.   
  8. import net.paoding.rose.web.Invocation;  
  9. import net.paoding.rose.web.annotation.Path;  
  10. import net.paoding.rose.web.annotation.rest.Get;  
  11.   
  12. import com.xiaonei.rose.model.User;  
  13.   
  14. @Path("/")  
  15. public class HelloController {  
  16.     @Get("")  
  17.     public String world(Invocation inv) {  
  18.         inv.addModel("now", new Date()); // 显示页面hello-world.vm: $date.format("yy-MM-dd HH:mm:ss",$now)  
  19.           
  20.         inv.addModel("flag", "Rose-属性");  
  21.           
  22.         User user = new User();  
  23.         user.setAge(23);  
  24.         user.setName("momo");  
  25.         inv.addModel("user", user);  
  26.           
  27.         Hashtable mytable = new Hashtable<String, String>() ;  
  28.         mytable.put("key1", "HashTable-值1") ;  
  29.         inv.addModel("mytable", mytable);  
  30.           
  31.         inv.addModel("email","398875193@qq.com") ;  
  32.           
  33.         User user1 = new User() ;  
  34.         User user2 = new User() ;  
  35.         user1.setName("momo1") ;  
  36.         user2.setName("momo2") ;  
  37.         List<User> users = new ArrayList<User>() ;  
  38.         users.add(user1) ;  
  39.         users.add(user2) ;  
  40. //      User users[] = {user1,user2} ;  
  41.         inv.addModel("users", users) ;  
  42.       
  43.         return "hello-world"; // 跳转到页面hello-world.vm||返回指定字符串：return "@mohaiyong" ;  
  44.     }  
  45. }  





hello-world.vm页面： 

Java代码  收藏代码
  1. <html>  
  2.         <head></head>  
  3.         <body>  
  4.       0.注释：  
  5.             ## 当行注释  
  6.               
  7.             #*  
  8.                                     多行注释  
  9.             *#  
  10.               
  11.             #**  
  12.                            注释快  
  13.                 @author mohaiyong  
  14.                 @version 1.0  
  15.             *#<br><hr>  
  16.           
  17.     1.取messages文件里的值和变量格式化输出：<br>  
  18.             #msg("hello")-#msg("hellorose"), it's $date.format("yy-MM-dd HH:mm:ss", $now)<hr>  
  19.               
  20.     2.set 赋值：<br>  
  21.             ##当set语句和控制层java语句里都设置了变量verValue,该界面优先显示set语句设置的变量值  
  22.             #set( $velValue = "Velocity" )  
  23.             Hello $velValue World!<hr>  
  24.               
  25.     3.形式引用符：<br>  
  26.             my name is  ${flag}-ewf_momo<br>  
  27.             my name is  ${flag}-Rose<hr>  
  28.               
  29.     4.安静引用符：<br>  
  30.             <input type="text" name="email" value="$email"/><br>  
  31.             <input type="text" name="email" value="$!email"/><hr>  
  32.               
  33.     5.单选按钮：<br>    
  34.             <input type="radio" name="a" value="$!name"/>  
  35.             <input type="radio" name="a" value="$!age"/><hr>  
  36.               
  37.     6.属性：<br>  
  38.             ##(HashTable|默认属性的方法)  
  39.             $mytable.key1<br>  
  40.             ## 首先尝试$getname()如果失败，再尝试 $getName().如果是$user.Name则先尝试$user.getName()后尝试$user.getname()        
  41.             $user.name<hr>  
  42.           
  43.     7.方法：<br>  
  44.             $user.name == $user.getName()  
  45.             $user.getAge()  
  46.             $user.setAddress("方法设置地址setAddress()")  
  47.             $user.getAddress()  
  48.             #set( $user.telephone = "18801491886" )  
  49.             $user.getTelephone()  
  50.             $user.setAttributes( ["Strange", "Weird", "Excited"] )  
  51.             <hr>  
  52.               
  53.     8.取得语义：<br>  
  54.             $10.5<br>  
  55.             $flag<br>  
  56.             \$flag<br>  
  57.             \\$flag<br>  
  58.             \\\$flag<hr>  
  59.               
  60.     9.#set赋值：<br>  
  61.             #set( $fuzhi = "赋值")  
  62.             $newValue = $fuzhi <br>  
  63.               
  64.             #set( $monkey = $bill ) ## variable reference  
  65.             #set( $monkey.Friend = "monica" ) ## string literal  
  66.             #set( $monkey.Blame = $whitehouse.Leak ) ## property reference  
  67.             #set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference  
  68.             #set( $monkey.Number = 123 ) ##number literal  
  69.             #set( $monkey.Say = ["Not", $my, "fault"] )  
  70.             $monkey.Say.get(0)<br>  
  71.             #set( $value = $foo + 1 )  
  72.             #set( $value = $bar - 1 )  
  73.             #set( $value = $foo * $bar )  
  74.             #set( $value = $foo / $bar )  
  75.               
  76.             #set( $result = $query.criteria("name") )  
  77.             The result of the first query is $result  
  78.             #set( $result = $query.criteria("address") )  
  79.             The result of the second query is $result<br>  
  80.             #set( $criteria = ["name", "address"] )  
  81.             #foreach( $criterion in $criteria )  
  82.                 #set( $result = $query.criteria($criterion) )  
  83.                 #if( $result )  
  84.                     Query was successful  
  85.                 #end  
  86.             #end  
  87.               
  88.             #set( $criteria = ["name", "address"] )  
  89.             #foreach( $criterion in $criteria )  
  90.                 #set( $result = false )  
  91.                 #set( $result = $query.criteria($criterion) )  
  92.                 #if( $result )  
  93.                         Query was successful  
  94.                 #end  
  95.             #end          
  96.               
  97.             #set( $directoryRoot = "www" )  
  98.             #set( $templateName = "index.vm" )  
  99.             #set( $template = "$directoryRoot/$templateName" )  
  100.             $template<br>  
  101.             #set( $blargh = '$templateName' )  
  102.             $blargh<hr>  
  103.               
  104.     10.If/ElseIf/Else：<br>  
  105.              #if( $user.age )  
  106.              <strong>Velocity!</strong><br>  
  107.              #end  
  108.               
  109.             #if( $user.age < 18 )  
  110.             <strong>未成年</strong>  
  111.             #elseif( $user.age >= 18 && $user.age<=60 )  
  112.                 <strong>成年人</strong>  
  113.             #else  
  114.                 <strong>老年人</strong>  
  115.             #end<br>  
  116.               
  117.             #set ($flag01 = "rose")  
  118.             #set ($flag02 = "rose")  
  119.                
  120.             #if ($flag01 == $flag02)  
  121.               flag01 == flag02  
  122.             #else  
  123.               flag01 != flag02  
  124.             #end<br>  
  125.               
  126.             #if( $flag01 && $flag02 )  
  127.             <strong> flag01 AND flag02</strong>  
  128.             #end<br>  
  129.             #if( $flag01 || $flag03 )  
  130.             <strong> flag01 OR flag03</strong>  
  131.             #end<br>  
  132.               
  133.             #if( !$flag03 )  
  134.             <strong>NOT flag03</strong>  
  135.             #end<br>  
  136.               
  137.             <ul>  
  138.             #foreach( $key in $mytable.keySet() )  
  139.                 <li>Key: $key -> Value: $mytable.get($key)</li>  
  140.             #end  
  141.             </ul>  
  142.               
  143.             <ul>  
  144.             #foreach( $employee in $users )  
  145.                 <tr><td>$velocityCount</td>  
  146.                     <td>$employee.getName()</td>  
  147.                 </tr>  
  148.                 ##或者 $employee.name/$employee.Name  
  149.             #end  
  150.             </ul><hr>  
  151.               
  152.     11.包含：<br>  
  153.             ##include( "data.txt" )  
  154.              
  155.     12.解析：<br>  
  156.             　　        ##parse("data.vm")<hr>  
  157.                             解析<hr>  
  158.               
  159.     13.宏：<br>  
  160.             #macro( tablerows $color $somelist )  
  161.                 #foreach( $something in $somelist )  
  162.                     <tr><td bgcolor=$color>$something</td></tr>  
  163.                 #end  
  164.             #end  
  165.             #set( $greatlakes = ["Superior","Michigan","Huron","Erie","Ontario"] )  
  166.             #set( $color = "#CC00FF" )  
  167.             <table>  
  168.                 #tablerows( $color $greatlakes )  
  169.             </table>  
  170.               
  171.             #macro( callThree $a )  
  172.               $a $a $a  
  173.             #end  
  174.               #set( $hong = $user.getName())  
  175.               #callThree( $hong )<hr>  
  176.                 
  177.     14.转义 VTL 指令：<br>  
  178.             \#if( $jazz )  
  179.                                   转义if else  
  180.             \#end<hr>  
  181.               
  182.     15.格式化：<br>  
  183.             #set( $imperial = ["momo1","momo2","momo3","momo4"] )  
  184.             #foreach( $shogun in $imperial )  
  185.                 $shogun  
  186.             #end<br>  
  187.                 
  188.             Send me  
  189.             #set( $foo = ["$10 and ","a cake"] )  
  190.             #foreach( $a in $foo )  
  191.             $a  
  192.             #end  
  193.             please.<hr>  
  194.               
  195.     16.数学特征：<br>  
  196.             #set( $bar = $user.age )   age：$bar  
  197.             #set( $foo = $bar + 3 )         $foo  
  198.             #set( $foo = $bar - 4 )         $foo  
  199.             #set( $foo = $bar * 6 )         $foo  
  200.             #set( $foo = $bar / 2 )         $foo  
  201.             #set( $foo = $bar % 5 )         $foo  
  202.             <hr>  
  203.               
  204.     17.范围操作符：<br>  
  205.             #foreach( $foo in [1..5] )  
  206.             $foo  
  207.             #end  
  208.                
  209.             #foreach( $bar in [2..-2] )  
  210.             $bar  
  211.             #end  
  212.                
  213.             #set( $arr = [0..1] )  
  214.             #foreach( $i in $arr )  
  215.             $i  
  216.             #end  
  217.                
  218.             [1..3]<hr>  
  219.               
  220.     18.进阶：<br>  
  221.             #set( $foo = "bar" )  
  222.             $\!foo<br>  
  223.             $\!{foo}<br>  
  224.             $\\!foo<br>  
  225.             $\\\!foo<br>  
  226.             \$foo<br>  
  227.             \$!foo<br>  
  228.             \$!{foo}<br>  
  229.             \\$!{foo}<hr>  
  230.               
  231.     19.字符串拼接：<br>  
  232.             #set( $size = "莫" )  
  233.             #set( $name = "涌" )  
  234.             #set($clock = "${size}-海-$name" )  
  235.             $clock     
  236.         </body>    
  237. </html>  







示例02：

Java代码  收藏代码
  1. 目   录  
  2. 1.变量………………………………………………………………………………1  
  3. 2.循环………………………………………………………………………………2  
  4. 3.条件语句…………………………………………………………………………2  
  5. 4.语句的嵌套………………………………………………………………………2  
  6. 5.注释………………………………………………………………………………2  
  7. 6.关系和逻辑运算符………………………………………………………………3  
  8. 7.宏…………………………………………………………………………………3  
  9. 8. #stop.................................................4  
  10. 9. #include与#parse......................................4  
  11. 10.转义字符的使用 ………………………………………………………………4  
  12. 11.内置对象 ………………………………………………………………………5  
  13. 12.数组的访问 ……………………………………………………………………5  
  14. 示例部分……………………………………………………………………………5  
  15.   
  16.   
  17.   
  18.   
  19.   
  20.   
  21.   
  22.   
  23. Velocity语法  
  24. 变量  
  25. 变量的定义：  
  26. 　　#set($name = "hello")      说明：velocity中变量是弱类型的。  
  27. 当使用#set 指令时，括在双引号中的字面字符串将解析和重新解释，如下所示：  
  28. 　#set($directoryRoot = "www" )  
  29. 　#set($templateName = "index.vm" )  
  30. 　#set($template = "$directoryRoot/$templateName" )  
  31. 　$template  
  32. 　输出将会是：www/index.vm  
  33. 注：在velocity中使用$2.5这样的货币标识是没有问题得的，因为velocity中的变量总是以一个大写或者小写的字母开始的。  
  34. 变量规范的写法  
  35. 　　${name} ，也可以写成：$name。提倡用前面的写法。  
  36. 例如：你希望通过一个变量$vice来动态的组织一个字符串。  
  37.  Jack is a $vicemaniac.  
  38. 本来变量是$vice现在却变成了$vicemaniac，这样Veloctiy就不知道您到底要什么了。所以，应该使用规范的格式书写 ： Jack is a ${vice}maniac现在Velocity知道变量是$vice而不是$vicemaniac。  
  39. 注意：当引用属性的时候不能加{}  
  40. 变量的赋值:    
  41. 　　$name="hello"  
  42. 赋值的左边必须是一个变量或者是属性引用。右边可以是下面六种类型之一：   
  43. 变量引用,字面字符串,属性引用,方法引用,字面数字,数组列表。  
  44. 下面的例子演示了上述的每种类型：  
  45. #set( $monkey = $bill ) ## variable reference  
  46. #set( $monkey.Friend = "monica" ) ## string   
  47. #set( $monkey.Blame = $whitehouse.Leak ) ## property reference  
  48. #set( $monkey.Plan = $spindoctor.weave($web) ) ## method reference  
  49. #set( $monkey.Number = 123 ) ##number   
  50. #set( $monkey.Say = ["Not", $my, "fault"] ) ## ArrayList  
  51. 注意：①如果上述例子中的右值是null, 则左值不会被赋值，也就是说会保留以前的值。  
  52. 　　　　　　　②velocity模板中未被定义的变量将被认为是一个字符串。例如：  
  53. #set($foo = "gibbous") $moon = $foo输出结果为：$moon = gibbous  
  54. ③velocity模板中不会将reference解释为对象的实例变量。例如：$foo.Name将被解释为Foo对象的getName（）方法，而不是Foo对象的Name实例变量。例如：  
  55. $foo.getBar()  等同于$foo.Bar ；  
  56. $data.getUser("jon") 等同于$data.User("jon") ；  
  57. data.getRequest().getServerName() 等同于  
  58. $data.Request.ServerName等同于${data.Request.ServerName}  
  59.   
  60. 循环  
  61. #foreach ($element in $list)     This is $element.     $velocityCount #end  
  62. 例子：  
  63. #set( $list = ["pine", "oak", "maple"])  
  64. #foreach ($element in $list)  
  65. 　　　$velocityCount  
  66. 　　　This is $element.<br>#end  
  67. 输出的结果为：  
  68. 1 This is pine. 2 This is oak. 3 This is maple.  
  69. 每次循环$list中的一个值都会赋给$element变量。$list可以是一个Vector、Hashtable或者Array。分配给$element的值是一个java对象，并且可以通过变量被引用。例如：如果$element t是一个java的Product类，并且这个产品的名字可以通过调用他的getName（）方法得到。  
  70. #foreach ( $key in $list.keySet())Key: $key -> Value: $list.get($key) <br>#end  
  71. 提示：velocity中大小写敏感。  
  72. Velocity还特别提供了得到循环次数的方法，$velocityCount变量的名字是Velocity默认的名字。  
  73.   
  74. 例子：  
  75. 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  
  76. 条件语句  
  77. #if (condition)   
  78. #elseif (condition)   
  79. #else   
  80. #end  
  81. 语句的嵌套  
  82.     #foreach ($element in $list)   
  83.         ## inner foreach 内循环   
  84.         #foreach ($element in $list)   
  85.         This is $element. $velocityCount <br>inner<br>  
  86.         #end   
  87.         ## inner foreach 内循环结束   
  88.     ## outer foreach   
  89.     This is $element.   
  90.     $velocityCount <br>outer<br>  
  91. 　　  #end  
  92. 　　语句中也可以嵌套其他的语句，如#if…#else…#end等。  
  93. 注释(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  
  94. 　　   @author  xiao     *#  
  95. 关系和逻辑操作符  
  96. 　　Velocity 也具有逻辑AND, OR 和 NOT 操作符。    
  97. 　　如  
  98. 　　## example for AND  
  99. 　　#if($foo && $bar)  
  100.    <strong> This AND that</strong>  
  101. 　　#end  
  102. 例子中#if() 指令仅在$foo 和$bar 斗为真的时候才为真。如果$foo 为假，则表达式也为假；并且 $bar 将不被求值。如果 $foo 为真，Velocity 模板引擎将继续检查$bar的值，如果 $bar 为真，则整个表达式为真。并且输出This AND that 。如果 $bar 为假，将没有输出因为整个表达式为假。  
  103. 7.Velocity 中的宏  
  104. 　　Velocity中的宏我们可以理解为函数。  
  105. 　　①宏的定义  
  106. 　　#macro(宏的名称 $参数1 $参数2 …)  
  107. 　　   语句体(即函数体)  
  108. 　　#end  
  109. 　　　②宏的调用  
  110. 　　　#宏的名称($参数1 $参数2 …)  
  111.     说明：参数之间用空格隔开。  
  112. 8．#stop  
  113.    停止执行模板引擎并返回,把它应用于debug是很有帮助的。  
  114. 9．#include与#parse  
  115. #include和#parse的作用都是引入本地文件, 为了安全的原因，被引入的本地文件只能在TEMPLATE_ROOT目录下。  
  116. 区别：  
  117. 　　(1) 与#include不同的是，#parse只能指定单个对象。而#include可以有多个  
  118. 如果您需要引入多个文件，可以用逗号分隔就行：#include ("one.gif", "two.txt", "three.htm" )在括号内可以是文件名，但是更多的时候是使用变量的：#include ( “greetings.txt”, $seasonalstock )  
  119. (2) #include被引入文件的内容将不会通过模板引擎解析；   
  120. 而#parse引入的文件内容Velocity将解析其中的velocity语法并移交给模板，意思就是说相当与把引入的文件copy到文件中。  
  121. #parse是可以递归调用的，例如：如果dofoo.vm包含如下行：  
  122. 　　Count down.<br>  
  123. 　　#set ($count = 8)  
  124. 　　#parse ("parsefoo.vm")  
  125. <br>All done with dofoo.vm!  
  126. 那么在parsefoo.vm模板中，你可以包含如下VTL：  
  127. 　　$count  
  128. 　　#set($count = $count - 1)  
  129. 　　#if ( $count > 0 )<br>  
  130. 　　#parse( "parsefoo.vm" )  
  131. 　　#else  
  132. 　　<br>All done with parsefoo.vm!  
  133. #end的显示结果为：  
  134. Count down.  
  135. 8  
  136. 7  
  137. 6  
  138. 5  
  139. 4  
  140. 3  
  141. 2  
  142. 1  
  143. 0  
  144. All done with parsefoo.vm!  
  145. All done with dofoo.vm!  
  146. 注意：在vm中使用#parse来嵌套另外一个vm时的变量共享问题。如：->a.vm 里嵌套 b.vm；->a.vm 里定义了变量 $param；->b.vm 里可以直接使用$param，无任何限制。但需要特别注意的是，如果b.vm里同时定义有变量$param，则b.vm里将使用b.vm里定义的值。  
  147. 10．转义字符'\'的使用  
  148. 　　如果reference被定义，两个’\’意味着输出一个’\’，如果未被定义，刚按原样输出。如：  
  149. #set($email = "foo" )  
  150. $email  
  151. \$email  
  152. \\$email  
  153. \\\$email  
  154. 输出：  
  155. foo$email\foo\$email  
  156. 如果$email 未定义  
  157. $email  
  158. \$email  
  159. \\$email  
  160. \\\$email  
  161. 输出：  
  162. $email\$email\\$email\\$email  
  163. 　　  
  164. 11．内置对象Velocity内置了一些对象，在vm模版里可以直接调用，列举如下：$request、$response、$session，另外，模板内还可以使用 $msg内的消息工具访问 Struts 的国际化资源，达到简便实现国际化的方法。  
  165. 12. 数组访问  
  166. 对数组的访问在Velocity中存在问题，因为Velocity只能访问对象的方法，而数组又是一个特殊的Array，所以虽然数组可以进行循环列举，但却不能定位访问特定位置的元素，如 strs[2]，数组对固定位置元素的访问调用了Array的反射方法get(Object array, int index)，而Velocity没能提供这样的访问，所以数组要么改成List等其他类容器的方式来包装，要么就通过公用Util类的方式来提供，传入数组对象和要访问的位置参数，从而达到返回所需值的目的。  
  167.   
  168.   
  169. 示例部分  
  170. 1．Hello world的示例代码：  
  171. (1)Velocity模板(hello.html)  
  172. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">  
  173. <HTML>  
  174. <HEAD>  
  175. <TITLE> New Document </TITLE>  
  176. </HEAD>  
  177. <BODY>  
  178.     hello,$name!                 （注意：这里的name与VelocityTest.java中的名称要一致）  
  179. </BODY>  
  180. </HTML>  
  181. (2)将velocity模板的内容转换的类(VelocityTest.java)  
  182. import java.io.File;  
  183. import java.io.FileOutputStream;  
  184. import java.io.PrintWriter;  
  185. import java.io.Writer;  
  186. import org.apache.velocity.Template;  
  187. import org.apache.velocity.VelocityContext;  
  188. import org.apache.velocity.app.Velocity;  
  189. import org.apache.velocity.app.VelocityEngine;  
  190.   
  191. /** 
  192.  * Velocity转换 
  193.  * @author 
  194.  */  
  195. public class VelocityTest  
  196. {  
  197.     /** 
  198.      * 主函数 
  199.      * @param args 
  200.      */  
  201.     public static void main(String[] args)  
  202. 　 {  
  203. 　       //获取模板引擎  
  204.         VelocityEngine ve = new VelocityEngine();  
  205.         //模板文件所在的路径  
  206.         String path = "D:/java/jproject/regedit/webroot";         
  207.         //设置参数  
  208.         ve.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path);  
  209. 　　　　//处理中文问题  
  210.         ve.setProperty(Velocity.INPUT_ENCODING,"GBK");  
  211.         ve.setProperty(Velocity.OUTPUT_ENCODING,"GBK");  
  212.         try   
  213.         {  
  214.             //初始化模板  
  215.             ve.init();  
  216.             //获取模板(hello.html)  
  217.             Template template = ve.getTemplate("hello.html");      
  218.             //获取上下文  
  219.             VelocityContext root = new VelocityContext();  
  220.             //把数据填入上下文  
  221.             root.put("name","world");                     （注意：与上面的对应）  
  222. 　　　　　　//输出路径  
  223.             Strint outpath = "e:/helloworld.html";  
  224.             //输出  
  225.             Writer mywriter = new PrintWriter(new FileOutputStream(  
  226.                 new File(outpath)));              
  227.             template.merge(root, mywriter);  
  228.             mywriter.flush();             
  229.         }   
  230.         catch (Exception e)   
  231.         {  
  232.             e.printStackTrace();  
  233.         }  
  234.     }  
  235. }  
  236. (3)环境的搭建  
  237. 在lib目录内分别copy进：velocity-1.4.jar，velocity-dept.jar;  
  238. 下载地址：http://jakarta.apache.org/velocity/  
  239. (4)运行后的结果如下：  
  240. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">  
  241. <HTML>  
  242. <HEAD>  
  243. <TITLE> New Document </TITLE>  
  244. </HEAD>  
  245. <BODY>  
  246. 　　　hello,world!   
  247. </BODY>  
  248. </HTML>  
  249.   
  250. 2．Servlet和Velocity结合示例  
  251. (1)example.html  
  252.  <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>  
  253. (2)servlet  
  254. package com.koal.velocity;  
  255.   
  256. import java.io.IOException;  
  257. import java.io.FileNotFoundException;  
  258. import java.util.ArrayList;  
  259. import java.util.Properties;  
  260. import java.util.Vector;  
  261. import javax.servlet.ServletConfig;  
  262. import javax.servlet.http.HttpServletRequest;  
  263. import javax.servlet.http.HttpServletResponse;  
  264. import org.apache.velocity.Template;  
  265. import org.apache.velocity.context.Context;  
  266. import org.apache.velocity.servlet.VelocityServlet;  
  267. import org.apache.velocity.app.Velocity;  
  268. import org.apache.velocity.exception.ResourceNotFoundException;  
  269. import org.apache.velocity.exception.ParseErrorException;  
  270.   
  271. public class SampleServlet extends VelocityServlet    
  272. {  
  273.     /** 
  274.      *   由VelocityServlet.init()调用， 
  275.      *   在此找出模版的路径 
  276.      */  
  277.     protected Properties loadConfiguration(ServletConfig config )  
  278.         throws IOException, FileNotFoundException {  
  279.         Properties p = new Properties();  
  280.         //取得路径  
  281.         String path = config.getServletContext().getRealPath("/");  
  282.         if (path == null)   
  283.         {  
  284.             System.out.println(" SampleServlet.loadConfiguration() : unable to "   
  285.                     + "get the current webapp root.  Using '/'. Please fix.");  
  286.             path = "/";  
  287.         }  
  288.         //设置路径  
  289.         p.setProperty( Velocity.FILE_RESOURCE_LOADER_PATH, path);  
  290.           
  291.         return p;  
  292.     }  
  293.   
  294.     /** 
  295.      *  Velocity主要的商业逻辑处理方法，由VelocityServlet自动调用 
  296.      *  @param ctx 模板上下文              
  297.      *  @return Template 模板信息 
  298.      */     
  299.     public Template handleRequest( HttpServletRequest request,  
  300.        HttpServletResponse response, Context ctx )  
  301.    {          
  302.         //主要在此设置演示用的数据，开发中在此调用相应的业务处理流程，  
  303.   
  304.         //并设置返回到页面的数据   
  305.         //待展示的列表数据        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 );     
  306.         //定义模板          
  307.         Template outty = null;          
  308.         try   
  309.         {  
  310.             //取模板  
  311.             outty =  getTemplate("example.html");              
  312.         }   
  313.         catch( ParseErrorException pee )   
  314.         {  
  315.             System.out.println("SampleServlet: parse error for template " + pee);  
  316.         }  
  317.         catch( ResourceNotFoundException rnfe )   
  318.         {  
  319.             System.out.println("SampleServlet: template not found " + rnfe);  
  320.         }   
  321.         catch( Exception e )  
  322.         {  
  323.             System.out.println("Error " + e);  
  324.         }  
  325.           
  326.         return outty;  
  327. 　　}  
  328. 　　  
  329. 　　(3)在web.xml中的配置：  
  330. 　　<web-app>  
  331. 　　<servlet>     
  332.         <servlet-name>SampleServlet</servlet-name>  
  333.         <servlet-class>com.koal.velocity.SampleServlet</servlet-class>  
  334. 　　</servlet>  
  335.     <servlet-mapping>  
  336.         <servlet-name>SampleServlet</servlet-name>  
  337.         <url-pattern>/SampleServlet</url-pattern>  
  338. 　　</servlet-mapping>  
  339. 　　</web-app>  
  340. 　　  
  341. 　　(4)环境的搭建  
  342. 　　在lib目录内分别copy进：commons-collections.jar,velocity-1.4.jar，velocity-dept.jar;    Tomcat运行环境正常。    启动Tomcat，在IE上输入：http://localhost:8080/example，页面显示数据列表：  
  343. 　　　　　　　　　　　　　　　　　Here's the list of people  
  344. Names:   
  345. 第一位：LiuDong  
  346. 第二位：Liang.xf  
  347. 　　  
posted @ 2015-12-11 13:57  彼扬  阅读(936)  评论(0)  编辑  收藏  举报

感谢您的阅读，如果有了您的奉献系统会更加完善