Velocity常用语法「建议收藏」

大家好，又见面了，我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

一、基本语法

1、”#”用来标识Velocity的脚本语句，包括#set、#if 、#else、#end、#foreach、#end、#iinclude、#parse、#macro等；
如:
    #if($info.imgs)
        <img src=”$info.imgs” border=0>
    #else
        <img src=”noPhoto.jpg”>
    #end

2、”$”用来标识一个对象(或理解为变量)；
    如：$i、$msg、$TagUtil.options(…)等。

3、”{}”用来明确标识Velocity变量；
    比如在页面中，页面中有一个$someonename，此时，Velocity将把someonename作为变量名，若我们程序是想在someone这个变量的后面紧接着显示name字符，则上面的标签应该改成${someone}name。

4、”!”用来强制把不存在的变量显示为空白。
    如当页面中包含$msg，如果msg对象有值，将显示msg的值，如果不存在msg对象同，则在页面中将显示$msg字符。这是我们不希望的，为了把不存在的变量或变量值为null的对象显示为空白，则只需要在变量名前加一个“!”号即可。
    如：$!msg

　　 1、$!obj 　直接返回对象结果。
　　 如：在html标签中显示java对象msg的值。<p>$!msg</p>
　 在html标签中显示经过HtmlUtil对象处理过后的msg对象的值　　<p>$!HtmlUtil.doSomething($!msg)</p>

　　2、#if($!obj) #else #end 判断语句
　　 如：在EasyJWeb各种开源应用中，我们经常看到的用于弹出提示信息msg的例子。
　　 #if($msg)
　　     <script>
　　         alert(‘$!msg’);
　　     </script>
　　 #end
上面的脚本表示当对象msg对象存在时，输出<script>等后面的内容。

    3、#foreach( $info in $list) $info.someList #end　　循环读取集合list中的对象，并作相应的处理。
　　 如：EasyJF开源论坛系统中论(0.3)坛首页显示热门主题的html界面模板脚本：
　　#foreach( $info in $hotList1)
<a href=”/bbsdoc.ejf?easyJWebCommand=show&&cid=$!info.cid” target=”_blank”>$!info.title</a><br>
　　#end
　　 上面的脚本表示循环遍历hotList1集合中的对象，并输出对象的相关内容。
　　
5、#macro(macroName)#end 脚本函数(宏)调用，不推荐在界面模板中大量使用。
　　 如：在使用EasyJWeb Tools快速生成的添删改查示例中，可以点击列表的标题栏进行升降排序显示，这是我们在EasyJWeb应用中经常看到的一个排序状态显示的模板内容。
　　 函数(宏)定义，一般放在最前面
　　 #macro(orderPic $type)
　　 #if ($orderField.equals($type))
　　 <img src=”/images/ico/${orderType}.gif”>
　　 #end
　　 #end
具体的调用如：<font color=”#FFFFFF”>头衔#orderPic(“title”)</font>

6、包含文件#inclue(“模板文件名”)或#parse(“模板文件名”)
　　主要用于处理具有相同内容的页面，比如每个网站的顶部或尾部内容。
　　使用方法，可以参考EasyJF开源Blog及EasyJF开源论坛中的应用！
　　如：#parse(“/blog/top.html”)或#include(“/blog/top.html”)
　　parse与include的区别在于，若包含的文件中有Velocity脚本标签，将会进一步解析，而include将原样显示。

关于#set的使用
　　在万不得已的时候，不要在页面视图自己声明Velocity脚本变量，也就是尽量少使用#set。有时候我们需要在页面中显示序号，而程序对象中又没有包含这个序号属性同，可以自己定义。如在一个循环体系中，如下所示：
　　#set ($i=0)
　　#foreach($info in $list)
　　序号:$i
　　#set($i=$i+1)

　　#end

二、Velocity脚本语法摘要

1、声明:#set ($var=XXX)


　　左边可以是以下的内容


　　Variable reference


　　String literal


　　Property reference


　　Method reference


　　Number literal #set ($i=1)


