Java的模板引擎Velocity（转载）

不少人看过或了解过Velocity，名称字面翻译为：速度、速率、迅速，用在Web开发 里，用过的人可能不多，大都基本知道和在使用Struts，到底Velocity和Struts是如何联系，怎么看待Velocity呢？让我们来尝试一 下，了解Velocity的概念，通过在这里的介绍，强调在技术选择上的问题，让大家在选择项目开发时，可以考虑Velocity，另外也让大家了解它的 思想，毕竟它提供了一个很好的思维方式，给大家换换筋骨，换一种思考的方式。

本文基于你对Java开发有一定基础，知道MVC，Struts等开发模式。

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

其实说白了Velocity也就是MVC架构的一种实现，但它更多的是关注在Model和 View之间，作为它们的桥梁。对于MVC的最流行架构Struts来说，相信大家都不陌生，很多开发人员已经大量在使用Struts架构，包括IBM的 Websphere 5以上的管理平台版本，Struts技术很好的实践了MVC，它有效的减少Java代码在View（Jsp）中的出现，但在Model和View之间还是 依靠Struts的Taglib技术来实现，试想如果前台开发的网页设计师对Struts乃至Taglib不熟（相信也挺难熟的，包括后期的维护人员也一 样），将会对网页设计师和前台开发工程师的相互协作开发带来很大的难度，现实开发中也还是存在这样事实，网页设计师和前台开发之间的工作或多或少还是存在 一定的耦合，怎样最大限度的解决这个难题呢？还是让我们来看看Velocity或者说这个概念吧。

先做一个最简单的Velocity开发例子，让大家看看Velocity是怎样工作的：

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

Welcome $name to Javayou.com!

today is $date.

2、创建1个java文件，HelloVelocity.java，内容：

package com.javayou.velocity;

import java.io.StringWriter;

import java.util.*;

import org.apache.velocity.app.VelocityEngine;

import org.apache.velocity.Template;

import org.apache.velocity.VelocityContext;

/**

* @author Liang.xf 2004-12-14

*/

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());

}

}

3、在http://jakarta.apache.org/site/binindex.cgi 上下载Velocity 1.4 zip，解压后获取velocity-1.4.jar，用它来编译上面的类HelloVelocity.java。

4、把1上的hellovelocity.vm copy到运行的当前目录下，运行HelloVelocity还需要其他类包，可以从下载后的velocity1.4.zip来，\\velocity- 1.4\\build\\lib，把commons-collections.jar、logkit-1.0.1.jar引入后运行java -cp .\\bin; -Djava.ext.dirs=.\\lib2 com.javayou.velocity.HelloVelocity，假设class编译到.\\bin目录，而我们所需的类包放到.\\lib2目 录内，运行结构如下：

Welcome Liang to Javayou.com!

today is Tue Dec 14 19:26:37 CST 2004.

以上是最简单的运行结果，怎么样，知道个大概吧，模版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层含义：第1种是如果student是hashtable，则将从 hashtable中提取key为No和Address的值，另外第2种就是它有可能是调用方法，即上面2个变量将被转换为 student.getNo()和student.getAddress()。Velocity对在servlet中的java code返回的值有对象，还可以调用对象的方法，如$ student.getAddress()等等，在此就不一一举例和深入了。

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

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

#set( $iAmVariable = "good!" )

Welcome $name to Javayou.com!

today is $date.

$iAmVariable

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

Welcome Liang to Javayou.com!

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 )

$product

#end

执行运行命令，结果：

1

2

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

#foreach($key in $hashVariable.keySet() )        

$key ‘s value: $ hashVariable.get($key)

#end

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

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

package com.javayou.velocity;

/**

* @author Liang.xf 2004-12-14

*/

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的内容时再来结合吧。