软件项目实训及课程设计指导——如何在Web应用系统表示层开发实现中应用Velocity模板技术

1、分离Web表示层的数据处理和展现逻辑的常见的应用技术

分离Web表示层的数据处理和展现逻辑是目前企业级的Web应用系统开发中表现层组件开发实现中的基本实现目标。为此，软件应用系统的设计和开发实现人员必须要寻找到一种能够减少软件开发人员重复劳动的方法，让程序员将更多的精力放在业务逻辑以及其它更加具有创造力的工作上。

因此，读者在课程设计的项目开发中，不应该在Web页面中出现包含大量的服务器端脚本程序代码的Web页面状况，这样的Web应用系统在后期的系统维护、升级中都会比较困难。

如下示图所示的程序代码示例是不良好的Web表示层程序实现的代码示例，因为不仅在Web页面（*.jsp）中包含有大量的Java程序脚本的代码，而且在JSP页面中直接访问数据库（没有合理地进行分层设计）和应用System.out.print控制台信息的输出语句（此语句只能将信息打印输出到服务器主机的系统控制台上而不能输出到Web浏览器中，前端用户根本就无法浏览到相关的信息）。

希望读者在学习和阅读作者的《软件项目实训及课程设计指导》系列文章的内容时，重点掌握目前比较主流的分离Web表示层的数据处理和展现逻辑的技术实现方法——比如，采用CSS+Div分离Web表示层数据和表现、应用XML+XSLT技术彻底分离数据和样式、应用Velocity模板技术实现开发职责分离，并能够在课程设计的项目开发中应用作者在本系列文章中介绍的各种方法。

当然，分离Web表示层的数据处理和展现逻辑目前其实有多种不同的实现方式，不仅仅局限于作者在上文中所提及和介绍过的方法，比如同样很优秀的 Freemarker 也获得了非常广泛的应用。因此，读者在项目开发实现中应该要根据项目的具体需要和自己对具体技术实现的熟悉程度合理地选用。

作者在下文中将为读者介绍如何在J2EE 系统平台中的Web应用系统表示层开发实现中应用Velocity模板技术。但作者考虑到Velocity模板技术以及随后几篇文章中将要介绍的Struts和Struts2应用框架等技术在目前高校的课堂教学中一般都不会涉及，因此部分读者可能在阅读本系列文章的内容时对Velocity模板技术和Struts2应用框架会感觉比较陌生，给读者的学习和理解会带来一定的难度。

作者建议读者在课程设计的项目开发中能够应用Velocity模板技术，经过一段时间的项目开发和应用的实践，也就能够慢慢地熟悉和掌握Velocity模板技术和Struts2应用框架等应用技术。

2、什么是J2EE 系统平台中的Velocity模板技术

Velocity是Apache 基金会的一个开源的模板引擎（Template Engine）项目，其初始开发的主要目标是分离 基于MVC 体系架构设计模式的应用系统的持久化层和业务层，但目前被广泛地应用于J2EE Web应用系统中的表示层组件开发中。它能够允许Web开发者在不使用传统的JSP页面的应用情况下，可以用 Velocity模板让HTML页面也能够具有动态内容的特性。

如下示图为Apache Velocity的官方网站页面中对Velocity模板相关技术特性和应用介绍的文字局部截图。

读者可以从Velocity的官方网站上下载Velocity的系统运行包文件和技术参考文档等系统库和资料，然后再解包该系统库的运行包文件，请见下图所示的下载页面。

Velocity是一种基于Java系统平台的模板引擎，它允许软件应用系统的开发人员使用简单而强大的模板语言来引用哪些定义在Java程序代码中的对象。而且Velocity应用具有简洁的语法和采用类似脚本语言的方式引用目标数据对象。

Velocity模板引擎本身不是采用标准的模型视图控制器（MVC）体系结构设计，它只是Web应用系统中的"模型组件"和"视图组件"之间的桥梁。并为Web页面的前端开发和制作人员提供了一种清晰而又简单的模板语法，而且模板和程序代码是分离的。

所以Web应用系统的开发人员可以分别独立地开发和维护它们，Web前端开发人员可以和后端Java 程序开发人员同步开发一个遵循 MVC体系架构的Web应用系统。而且目前的Velocity 模板引擎也很容易能够集成到J2EE Web容器的运行环境中——如Servlet容器中，也很容易能够与Struts应用框架和Struts2应用框架相互集成。

因为Velocity 模板引擎的强大之处在于它严格地区分Web应用系统项目开发中的人员职责划分——页面开发人员只需要把精力和关注点放在数据的显示功能实现部分，而Java程序员更多地只需要关注如何编程应用系统中的控制层程序和商业业务逻辑、系统中数据库表中数据的访问控制和管理等方面的功能实现。

