Velocity技术入门及常用语句

末蓝、 2022-09-27 00:25 161阅读 0赞

# 前言 #

Velocity是一种Java模版引擎技术，该项目由Apache提出，由另外一种引擎技术Webmacro引深而来。那什么是官方的Velocity定义呢？Apache对它的定义是：一种基于Java的模板引擎，但允许任何人使用简单而强大的模板语言来**引用定义在Java代码中的对象**。其实Velocity就是MVC架构的一种实现，但它更多的是关注在Model和View之间，作为它们的桥梁。**相比传统的JSP、PHP 等脚本语言，Velocity 彻底的将避免了在视图设计中出现的java 代码, 从而保证了web site 的长期可维护性。**创建Velocity模板，其实与html很相似，不过文件类型是.vm文件，例如HellowVelocity.vm：

<html> 
    <title>Hello Velocity</title> 
    <body> 
    Welcome!  
    </body>
    </html>

# Velocity与JSP的比较 #

JSP与Velocity都是java表现层技术

JSP：

优点：  
1、功能强大，可以写java代码  
2、支持jsp标签（jsp tag）  
3、支持表达式语言（el）  
4、官方标准，用户群广，丰富的第三方jsp标签库  
5、性能良好。jsp编译成class文件执行，有很好的性能表现  
缺点：  
jsp没有明显缺点，非要挑点骨头那就是，由于可以编写java代码，如使用不当容易破坏mvc结构。

Velocity是较早出现的用于代替jsp的模板语言 ：  
优点：  
1、不能编写java代码，可以实现严格的mvc分离  
2、性能良好，据说比jsp性能还要好些  
3、使用表达式语言，据说jsp的表达式语言就是学velocity的  
缺点：  
1、不是官方标准  
2、用户群体和第三方标签库没有jsp多。  
3、对jsp标签支持不够好

# Velocity常用语法 #

接下来看一些Velocity常用的语法：

（1）注释：

##注释##

多行注释

#*
    多行注释
    *#

（2）定义变量  
在Velocity中，变量的定义都是使用`$`开头的，$作为Velocity的标识符。字母、数字、中划和下划线都可以作为Velocity的定义变量，`$变量`例如：

${value}
    $title
    $TagUtil.options

注意：”\{\}”用来明确标识Velocity变量，比如在页面中，页面中有一个`$someonename`，此时，Velocity将把someonename作为变量名，若我们程序是想在someone这 个变量的后面紧接着显示name字符，则上面的标签应该改成`${someone}name`。  
!用来强制把不存在的变量显示为空白

（3）变量赋值  
对于 Velocity 来说，变量是弱数据类型的（与JavaScript很像），可以在赋了一个 String 给变量之后再赋一个数字或者数组给它。可以将以下六种数据类型赋给一个 Velocity 变量：变量引用, 字面字符串, 属性引用, 方法引用, 字面数字, 数组列表。

#set($foo = $bar)
    #set($foo =“hello”)
    #set($foo.name = $bar.name)
    #set($foo.name = $bar.getName($arg))
    #set($foo = 123)
    #set($foo = [“foo”,$bar])

（4）声明语句

对于Velocity，我感觉其语法与java近似，大部分都是一样的  
`#`用来声明语句：

#foreach ($color in $colors)
    Color$!{foreach.count}/${
        foreach.index}:$!{color}
    #end

其中foreach.count表示foreach遍历的“数组”长度，foreach.index表示当前“位置”。

条件语句：

#if(condition)
    ...
    #elseif(condition)
    …
    #else
    …
    #end

（5）模板继承

include：纯文本扩展

Include: #include("header.vm")

parse：不仅将文本包含进来，并且对这段文本进行一个编译和转化

（6）宏  
Velocity 中的宏可以理解为函数定义。定义的语法如下：

#macro(macroName arg1 arg2 …)
    ...
    #end

调用这个宏的语法是：

#marcoName(arg1 arg2 …)

这里的参数之间使用空格隔开，下面是定义和使用 Velocity 宏的例子：

#macro(sayHello $name)
    hello $name
    #end
    #sayHello(“velocity”)

输出的结果为 hello velocity

如下是一个完整的用于View的Velocity的例子，是这几天在做Spring Boot的时候写的一个demo，可以具体体会下Velocity的使用，其中的java代码将会在之后Spring Boot的博文中展示：

<html>
    <body>
    <pre>
    Hello VM.
    
    ## 注释
    
    #*
    注释
    *#
    
    value1:$!{value1}
    $!{value2}
    ${
        value3}
    
    #foreach ($color in $colors)
    Color $!{foreach.index}/$!{foreach.count}: $!{color}
    #end
    
    #foreach($key in $map.keySet())
    Number $!{foreach.index}/$!{foreach.count}: $!{key} $map.get($key)
    #end
    
    #*
    通过entrySet方法遍历到的是Map中的每个实体（都是K-V的键值对）
    *#
    #foreach($kv in $map.entrySet())
    Number $!{foreach.index}/$!{foreach.count}: $!{kv.key} $!{kv.value}
    #end
    
    
    User:$!{user.name}##会自动去查找是否存在getName之类的方法
    #*
    第二种方式是调用User类中属性对应的get方法
    *#
    User:$!{user.getName()}
    
    #set($title = "megustas")
    ##公共部分尽量避免重复，因此公共部分用一个文件分离出来，方便每次调用
    #*
    include纯粹的将文本包含进来
    *#
    Include: #include("header.vm") <br>
    #*
    parse不仅将文本包含进来，并且对这段文本进行一个编译和转化，因此header.vm文件中的title属性值变成了megustas
    *#
    Parse:#parse("header.vm")
    
    
    ##定义函数render_color
    #macro (render_color, $color, $index)
    Color By Macro $index, $color
    #end
    
    #foreach ($color in $colors)
        #render_color($color, $foreach.index)
    #end
    
    ##定义变量set
    #set($hello = "hello")
    ##使用双引号""才会对文本内容进行解释，''单引号仍保持文本状态
    #set($hworld1 = "$!{hello} world")
    #set($hworld2 = '$!{hello} world')
    
    hworld1:$hworld1
    hworld2:$hworld2
    
    $!{colors.size()}
    
    </pre>
    </body>
    </html>

生成的显示界面：

![这里写图片描述][SouthEast]

[SouthEast]: /images/20220708/20ec06c8264f461e84f804a51abb1f13.png