Velocity笔记

来源：互联网发布：数据库管理系统access 编辑：程序博客网时间：2024/06/06 14:13

Velocity是一种Java模版引擎技术，该项目由Apache提出，由另外一种引擎技术Webmacro引深而来。那什么是官方的Velocity定义呢？Apache对它的定义是：一种基于Java的模板引擎，但允许任何人使用简单而强大的模板语言来引用定义在Java代码中的对象。目前最新的版本是1.4，可以在http://jakarta.apache.org/velocity/index.html查找更多信息。

Velocity有个集合叫做context，说白了就是controller和model层的封装，提供了网页模板。实现了velocity的代码将利用从context中的对象里获取的数据替换模板中的脚本元素。----------如果你查阅了很多资料还是感觉很模糊可以多读2遍这句话

Context介绍
Context本质上是一个介于java代码层和velocity模板层之间的一个数据桥梁。Java开发人员将各种各样的数据对象放到context中，页面模板设计人员从context取得这些对象的reference。Velocity中定义了VelocityContext来提供基本实现。这个实现与java中的hashtable类似，最有用和常用的方法就是Public Object put(String key, Object value);Public Object get(String key);
如果理解了context的容器特性，那么什么东西能放进去呢？context首先支持放一些迭代对象（Iterative Objects），比如对象数组Object[], java.util.Collection, java.util.Map, java.util.Iterator, java.util.Enumeration, 以及任意的有public Iterator iterator()方法的public class。其次context还支持put静态类（static class），比如context.put(“Math”, Math.class)。当然，在velocity运行时模板产生的对象也可以放到context中。

Velocity的三种reference
变量variable：对应java对象的一种字符串化的表示，它返回的值是调用了java的toString方法后的结果。
方法method：调用所引用对象的某个方法，该方法必须是public类的一个public方法。如果该方法有返回值，那么velocity在调用完方法后会同样的对返回值进行toString包装。对参数的要求是velocity要求所有的方法参数也必须是string的。
属性property：类似方法，除了访问java类的属性外，还等价于get***方法。
$!前缀是quiet notation符号，用这个前缀产生的引用在引用对象不存在的时候，会返回“”字符串而不是不存在的对象的名字的字符串。
“"”是转义字符，可以转义$符号和其他符号
Velocity指令

#stop：用于debug，当engine遇到这个指令，就会停止执行，并将控制权返回给调用程序。
#include：用于包含外部文件，将外部文件的内容直接加入程序中。
#parse：与include类似，但是不同之处在于，include引入的是静态的文件，而parse会动态的加载模板，也就是说，parse会解析vm文件，然后再加入到源文件中去。
#set：就是一个很强大的赋值指令，不管被赋值的变量是否已经存在或赋值，新的set指令会完全覆盖。指令格式就是#set(ref=value)。

下面是一个简单的Velocity例子：

1、创建velocity模版（其实和html一样），文件名为：hellovelocity.vm

<html>
<title>Hello Velocity</title>
<body>
Welcome $name to Javayou.com!
today is $date.
</body>
</html>

2、创建java文件，HelloVelocity.java ：

package com.fasttalk. velocity;
import java.io.StringWriter;
import java.util.*;
import org.apache.velocity.app.VelocityEngine;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;

public class HelloVelocity {
public static void main(String[] args) throws Exception {
//初始化并取得Velocity引擎
VelocityEngine ve = new VelocityEngine();
ve.init();
//取得velocity的模版
Template t = ve.getTemplate("hellovelocity.vm");
//取得velocity的上下文context
VelocityContext context = new VelocityContext();
//把数据填入上下文
context.put("name", "Liang");
context.put("date", (new Date()).toString());
//为后面的展示，提前输入List数值
List temp = new ArrayList();
temp.add("1");
temp.add("2");
context.put("list", temp);
//输出流
StringWriter writer = new StringWriter();
//转换输出
t.merge(context, writer);
System.out.println(writer.toString());
}
}

在http://jakarta.apache.org/site/binindex.cgi上下载Velocity 1.4 zip