　　ArrayList #set ($arr=[“yt1″,”t2”])

　　算术运算符

2、注释:

    (1)单行注释： ## xxxx

    (2)多行注释： #* xxxxxx

                             xxxx *#

    (3)文档格式： #** xxxxx

                            xxx

                        @author striner *#

3、变量 Variables


　　以 “$” 开头，第一个字符必须为字母。character followed by a VTL Identifier. (a .. z or A .. Z).


　　变量可以包含的字符有以下内容：


　　alphabetic (a .. z, A .. Z)


　　numeric (0 .. 9)


　　hyphen (“-“)

　　underscore (“_”)

(1)变量的定义：

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

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

#set($directoryRoot = “www” )

#set($templateName = “index.vm” )

#set(​directoryRoot/$templateName” )

$template

输出将会是：www/index.vm

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

(2)变量规范的写法

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

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

     Jack is a $vicemaniac.

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

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

(3)变量的赋值:

    $name=”hello”

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

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

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

    #set( ​bill ) ## variable reference

    #set( $monkey.Friend = “monica” ) ## string

    #set( ​whitehouse.Leak ) ## property reference

    #set( ​spindoctor.weave($web) ) ## method reference

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

    #set( ​my, “fault”] ) ## ArrayList

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

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

    #set($foo = “gibbous”) ​foo输出结果为：$moon = gibbous

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

    data.getRequest().getServerName() 等同于​{data.Request.ServerName}

4、Properties
　　$Identifier.Identifier
　　$user.name
　　hashtable user中的的name值.类似：user.get(“name”)

5、Methods
　　object user.getName() = $user.getName()

6、Formal Reference Notation
　　用{}把变量名跟字符串分开

　　如
　　#set ($user=”csy”}
　　${user}name
　　返回csyname

　　$username
　　$!username
　　$与$!的区别
　　当找不到username的时候，$username返回字符串”$username”，而$!username返回空字符串””

7、双引号 与 引号
　　#set ($var=”helo”)
　　test”$var” 返回testhello
　　test’$var’ 返回test’$var’
　　可以通过设置 stringliterals.interpolate=false改变默认处理方式

8、条件语句
　　#if( $foo )
　　 <strong>Velocity!</strong>
　　#end
　　#if($foo)
　　#elseif()
　　#else
　　#end
　　当$foo为null或为Boolean对象的false值执行.

9、逻辑运算符:== && || !

10、循环语句#foreach($var in $arrays ) // 集合包含下面三种Vector, a Hashtable or an Array
     
　　#foreach( $product in $allProducts )
　　 <li>$product</li>
　　#end

　　#foreach( $key in $allProducts.keySet() )
　　 <li>Key: $key -> Value: $allProducts.get($key)</li>
　　#end

　　#foreach( $customer in $customerList )
　　 <tr><td>$velocityCount</td><td>$customer.Name</td></tr>

　　#end

例子：

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

    #foreach ($element in $list)

    $velocityCount

This is $element.<br>

    #end

输出的结果为：

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

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

#foreach ( ​list.keySet()) Key: ​list.get($key) <br> #end

提示：velocity中大小写敏感。

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

11、velocityCount变量在配置文件中定义
　　# 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

12、#include与#parse导入脚本

　　#include( “one.gif”,”two.txt”,”three.htm” )

        #parse (“parsefoo.vm”)

#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模板中，你可以包含如下内容：

$count

#set($count = $count – 1)

#if ( $count > 0 )<br>

#parse( “parsefoo.vm” )

#else

<br>All done with parsefoo.vm!

#end

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

13、#stop 停止执行并返回

14、定义宏Velocimacros ,相当于函数 支持包含功能

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

①宏的定义

　　#macro( 宏的名称 $参数1 $参数2 … )
　　 语句体（函数体）

　　#end

②宏的调用

　　#宏的名称（$参数1 $参数2 …）

       注意：参数之间用空格隔开

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

15、Range Operator
　　#foreach( $foo in [1..5] )

16、内置对象

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

17、数组访问

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