Velocity 模板是一个目前比较流行的JSP页面技术的替代物，并且能够实现把 Java 程序代码从Web页面中分离出来。

3、Velocity 模板语言VTL

Velocity 模板使用的脚本语言称为 Velocity 模板语言（VTL，Velocity Template Language），但它和其它形式的脚本语言（如JavaScript等）相比，Velocity 模板语言的语法相对而言比较简单。

在Velocity 模板语言中提供有变量定义、指令、注释、对象的引用和各种运算符、宏定义等，也还提供了许多的内置对象。比如下面的代码语句是设置变量someVarable的值为"Velocity"：#set( $someVarable= "Velocity" )。

在上面的代码中读者可以看到很多以"#"和"#34;字符开头的内容，这些都是 Velocity 模板语言的语法。在 Velocity模板语言中所有的关键字都是以"#"开头的，而所有的变量则是以"#34;开头。Velocity 模板语言的语法类似于 JSP 技术中的 JSTL（JSP标准的标签库）。

作者考虑到本文章的篇幅有限，在此文中不能详细地为读者介绍Velocity 模板语言的语法，读者有兴趣可以参考 和阅读Velocity 的官方文档，其中提供了Velocity 语法相关的详细内容。

4、Velocity模板系统库中的VelocityServlet组件类

虽然大多数基于Velocity模板的Java应用都是基于J2EE Servlet的Web应用系统，但其实Velocity模板是可以应用于J2SE的应用程序和J2EE Web应用程序的两种不同的开发环境中。但作者在本文中主要介绍在J2EE Web应用程序的开发环境中如何应用Velocity模板。

但由于Velocity模板只是一个模板引擎，读者如果需要在J2EE Web应用系统项目中应用Velocity模板，还需要在项目中添加一个HTTP框架以便能够处理HTTP请求（request）和转发（response）。

为此，在Velocity模板所提供的系统程序包中，提供有一个VelocityServlet组件类（org.apache.velocity.servlet.VelocityServlet），Web应用系统只需要继承并扩展它便可以很快地创建一个基于Velocity模板功能处理的Servlet程序，也就是通过继承VelocityServlet 组件类以产生出自己的Servlet组件。

由于Velocity 模板的系统库不断地在更新和升级，如果读者通过继承VelocityServlet 组件类以产生出自己的Servlet组件时出现如下的提示信息："the type VelocityServlet is deprecated"，说明读者所下载的Velocity 模板系统库中已经将VelocityServlet升级替换为org.apache.velocity.tools.view.VelocityViewServlet类，读者只需要将VelocityServlet类修改为VelocityViewServlet类。

如下示图为Velocity官方网站页面中对新版本的Velocity 模板系统库中的VelocityViewServlet类的定义说明局部截图。

在自己派生出的Servlet组件中可以获得与HTTP请求相关的request、session与application等对象，从而也可以直接获得通过Servlet容器保存在这几个域对象中的值或者返回业务处理后的结果值。

因此，应用Velocity 模板技术可以分离Web应用系统中的业务处理逻辑和数据显示风格控制逻辑。

5、在Web表示层开发实现中应用Velocity模板的基本步骤

Velocity 的任何模板都可以被VelocityServlet使用、并且能够部署在服务器上，也相对比较简单。只需要采用以下的开发实现步骤：

（1）Web应用系统的开发人员首先通过继承 org.apache.velocity.servlet.VelocityServlet 类（或者org.apache.velocity.tools.view.VelocityViewServlet类）并派生出自己的Servlet 程序类；

（2） 其次，在所派生出的Servlet 程序类中，重写并实现其中的一个handleRequest()方法，在 handleRequest() 的方法实现中，从文件或资源（如JAR文件）中取得模板文件并返回该模板；

如下示图为Velocity官方网站页面中对handleRequest()的方法定义及功能、返回参数的说明局部截图。

（3）最后，在重写的handleRequest() 的方法实现中，添加希望在模板中作为上下文属性使用的数据或Velocity工具，并且由VelocityServlet向浏览器响应输出——可以由它在向HttpServletResponse的OutputStream 流对象发送之前生成要响应输出的 HTML标签。

体现在Web表示层开发实现中应用Velocity模板的基本步骤相关的程序代码示例如下，读者可以根据自己的应用项目的需要进行修改和扩展。

