[size=medium]Velocity 基础
Velocity是一个基于java的模板引擎(template engine)。它允许任何人仅仅简单的使用模板语言(template language)来引用由java代码定义的对象。 当Velocity应用于web开发时,界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点,也就是说,页面设计人员可以只关注页面的显示效果,而由java程序开发人员关注业务逻辑编码。Velocity将java代码从web页面中分离出来,这样为web站点的长期维护提供了便利。
l 什么是Velocity模板?
Velocity模板可以是任意的文本文件,里面包含专门的模板语言(VTL),VTL提供简单整洁的方式合并页面的动态内容。
l Velocity的工作方式
Velocity可以通过获取Java对象的属性、函数返回值替换模板里面的VTL标记,从而生成新的文件,该文件可以是html、xml或SQL等任意文本。
l Velocity的几种使用方式
1. 通过Velocity提供的VelocityViewServlet类动态生成页面。
1) 创建网站项目,在web.xml加入映射,让VelocityViewServlet处理所有以.vm结尾的模板文件
<servlet>
<servlet-name>velocityView</servlet-name>
<servlet-class>org.apache.velocity.tools.view.servlet.VelocityViewServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>velocityView</servlet-name>
<url-pattern>*.vm</url-pattern>
</servlet-mapping>
2) 创建demo.vm文件,在VTL里,变量以$开头,可以指向各种引用,可以是Java对象、数组等,#set为设置变量命令。
#set($hello="Velocity")
#set($list=["pine", "oak", "maple"])
<html>
<head>
<title>Hello</title>
</head>
<b>
Welcome to ${hello} World !<br/>
action: ${request.getParameter("action")}
<br/>
#foreach ($elem in $list)
This is $elem.<br>
#end
</b>
</html>
3) 在浏览器里直接访问http://localhost:8080/testVelocity/demo.vm?action=VelocityTest可以看到页面
Welcome to Velocity World !
action: VelocityTest
This is pine.
This is oak.
This is maple.
html源代码为:
<html>
<head>
<title>Hello</title>
</head>
<b>
Welcome to Velocity World !<br/>
action: VelocityTest
<br/>
This is pine.<br>
This is oak.<br>
This is maple.<br>
</b>
</html>
2. 通过自定义的Servlet创建VelocityContext和Template,生成模板结果插入到Response流中返回给客户端。
1) 新建模板demo2.vm
<table border=1>
#foreach($name in $ team)
<tr><td>$name </td></tr>
#end
</table>
2) 继承HttpServlet创建一个Servlet,在doGet或doPost里调用Velocity提供的类转换模板
3) 加载模板
Template template = Velocity.getTemplate("/vm/stock.vm", "GBK");
4) 建立上下文对象,该对象初始化传入模板的参数
VelocityContext context = new VelocityContext();
context.put("team", new String [] { "gkzhong", "hrch", "zwli", "路人甲" });
5) 获取输出流,并输出模板生成结果
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(response.getOutputStream(),
"GBK"));
template.merge(context, writer);
writer.flush();
writer.close();
6) 模板页面枚举传入的数组对象,页面将输出html如下
<table border=1>
<tr><td>gkzhong </td></tr>
<tr><td>hrch </td></tr>
<tr><td>zwli </td></tr>
<tr><td>路人甲 </td></tr>
</table>
3. 通过继承VelocityServlet,实现指定函数返回模板结果,以替换JSP的功能。
1) 通过继承VelocityServlet,可以更方便地生成页面,子类需要实现VelocityServlet的以下函数
public Template handleRequest(HttpServletRequest request, HttpServletResponse response, Context context)
protected java.util.Properties loadConfiguration(ServletConfig config)
2) loadConfiguration用作载入模板所需要的配置
3) 在handleRequest里,通过使用context设置要传入模板的参数,返回一个Template对象,该Template最终将整合context和Response输出流返回给客户端
4. 在任意Java类里创建VelocityContext和Template生成静态数据到任意位置。
1) 在Java类里生成模板结果和方法2完全一致,主要是生成时机和用途不一样,通过Java类可以在Linux服务器上用作定时生成静态页面
l Velocity开发环境搭建
1. 到官方站点(http://velocity.apache.org)下载最新的velocity-1.5.zip和velocity-tools-1.4.zip
2. 解压lib目录的jar包到项目classpath即可
l 模板的应用场景
1. 使用方法1,替代jsp展示页面
2. 使用方法2、3,替代Jsp充当视图的角色
3. 使用方法4,生成大量静态页面
4. 使用任一方法,在项目中分工明确,便于维护
l Velocity模板语言(VTL)预览(详细参考模板组技术文档)
1. 定义变量
#set($A = "I’ am " )
#set($B = "Peter" )
#set($word = "$A/$B" )
那么$word将输出I’ am Peter
2. 循环
#foreach ($element in $list)
This is $element.
$velocityCount
#end
3. 条件语句
#if (condition)
#elseif (condition)
#else
#end
4. 注释
## ….
#* ..
..
*#
5. 关系和逻辑操作符
#if($foo && $bar)
<strong> This AND that</strong>
#end
6. Velocity 中的宏
定义:
#macro(宏的名称 $参数1 $参数2 …)
语句体(即函数体)
#end
使用:#宏的名称($参数1 $参数2 …)
7. 特殊命令
#stop 停止执行模板引擎并返回
#include与#parse 引入本地文件
8. 内置对象$request、$response、$session 可以直接访问[/size]
Velocity是一个基于java的模板引擎(template engine)。它允许任何人仅仅简单的使用模板语言(template language)来引用由java代码定义的对象。 当Velocity应用于web开发时,界面设计人员可以和java程序开发人员同步开发一个遵循MVC架构的web站点,也就是说,页面设计人员可以只关注页面的显示效果,而由java程序开发人员关注业务逻辑编码。Velocity将java代码从web页面中分离出来,这样为web站点的长期维护提供了便利。
l 什么是Velocity模板?
Velocity模板可以是任意的文本文件,里面包含专门的模板语言(VTL),VTL提供简单整洁的方式合并页面的动态内容。
l Velocity的工作方式
Velocity可以通过获取Java对象的属性、函数返回值替换模板里面的VTL标记,从而生成新的文件,该文件可以是html、xml或SQL等任意文本。
l Velocity的几种使用方式
1. 通过Velocity提供的VelocityViewServlet类动态生成页面。
1) 创建网站项目,在web.xml加入映射,让VelocityViewServlet处理所有以.vm结尾的模板文件
<servlet>
<servlet-name>velocityView</servlet-name>
<servlet-class>org.apache.velocity.tools.view.servlet.VelocityViewServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>velocityView</servlet-name>
<url-pattern>*.vm</url-pattern>
</servlet-mapping>
2) 创建demo.vm文件,在VTL里,变量以$开头,可以指向各种引用,可以是Java对象、数组等,#set为设置变量命令。
#set($hello="Velocity")
#set($list=["pine", "oak", "maple"])
<html>
<head>
<title>Hello</title>
</head>
<b>
Welcome to ${hello} World !<br/>
action: ${request.getParameter("action")}
<br/>
#foreach ($elem in $list)
This is $elem.<br>
#end
</b>
</html>
3) 在浏览器里直接访问http://localhost:8080/testVelocity/demo.vm?action=VelocityTest可以看到页面
Welcome to Velocity World !
action: VelocityTest
This is pine.
This is oak.
This is maple.
html源代码为:
<html>
<head>
<title>Hello</title>
</head>
<b>
Welcome to Velocity World !<br/>
action: VelocityTest
<br/>
This is pine.<br>
This is oak.<br>
This is maple.<br>
</b>
</html>
2. 通过自定义的Servlet创建VelocityContext和Template,生成模板结果插入到Response流中返回给客户端。
1) 新建模板demo2.vm
<table border=1>
#foreach($name in $ team)
<tr><td>$name </td></tr>
#end
</table>
2) 继承HttpServlet创建一个Servlet,在doGet或doPost里调用Velocity提供的类转换模板
3) 加载模板
Template template = Velocity.getTemplate("/vm/stock.vm", "GBK");
4) 建立上下文对象,该对象初始化传入模板的参数
VelocityContext context = new VelocityContext();
context.put("team", new String [] { "gkzhong", "hrch", "zwli", "路人甲" });
5) 获取输出流,并输出模板生成结果
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(response.getOutputStream(),
"GBK"));
template.merge(context, writer);
writer.flush();
writer.close();
6) 模板页面枚举传入的数组对象,页面将输出html如下
<table border=1>
<tr><td>gkzhong </td></tr>
<tr><td>hrch </td></tr>
<tr><td>zwli </td></tr>
<tr><td>路人甲 </td></tr>
</table>
3. 通过继承VelocityServlet,实现指定函数返回模板结果,以替换JSP的功能。
1) 通过继承VelocityServlet,可以更方便地生成页面,子类需要实现VelocityServlet的以下函数
public Template handleRequest(HttpServletRequest request, HttpServletResponse response, Context context)
protected java.util.Properties loadConfiguration(ServletConfig config)
2) loadConfiguration用作载入模板所需要的配置
3) 在handleRequest里,通过使用context设置要传入模板的参数,返回一个Template对象,该Template最终将整合context和Response输出流返回给客户端
4. 在任意Java类里创建VelocityContext和Template生成静态数据到任意位置。
1) 在Java类里生成模板结果和方法2完全一致,主要是生成时机和用途不一样,通过Java类可以在Linux服务器上用作定时生成静态页面
l Velocity开发环境搭建
1. 到官方站点(http://velocity.apache.org)下载最新的velocity-1.5.zip和velocity-tools-1.4.zip
2. 解压lib目录的jar包到项目classpath即可
l 模板的应用场景
1. 使用方法1,替代jsp展示页面
2. 使用方法2、3,替代Jsp充当视图的角色
3. 使用方法4,生成大量静态页面
4. 使用任一方法,在项目中分工明确,便于维护
l Velocity模板语言(VTL)预览(详细参考模板组技术文档)
1. 定义变量
#set($A = "I’ am " )
#set($B = "Peter" )
#set($word = "$A/$B" )
那么$word将输出I’ am Peter
2. 循环
#foreach ($element in $list)
This is $element.
$velocityCount
#end
3. 条件语句
#if (condition)
#elseif (condition)
#else
#end
4. 注释
## ….
#* ..
..
*#
5. 关系和逻辑操作符
#if($foo && $bar)
<strong> This AND that</strong>
#end
6. Velocity 中的宏
定义:
#macro(宏的名称 $参数1 $参数2 …)
语句体(即函数体)
#end
使用:#宏的名称($参数1 $参数2 …)
7. 特殊命令
#stop 停止执行模板引擎并返回
#include与#parse 引入本地文件
8. 内置对象$request、$response、$session 可以直接访问[/size]