Velocity用户教程

亚瑟王 2022-04-20 667 Java

一、Velocity 是什么？

Velocity 是一个基于 java 的模板引擎（template engine）。它允许任何人仅仅简单的使用模板语言（template language）来引用由 java 代码定义的对象。

当 Velocity 应用于 web 开发时，界面设计人员可以和 java 程序开发人员同步开发一个遵循 MVC 架构的 web 站点，也就是说，页面设计人员可以只关注页面的显示效果，而由 java程序开发人员关注业务逻辑编码。Velocity 将 java 代码从 web 页面中分离出来，这样为 web站点的长期维护提供了便利，同时也为我们在 JSP 和 PHP 之外又提供了一种可选的方案。Velocity 的能力远不止 web 站点开发这个领域，例如，它可以从模板（template）产生 SQL和 PostScript、XML，它也可以被当作一个独立工具来产生源代码和报告，或者作为其他系统的集成组件使用。Velocity 也可以为 Turbine web 开发架构提供模板服务（templateservice）。Velocity + Turbine 提供一个模板服务的方式允许一个 web 应用以一个真正的MVC 模型进行开发。

二、Velocity 能为我们作什么？

1、 The Mud Store Example

假设你是一家专门出售 Mud 的在线商店的页面设计人员，让我们暂且称它为“在线 MUD商店”。你们的业务很旺，客户下了各种类型和数量的 mud 订单。他们都是通过输入用户名和密码后才登陆到你的网站，登陆后就允许他们查看订单并购买更多的 mud。现在，一种非常流行的 mud 正在打折销售。另外有一些客户规律性的购买另外一种也在打折但是不是很流行的 Bright Red Mud，由于购买的人并不多所以它被安置在页面的边缘。所有用户的信息都是被跟踪并存放于数据库中的，所以某天有一个问题可能会冒出来：为什么不使用velocity 来使用户更好的浏览他们感兴趣的商品呢？

Velocity 使得 web 页面的客户化工作非常容易。作为一个 web site 的设计人员，你希望每个用户登陆时都拥有自己的页面。

你会见了一些公司内的软件工程师，你发现他们每个人都同意客户应该拥有具有个性化的信息。那让我们把软件工程师应该作的事情发在一边，看一看你应该作些什么吧。

你可能在页面内嵌套如下的 VTL 声明：

<html>

<body>

Hello $customer.Name!

<table>

#foreach( $mud in $nudsOnSpecial )

#if ( $customer.hasPurchased( $mud ) )<tr><td>$flogger.getPromo( $mud )</td></tr>

#end

</table>

2、 Velocity Template Language(VTL):AN introduction

VTL 意味着提供最简单、最容易并且最整洁的方式合并页面动态内容。VTL 使用references 来在 web site 内嵌套动态内容，一个变量就是一种类型的 reference。变量是某种类型的 refreence，它可以指向 java 代码中的定义，或者从当前页面内定义的 VTLtatement 得到值。下面是一个 VTL statement 的例子，它可以被嵌套到 HTML 代码中：

#set ($a = “Velocity)

和所有的 VTL statement 一样，这个 statement 以＃字符开始并且包含一个 directive：

set。当一个在线用户请求你的页面时，Velocity Templating Engine 将查询整个页面以便发现所有＃字符，然后确定哪些是 VTL statement，哪些不需要 VTL 作任何事情。

＃字符后紧跟一个 directive：set 时，这个 set directive 使用一个表达式（使用括号封闭）――一个方程式分配一个值给变量。变量被列在左边，而它的值被列在右边，最后他们之间使用＝号分割。

在上面的例子中，变量是$a，而它的值是 Velocity。和其他的 references 一样以$字符开始，而值总是以双引号封闭。Velocity 中仅有 String 可以被赋值给变量。

记住以下的规则：

使用$字符开始的 references 用于得到什么；使用#字符开始的 directives 用于作些什么。

Hello Velocity World!

一旦某个变量被分配了一个值，那么你就可以在 HTML 文件的任何地方引用它。在下面的例子中，一个值被分配给$foo 变量，并在其后被引用。

<html>

<body>

#set ( $foo = “Velocity” )

Hello $foo World!

</body>

</html>

上面的实现结果是在页面上打印“Hello Velocity World！”

为了使包含 VTL directives 的 statement 更具有可读性，我们鼓励你在新行开始每个VTL statement，尽管你不是必须这么作。Set directive 将在后面详细描述。

注释

单行注释：## This is a single line comment.

多行注释：

#* Thus begins a multi-line comment. Online visitors won’t

see this text because the Velocity Templating Engine will

ignore it.

文档格式：

#**

This is a VTL comment block and may be used to store such information

as the document author and versioning information:

@version 5

@author

References

在 VTL 中有三种类型的 references：变量(variables)、属性(properties)、方法(methods)。作为一个使用 VTL 的页面设计者，你和你的工程师必须就 references 的名称达成共识，以便你可以在你的 template 中使用它们。