public class VelocityServletDemo extends VelocityViewServlet {
      @Override
      protected Template handleRequest(HttpServletRequest request, HttpServletResponse response, Context ctx) {
            /** 在Context上下文环境容器对象实例中存放指定名称的变量值 */
            ctx.put("someVarableName","someVarableValue");
            /** 也可以在request域对象实例中存放指定名称的变量值 */
            request.setAttribute("someVarableName","someVarableValue");
            …
            … 其它的程序代码，在此省略
            …
            /** 在业务处理完毕后再 forward转发到指定模板 */
            return getTemplate("myVelocityTemplate.html");
      }
}

Velocity 模板文件是文本格式的文件，并且它可以是HTML、XML等类型的文件（上面的程序代码示例中的模板文件名称为myVelocityTemplate.html）。但在模板文件中一般包括有如下几个不同部分的内容：

1）照原样合并的静态部分

2）将被要合并的数据替代的占位符

3）脚本语言中的指示符和指令。

如下页面代码为上面程序代码中最终转发到的myVelocityTemplate.html模板文件代码示例，它与标准的HTML页面差别在于其中包含有黑体标识的数据获取表达式，如$userName、$userPassword等。

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=gb2312">
      <title>一个简单的VelocityWeb应用页面</title>
</head><body>
      <center> <h2>下面为Servlet处理后的结果</h2></center>
      <table cellspacing="0" cellpadding="5" width="200" align="center">
          <tr><td >用户名称</td><td >用户密码</td></tr>
          <tr><td>$userName</td><td>$userPassword</td></tr>
      </table>
</body></html>

另外，myVelocityTemplate.html页面为静态的HTML页面而不是动态的服务器端的JSP页面，因此页面的响应速度将会大大地提高，从而应用Velocity 模板技术的Web页面可以是非JSP类型的Web页面——达到"动态内容静态化"的应用效果。

6、如何在派生的Servlet程序中向响应输出的目标页面传递数据

J2EE Web应用系统的开发人员只需要把数据放置到Velocity的上下文对象中（org.apache.velocity.context.Context），然后Velocity引擎使用Velocity上下文对象中的数据、并应用到模板文件中，最后按照模板文件的格式输出数据。在上面的示例代码中的如下语句则是在模板文件中获得保存在Velocity上下文对象中的指定名称的数据值，然后在表格行中显示。

<tr><td>$userName</td><td>$userPassword</td></tr>

7、与Velocity模板相关的两个重要的概念

（1）Velocity模板（Template类）

它是遵守Velocity VTL模板语言的语法规则定义的一个文本格式的文件，该文件采用Velocity语言定义模板文件。比如下面的程序示例代码是获得指定文件名称为VelocityTemplate.vm的模板文件，并指定所应用的编码格式为中文GB2312编码：

Template oneTemplateObject =
						oneVelocityObject.getTemplate("VelocityTemplate.vm","gb2312");

在默认的情况下，Velocity模板引擎的系统程序会在Web应用系统资源根路径下搜索*.vm文件，所以开发人员直接将*.vm文件放在Web应用系统资源根路径下即可（当然，也可以通过配置velocity.properties文件中的配置项目来指定加载的路径）。

（2） Velocity上下文（VelocityContext类）

它是Velocity模板引擎系统的一个容器，用于保存相关的业务数据。开发人员可以把Velocity模板上下文VelocityContext类看作是导入 Java 对象并在 Velocity 模板内部访问的一种方法。

比如下面的程序代码是创建一个VelocityContext类的对象，并在其中保存需要向Web表示层页面传递的参数——参数的名称为userName，而对应的参数值为"张三"。

VelocityContext oneContextObject = new VelocityContext();
oneContextObject.put("userName", "张三");

因此，只需要通过创建 org.apache.velocity.context.Context 类型的对象实例就可以获得 Velocity 的上下文VelocityContext对象，然后利用上下文对象中的 put方法，把要导入到模板文件中的对象附加到上下文中。

当然，如果是采用继承VelocityViewServlet类而派生出自己的Servlet程序类，并在自己的Servlet程序类中重写handleRequest()方法的方式的程序中，不需要自行再创建出VelocityContext 类的对象实例，而直接应用handleRequest()方法中所携带的Context接口类型的对象实例（参看如下示例代码中的黑体标识的代码）。

protected Template handleRequest(HttpServletRequest request, HttpServletResponse response, Context ctx) {
 				…
        … 其它的程序代码，在此省略
        …
}

应用XML+XSLT技术分离Web应用表示层数据和样式的实例

如何应用“XML+XSLT”技术分离Web表示层数据和样式

如何应用CSS+Div分离Web表示层数据处理逻辑和展现逻辑

如何正确应用Web MVC架构模式分离表示层和模型层耦合关系

如何应用策略设计模式分离JDBC数据库连接中的外部环境信息