Velocity用户指南(中文版)(3)(完)

转载 2004年07月27日 10:58:00

指令(Directives)<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

引用允许模板设计者为Web站点生成动态内容,而指令使巧妙处理Java代码的脚本元素容易使用。

1#set

格式:#set( LHS = RHS )

l         LHS可以是变量引用或属性引用

l         RHS可以是引用、字符串、数字、ArrayListMap

下面的例子展示了上面的每种RHS类型:

对于ArrayListMap,可以使用对应的Java方法访问其中的元素值:

l         RHS可以是简单的算术表达式

算术表达式只支持整型。/的结果为整数;如果非整型数值,返回null

l         如果RHS的结果为null,是不会赋值给LHS

看下面的例子:

上面使用$result检查是否执行成功是有问题的。如果第一次执行成功,$result不为null,则后面的执行不管是否成功,检查条件总是成立。改进的方法是在每次执行前初始化为false

l         String文字可以使用双引号或单引号括起。两者的主要区别是双引号中的引用会替换成相应的值,而单引号中的引用原样输出

输出结果是:www/index.vm

如果使用单引号:

输出结果是:$directoryRoot/$templateName

l         使用双引号可以实现字符串的串联,如下面的例子:

2#if / #elseif / #else

#if指令在条件成立时,显示#if#end之间的内容,否则显示#else#end之间的内容。下面是一个例子:

条件成立有两种情况:

l         如果$fooboolean,则$foo要为true

l         否则,$foo不为null

#if指令中可以使用的关系和逻辑符号包括:

l         <<===>=>

l         &&(and)||(or)!(not)

3)循环:foreach

下面是一个例子:

$allProducts的内容可以是VectorHashtableArrayList,每次取出一个值赋值给$product;返回的值是一个Java对象,可以用来引用具体的方法。下面的例子假设$allProductsHashtable对象:

Velocity提供了访问循环计数变量的简单方法:

$velocityCount$customer.Name

$velocityCountVelocity表示循环计数的内部变量,缺省开始值为1。该设置在velocity.properties文件中定义:

可以在#foreach指令中使用范围操作符[n..m],其中nm必须是整型:

输出结果是:

4#include

#include指令导入本地文件到#include指令定义的地方。导入的文件内容不会被模板引擎解析。出于安全考虑,导入的文件应该放在TEMPLATE_ROOT目录下。一次可以导入多个文件,文件名之间用逗号分隔;并且通常使用变量引用来替代文件名。下面是一个例子:

5#parse

#parse指令允许导入一个包含VTL的本地文件,并由模板引擎进行解析。#parse指令导入的文件必须放在TEMPLATE_ROOT目录下,并且一次只能导入一个文件。允许在Velocity模板中嵌套执行#parse指令。最大深度由velocity.properties文件中的parse_directive.maxdepth定义。下面是一个例子:

包含的parsefoo.vm文件如下:

输出结果是:

6#stop

#stop指令停止模板引擎的执行并返回。这在Debug时很有用。

7#macro

#macro指令允许定义一段重复使用的VTL模板(称Velocimacros)。

l         Velocimacros可以有0或多个参数。下面是一个例子:

$something

这个叫tablerowsVelocimacro2个参数:一个color和一个array。下面的代码包含对

tablerows的调用:

 

输出结果为:

Superior

Michigan

Huron

Erie

Ontario

l         Velocimacros可以在VTL模板中定义为inline,这样对其它的VTL模板是无效的;要使Velocimacros在所有VTL模板中共享,可以将Velocimacros定义在Velocimacros模板库(全局)中。

l         Velocimacros属性在velocity.properties文件中定义,提供实现Velocimacros的灵活性:

velocimacro.library:定义逗号分隔的Velocimacros全局模板库,缺省是VM_global_library.vm,可以增加自定义的模板库;

velocimacro.permissions.allow.inline:指定是否允许在VTL模板中定义Velocimacros,缺省是true(允许);

velocimacro.permissions.allow.inline.to.replace.global:指定是否允许inline定义的Velocimacros替换同名的全局Velocimacros,缺省是false(不允许);

velocimacro.permissions.allow.inline.local.scope:指定inline定义是否是定义的模板中可见,缺省是false

velocimacro.context.localscope:指定context内容是否是本地范围的,缺省是false;如果设为true,则使用#set指令对context做的修改只在本地范围有效,不会永久性的影响context

velocimacro.library.autoreload指定是否自动装载Velocimacros模板库,缺省是false;如果设为true,则在调用Velocimacros模板库中的Velocimacro时,会检查模板库是否更新,并在需要时重新装载;使用前提是file.resource.loader.cache = false;该属性应该在开发时使用,而不是产品阶段;

l         Velocimacros必须在第一次使用之前进行定义。因此#parse指令包含inline定义的Velocimacros的模板会有问题,简单的解决方法就是将Velocimacros定义到模板库中,以便Velocity启动时装载。

l         引用作为Velocimacros的参数时,是使用by name形式的,这意味在Velocimacros内部每次使用时才会获得其值

l         Velocimacros的不能作为参数传递给另一个Velocimacros,如:

你可以采用下面的形式达到同样的目的:

下面是一个嵌套调用的例子:

输出的结果是:Outer : inner : outerlala

因为参数以by name形式传递,在#outer内部先设置$bar的值,再调用#inner

收藏助手
不良信息举报
您举报文章:Velocity用户指南(中文版)(3)(完)
举报原因:
原因补充:

(最多只允许输入30个字)