Everything coming to and from a reference 被作为一个 String 对象处理。如果有一个对象$foo 是一个 Integer 对象，那么 Velocity 将调用它的 toString()方法将这个对象转型为String 类型。

变量

格式要求同 java。

属性

例子：

$customer.Address

$purchase.Total

$customer.Address 有两种含义。

它可以表示：查找 hashtable 对象 customer 中以 Address 为关键字的值；也可以表示调用 customer 对象的 getAddress()方法。当你的页面被请求时，Velocity 将确定以上两种方式选用那种，然后返回适当的值。

方法

一个方法就是被定义在 java 中的一段代码，并且它有完成某些有用工作的能力，例如一个执行计算和判断条件是否成立、满足等。方法是一个由$开始并跟随 VTL 标识符组成的

References，一般还包括一个 VTL 方法体。例如：

$customer.getAddress()

$purchase.getTotal()$page.setTitle( “My Home Page” )

$person.setAttributes( [“Strange”, “Weird”, “Excited”] )

前两个例子$customer.getAddress()和$purchase.getTotal()看起来挺想上面的属性

$customer.Address 和 $purchase.Total。如果你觉得他们之间有某种联系的话，那你是正确的。

VTL 属性可以作为 VTL 方法的缩写。 $customer.Address 属性和使用$customer.getAddress()方法具有相同的效果。如果可能的话使用属性的方式是比较合理的。属性和方法的不同点在于你能够给一个方法指定一个参数列表。正式 reference 标记

reference 的正式格式如下：

${mudSlinger}

变量

${customer.Address}

属性

${purchase.getTotal()} 方法

非正是格式更见常用，但是有时还是使用正是格式比较适合。例如：你希望通过一个变

量$vice 来动态的组织一个字符串。

Jack is a $vicemaniac.

本来变量是$vice 现在却变成了$vicemaniac，这样 Veloctiy 就不知道您到底要什么了。

所以，应该使用正是格式书写

Jack is a ${vice}maniac

现在 Velocity 知道变量是$vice 而不是$vicemaniac。

Quiet reference notation

例如：

当页面的 form 被初始加载时，变量$email 还没有值，这时你肯定是希望它能够显示一

个 blank text 来代替输出”$email”这样的字段。那么使用 quiet reference notation 就比较合适。

这样文本框的初始值就不会是 email 而是空值了。

正式和 quiet 格式的 reference notation 也可一同使用，像下面这样：

Getting literal

Velocity 使用特殊字符$和#来帮助它工作，所以如果要在 template 里使用这些特殊字符要格外小心。本节将讨论$字符。

货币字符

在 VTL 中使用$2.5 这样的货币标识是没有问题得的，VTL 不会将它错认为是一个reference，因为 VTL 中的 reference 总是以一个大写或者小写的字母开始。

Escaping valid VTL referenceVTL 中使用“\”作为逃逸符。

例如：

#set( $email = “foo” )

$email

\$email

\\$email

\\\$email

将 render 为：

Foo

$email

\foo

\\$email

如果 email 变量没有被定义则

$email

\$email

\\$email

\\\$email

将被 render 为：

$email

\$email

\\$email

\\\$email

注意：VTL 中未被定义的变量将被认为是一个字符串，所以以下例子：

#set( $foo = “gibbous” )

$moon = $foo

的输出结果是：

$moon = gibbous

Case substitution

现在你已经对 reference 比较熟悉了，你可以将他们高效的应用于你的 template 了。

Velocity 利用了很多 java 规范以方便了设计人员的使用。例如：

$foo

$foo.getBar()

## is the same as

$foo.Bar

$data.getUser(“jon”)## is the same as

$data.User(“jon”)

$data.getRequest().getServerName()

# is the same as

$data.Request.ServerName

## is the same as

${data.Request.ServerName}

但是，注意 VTL 中不会将 reference 解释为对象的实例变量。例如：$foo.Name将被解释为 Foo 对象的 getName（）方法，而不是 Foo 对象的 Name 实例变量。

Directives

Reference 允许设计者使用动态的内容，而 directive 使得你可以应用 java 代码来控制你的显示逻辑，从而达到你所期望的显示效果。

#set

#set directive 被用于设置一个 reference 的值。例如：

#set ( $primate = “monkey” )

#set ( $customer.Behavior = $primate )

赋值左侧的（LHS）必须是一个变量或者属性 reference。右侧（RHS）可以是以下类型中一种：

l 变量 reference

l String literal

l 属性 reference

l 方法 reference

l number literal

l ArrayList

下面是应用各种类型的 RHS 的例子：

＃set ( $monkey = $bill ) ##变量 reference

＃set ( $monkey.Friend = “monica” ) ##String literal

＃set ( $monkey.Blame = $whitehouse.Leak )##属性 reference