4、把1上的hellovelocity.vm copy到运行的当前目录下，运行结构如下：

<html>
<title>Hello Velocity</title>
<body>
Welcome Liang to Javayou.com!
today is Tue Dec 14 19:26:37 CST 2004.
</body>
</html>

以上是最简单的运行结果，怎么样，知道个大概吧，模版hellovelocity.vm里的2个定义变量$name和$date分别被context.put("name", "Liang")和context.put("date", (new Date()).toString())所设的值替代了。

由此看来业务流程处理包括业务结果基本在model这层全部解决，而view这一层基本只用使用简单的VTL（Velocity Template Language）来展示。这样，Jsp岂不是不用了么？是的，这样的使用模式有点象早前的CGI方式：）由Velocity自动输出代码，并且Velocity在这方面的能力也很强，Turbine里就采用了Velocity来产生很多代码。

在Velocity中，变量的定义都是使用“$”开头的，$作为Velocity的标识符。字母、数字、中划和下划线都可以作为Velocity的定义变量。

还需要注意的是Velocity特色的变量定义，如：$student.No、$student.Address，它有2层含义：

l 第1种是如果student是hashtable，则将从hashtable中提取key为No和Address的值，

l 另外第2种就是它有可能是调用方法，即上面2个变量将被转换为student.getNo()和student.getAddress()。

Velocity对在servlet中的java code返回的值有对象，还可以调用对象的方法，如$ student.getAddress()等等，在此就不一一举例和深入了。

上面的例子只是简单的举例，现在当然不少人已经不满足这样的例子了，实际的应用中我们还常常需要作些选择性展示和列举一些迭代数据，如List列表，当然Velocity（具体来说应该是VTL模版语言）也支持这项功能，此外还支持其他一些常用的展示，如模版内部的变量（如Jsp内的变量），还有强大一些的如创建宏以实现自动化，让我们继续接着往下看吧。

我们还是使用上面的例子，把模版hellovelocity.vm中的内容改为：

#set( $iAmVariable = "good!" )
Welcome $name to csdn.net!
today is $date.
$iAmVariable

重新执行上面的运行命令，结果：

Welcome Liang to csdn.net!
today is Tue Dec 14 22:44:39 CST 2004.
good!

可以看得模版中的变量定义为# set开头的语句，不是很难理解，执行后模版中的变量$iAmVariable都转换成定义的值：good!

再来看看简单的选择，把模版hellovelocity.vm中的内容改为：

#set ($admin = "admin")
#set ($user = "user")
#if ($admin = = $user)
Welcome admin!
#else
Welcome user!
#end

执行运行命令，结果：

Welcome user!

可以看到判断语句只是简单的#if ()、#else、#end，不是很复杂。

接着继续来看看迭代数据吧，把模版hellovelocity.vm中的内容改为：

#foreach( $product in $list )
<li>$product</li>
#end

执行运行命令，结果：

把在例子中预先保存在VelocityContext的List中的值列举了出来，是不是很方便啊？仅仅只是用了#foreach（$variable in xx）而已，如果上面的List换成Hashtable，则可以用下面的语法：

#foreach($key in $hashVariable.keySet() )
<li> $key ‘s value: $ hashVariable.get($key) </li>
#end

一点不觉得这些脚本很复杂。

还有不少人还会问，如果是javabean怎么办？好的，我们增加一个bean：

package com.fasttalk.velocity;

