首先简单的介绍一下 Velocity 的 Layout 技术。Velocity 的 Layout 是通过 VelocityTools 这个项目来实现的。大多数网站上每个页面基本上都会遵循相同的排版,例如一个页面由 banner 条、内容和底部版权说明组成。那么对于该网站上的每个网页,我们都需要编写重复的代码来显示 banner 条以及底部版权说明。而 Velocity 的 Layout 技术可以让我们把页面的布局和页面的内容分开到不同 velocity 模板文件中。要使用 Layout 技术只需要把 VelocityViewServlet 换成 VelocityLayoutServlet 即可。VelocityLayoutServlet 内置了一个变量 $screen_content,它首先执行内容模板页面并把执行后的字符串结果存入 $screen_content 变量中,然后再去执行布局页面,这样就相当于把内容页面嵌入到布局页面。
但是这个问题在 Struts 2 环境中就要麻烦很多。因为 Struts 2 并不是采用 Velocity Tools 那种基于 Servlet 的方式来调用 velocity 模板,所以我们没法只是简单的替换成 VelocityLayoutServlet 就能解决。在 Struts 2 的默认配置中定义了一个名为 velocity 的 ResultType,它对应的类是 org.apache.struts2.dispatcher.VelocityResult 。该类没有跟 Velocity Tools 打交道,而是直接调用 Velocity 的核心 API 来执行 velocity 模板。因此我们只好根据 Velocity Tools 项目中 VelocityLayoutServlet 的思路来改写 Struts 2 对 velocity 模板的处理方法。
在处理之前我们先大概解释一下 VelocityLayoutServlet 的工作原理,先看几个程序源码:
关于 ResultType
Struts 2 中把各种各样的视图例如 JSP、Velocity、FreeMarker 等等都封装成 ResultType 的子类,也就是说每一种视图 Struts 2 都有与之对应的 ResultType 的实现类, 本文中 Velocity 视图对应的类是 VelocityResult
<!-- layout.vm -- > <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <HTML> <HEAD> <TITLE>${page_title}</TITLE> </HEAD> <BODY> ${screen_content} </BODY> </HTML>
上面是布局页面的代码,这个布局页面包含两个变量,一个是 $page_title,用来指定页面标题;第二个是 $screen_content,这是 VelocityLayoutServlet 定义的变量,这个变量最终会被替换成实际页面的内容。
## index.vm #set($layout = “layout.vm”) ##选择布局页面 #set($page_title =”Struts2Velocity”) #set($name = “Winter Lau”) <p> Hello <b>$name</b>, Welcome to Struts2 with velocity <br/> </p>
面是另外一个页面 index.vm 的代码。当 VelocityLayoutServlet 处理 index.vm 时,首先执行 index.vm,并把执行后的结果保存在一个字符串中,并往 VelocityContext 中增加变量名为 $screen_content,值为 index.vm 的执行结果,然后执行 layout.vm 页面,这样最终呈现在用户面前的就是 index.vm 嵌入在 layout.vm 的效果。
因此我们可以依照上面的原理,从 VelocityResult 中继承一个子类并重写其 doExecute 这个方法。详细的代码请看附件中的源码。
类编写完毕同样需要对 Struts 进行如下配置(struts.xml),这个配置是告诉 Struts 使用 struts2.VelocityLayoutResult 这个类来处理采用 velocity 开发的视图:
<result-types> <result-type name="velocity" class="struts2.VelocityLayoutResult"/> </result-types>
接下来就可以测试新的功能了,我们配置 action 如下,打开浏览器访问 http://localhost:<port>/index.do 看看效果吧。
<action name="index"> <result type="velocity">/index.vm</result> </action>
这样我们不需要 VelocityTools 也可以让 Struts 2 支持 Velocity Layout 了。