＃set ( $monkey.Plan = $spindoctor.weave($web) )##方法 reference

＃set ( $monkey.Number = 123 )##Number literal

＃set ( $monkey.Say = [“Not”, $my, “fault”] )##ArrayList

注意：最后一个例子的取值方法为：$monkey.Say.get(0)

RHS 也可以是一个简单的算术表达式：

#set ( $value = $foo + 1 )

#set ( $value = $bar -1 )#set ( $value = $foo * $bar )

#set ( $value = $foo / $bar )

如果你的 RHS 是一个 null，VTL 的处理将比较特殊：它将指向一个已经存在的reference，这对初学者来讲可能是比较费解的。例如：

#set ( $resut = $query.criteria(“name”) )

The result of the first query is $result

#set ( $resut = $query.criteria(“address”) )

The result of the second query is $result

如果$query.criteria(“name”)返回一个“bill”，而$query.criteria(“address”)返回的是null，则显示的结果如下：

The result of the first query is bill

看看下面的例子：

#set( $criteria = ["name", "address"] )

#foreach( $criterion in $criteria )

#set( $result = $query.criteria($criterion) )

#if( $result )

Query was successful

#end

在上面的例子中，程序将不能智能的根据$result 的值决定查询是否成功。在$result被#set 后（added to the context），它不能被设置回 null（removed from the context）。

打印的结果将显示两次查询结果都成功了，但是实际上有一个查询是失败的。为了解决以上问题我们可以通过预先定义的方式：

#set( $criteria = [“name”, “address”] )

#foreach( $criterion in $criteria )

#set( $result = false )

#set( $result = $query.criteria( $criterion ) )

#if( $result )

Query was successful

#end

String Literals

当你使用#set directive，String literal 封闭在一对双引号内。

#set ( $directoryRoot = “www” )#set ( $templateName = “index.vm” )

#set ( $template = “$directoryRoot/$tempateName” )

$template

上面这段代码的输出结果为：www/index.vm

但是，当 string literal 被封装在单引号内时，它将不被解析：

#set ( $foo = “bar” )

$foo

#set ( $blargh = ‘$foo’ )

结果：

bar

$foo

上面这个特性可以通过修改 velocity.properties 文件的 stringliterals.interpolate =false 的值来改变上面的特性是否有效。

条件语句

if/elseif/else

当一个 web 页面被生成时使用 Velocity 的#if directrive，如果条件成立的话可以在页面内嵌入文字。例如：

#if ( $foo )

<strong>Velocity!</strong>

#end

上例中的条件语句将在以下两种条件下成立：

l $foo 是一个 boolean 型的变量，且它的值为 true

l $foo 变量的值不为 null

这里需要注意一点：Velocity context 仅仅能够包含对象，所以当我们说“boolean”时实际上代表的时一个 Boolean 对象。即便某个方法返回的是一个 boolean 值，Velocity 也会利用内省机制将它转换为一个 Boolean 的相同值。

如果条件成立，那么#if 和#end 之间的内容将被显示。

#elseif 和#else 元素可以同#if 一同使用。例如：

#if( $foo < 10 )

<strong> Go North </strong>

#elseif( $foo == 10 )

#elseif( $foo == 6 )

<strong> Go South </strong>

#else<strong> Go West </strong>

#end

注意这里的 Velocity 的数字是作为 Integer 来比较的――其他类型的对象将使得条件为false，但是与 java 不同它使用“＝＝”来比较两个值，而且 velocity 要求等号两边的值类型相同。

【下载地址】

百度网盘链接：https://pan.baidu.com/s/1Rjm5w46IsxtwmtDWTz447w

提取码：n84x

使用-JFreeChart来创建基于web的图表

ZooKeeper面试题（2020最新版）

Weblogic10.3_Windows优化设置

weblogic-部署和启动

WebLogic-Server-性能及调优-调优-Java-虚拟机

Java 虚拟机（Java virtual machine，简称 JVM）是一种虚拟“执行引擎”实例，可在微处理器上执行 Java 类文件中的字节码。调整 JVM 的方式会影响 Weblogic Server 和应用程序的性能。

Velocity用户教程

Velocity是一个基于java的模板引擎（template engine）。它允许任何人仅仅简单的使用模板语言（template language）来引用由java代码定义的对象。

Velocity用户手册

Velocity 用户手册是帮助页面设计者和内容提供者认识 Velocity 和其简单而功能强大的脚本语言――Velocity 模板语言（VTL）。在手册上的许多例子，都是用 Velocity 插入动态的内容到网页上，但是所有的 VLT 例子都能应用到其他的页面和模板中。

亚瑟王

文章热度： 9406

文章数量： 18

使用帮助

【Q&A】编辑器里面图片居中或上传失败的问题【公告】初次使用须知【公告】建议和意见【公告】使用指南【公告】友情链接【公告】