public class Student {
//注意class的属性是public的
public String no = "";
public String address = ""
public Student(String _no, String _address) {
no = _no;
address = _address;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
public String getNo() {
return no;
}
public void setNo(String no) {
this.no = no;
}
}

这个Student是实足的javabean，或者说是data bean，常见的用来装载数据的类，然后我们修改HelloVelocity.java，把：

temp.add("1");

temp.add("2");

替换成：

temp.add(new Student("123", "Guangzhou"));
temp.add(new Student("456", "Zhuhai"));

再把hellovelocity.vm的内容改为：

#foreach ($s in $students)
<$velocityCount> Address: $s.address
#end

重新编译和执行运行命令，结果如下：

<1> Address: Guangzhou
<2> Address: Zhuhai

这样把list中Student的数据打印了出来，大功告成！这里用了Velocity的内建变量$velocityCount，指的是默认的列举序号，从1开始，也可以改成0开始，但需要在Velocity.properties中更改，Velocity.properties位于velocity-1.4.jar包内的目录org/apache/velocity/runtime/defaults 下。

再复杂一些的迭代怎么处理呢？我们看看下面的模版例子就清楚了：

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

看出来了吧，Velocity是支持标签嵌套的，这个可是很强大的功能，这里就不深入演示了，如果有兴趣，自己试试吧。

其实，稍为深入思考刚刚我们举的例子，就已经可以看出来，Velocity的用处在哪里？即Servlet + Velocity的模式，另外，还记得我们早期Jsp开发的模式Jsp+JavaBean吗？在这里，我们更改为Servlet+JavaBean+Velocity，想想，是不是已经替代了Jsp+JavaBean，并更彻底的把Java代码去除在Jsp（vm）外，如果光使用Struts（Servlet+Jsp），那么带来的代价是Java代码总或多或少出现在Jsp上，即使可以做到不出现Java代码，但做过复杂架构系统的开发者都知道，代价也是很昂贵的，并且在可维护性、和网页设计师的集成开发上存在一定的困难，所以我们在这里能感觉到，Servlet+JavaBean+Velocity的模式较好的实现了OOD的概念。而在效率上，大家也不用担心，此种结合方式比Servlet+Jsp的方式要高效一些。

愿意了解Velocity的人应该不少，但真正实用到项目的，也许不多（还是有些项目在使用，如Jute），毕竟和Jsp比起来，Jsp更标准、更广泛使用和有不少开发工具已经支持Jsp开发。但Velocity的功能不会仅仅局限在和Jsp竞争的局面，由上可看出它在自动代码输出方面功能很强，前面提到Turbine就是采用Velocity来生成很多代码，你也可以稍加改动就可以做成代码生成器，或其他模版生成上，都是很不错的想法。

好了，我们再来看看要深入Velocity来做项目，还需要注意的一些常见问题吧，首先是国际化的问题，

Velocity本身支持模版的国际化编码转换，看看Velocity提供的方法：

Public Template getTemplate (Stirng template, String encoding)，

由此推测这样做其实不能彻底的做到国际化。

最简单的在Struts中国际化的概念，即在Jsp上使用国际化语言标签的方式来做到，而每种语言采用不同的语言标签库的方式，引申到这里，其实手工来做一样可以做到，只不过需要稍加手工处理而已。

好在已经有人处理了上面所说问题，做成了Velocity的tools: MessageTool，提供了变量text包含国际化标签，这样只需要简单的编写标签代码即可，如：$text.get(‘title’)，更多具体的内容还可在http://jakarta.apache.org/velocity/tools/struts/MessageTool.html 中了解。

好了，基于Velocity的介绍我们就说这么多，再说说其他引伸方面的内容吧。有人评论Velocity不是标准的MVC结构，没错，刚开始我们就说过Velocity只是Model和View之间的良好结合，只是个好的模版引擎，毕竟还没有形成MVC三者良好的结合。好在Apache又基于Struts和Velocity的结合，推出了VelocityStruts，这部分的陈述我们可以在后面的专题里再推出，这里简单介绍它的概念，它是在Struts的结构上，在业务逻辑处理的Action后，把业务流程转向基于Velocity的显示层，从而代替Jsp作为View层。以上我们也看到了所举的例子基本上只是基于原理和演示，没有和Web开发紧密结合起来，这方面内容我们在讲述VelocityStruts的内容时再来结合吧。

谈到Velocity，在这里要顺便提提FreeMarker，FreeMarker也是一种模版引擎，和Velocity功能基本类似，都是简单和轻量级的工具，但功能上较Velocity有不少增强的地方，这我们也在以后的文章中再来深入了解吧。

0 0