使用sitemesh建立复合视图

sitemesh是opensymphony团队开发的j2ee应用框架之一,旨在提高页面的可维护性和复用性。opensymphony的另一个广为人知的框架为webwork是用作web层的表示框架。他们都是开源的,可以在www.sf.net下找到。

应用于以下大项目的例子:http://opensource.thoughtworks.com/projects/sitemesh.html

简介:
sitemesh应用Decorator模式,用filter截取request和response,把页面组件head,content,banner结合为一个完整的视图。通常我们都是用include标签在每个jsp页面中来不断的包含各种header, stylesheet, scripts and footer,现在,在sitemesh的帮助下,我们可以开心的删掉他们了。如下图,你想轻松的达到复合视图模式,那末看完本文吧。

 

hello sitemesh:
  1. 在WEB-INF/web.xml中copy以下filter的定义:

xml 代码
  1. <filter>  
  2.   <filter-name>sitemesh</filter-name>  
  3.   <filter-class>com.opensymphony.module.sitemesh.filter.PageFilter</filter-class>  
  4. </filter>  
  5.   
  6. <filter-mapping>  
  7.   <filter-name>sitemesh</filter-name>  
  8.   <url-pattern>/*</url-pattern>  
  9. </filter-mapping>  
  10.   
  11. <taglib>  
  12.   <taglib-uri>sitemesh-decorator</taglib-uri>  
  13.   <taglib-location>/WEB-INF/sitemesh-decorator.tld</taglib-location>  
  14. </taglib>  
  15.   
  16. <taglib>  
  17.   <taglib-uri>sitemesh-page</taglib-uri>  
  18.   <taglib-location>/WEB-INF/sitemesh-page.tld</taglib-location>  
  19. </taglib>  
  20.   

copy所需jar和dtd文件至相应目录,访问opensymphony.sourceforge.net的cvs以获取sitemesh最新版本。

sitemesh.jarWEB-INF/lib
sitemesh-decorator.tldWEB-INF
sitemesh-page.tldWEB-INF

建立WEB-INF/decorators.xml描述各装饰器页面(可仿照sitemesh例子)。

xml 代码
  1. <decorators defaultdir="/_decorators">  
  2.     <decorator name="main" page="main.jsp">  
  3.         <pattern>*</pattern>  
  4.     </decorator>  
  5. </decorators>  

建立装饰器页面 /_decorators/main.jsp

xml 代码
  1. <%@ page contentType="text/html; charset=GBK"%>  
  2. <%@ taglib uri="sitemesh-decorator" prefix="decorator" %>  
  3.   
  4. <html>  
  5.   <head>  
  6.     <title><decorator:title default="装饰器页面..." /></title>  
  7.     <decorator:head />  
  8.   </head>  
  9.   <body>  
  10.     sitemesh的例子<hr>  
  11.     <decorator:body />  
  12.     <hr>chen56@msn.com   
  13.   </body>  
  14. </html>  
  15.   

建立一个的被装饰页面 /index.jsp(内容页面)

xml 代码
  1. <%@ page contentType="text/html; charset=GBK"%>  
  2. <html>  
  3.   <head>  
  4.     <title>Agent Test</title>  
  5.   </head>  
  6.   <body>  
  7.     <p>本页只有一句,就是本句.</p>  
  8.   </body>  
  9. </html>  

 

最后访问index.jsp,将生成如下页面:

而且,所有的页面也会如同index.jsp一样,被sitemesh的filter使用装饰模式修改成如上图般模样,却不用再使用include标签。

装饰器  decorator概念
建立可复用的web应用程序,一个通用的方法是建立一个分层系统,如同下面一个普通的web应用:
  • 前端,front-end:JSP和Servlets,或jakarta的velocity
  • 控制层框架 Controller : (Struts/Webwork)
  • 业务逻辑 Business :主要业务逻辑
  • 持久化框架 :hibernate/jdo

可糟糕的是前端的页面逻辑很难被复用,当你在每一个页面中用数之不尽的include来复用公共的header, stylesheet, scripts,footer时,一个问题出现了-重复的代码,每个页面必须用copy来复用页面结构,而当你需要创意性的改变页面结构时,灾难就爱上了你。

sitemesh通过filter截取request和response,并给原始的页面加入一定的装饰(可能为header,footer...),然后把结果返回给客户端,并且被装饰的原始页面并不知道sitemesh的装饰,这也就达到了脱耦的目的。

据说即将新出台的Portlet规范会帮助我们标准的实现比这些更多更cool的想法,但可怜的我还不懂它到底是一个什末东东,有兴趣的人可以研究
jetspeed,或JSR (Java Specification Request) 168,但我想sitemesh如此简单,我们不妨先用着。

 

让我们看看怎样配置环境
除了要copy到WEB-INF/lib中的sitemesh.jar, copy到WEB-INF中的sitemesh-decorator.tld,sitemesh-page.tld文件外,还有2个文件要建立到WEB-INF/:
  • sitemesh.xml (可选)  
  • decorators.xml 

sitemesh.xml 可以设置2种信息:

Page Parsers :负责读取stream的数据到一个Page对象中以被SiteMesh解析和操作。(不太常用,默认即可)

Decorator Mappers : 不同的装饰器种类,我发现2种比较有用都列在下面。一种通用的mapper,可以指定装饰器的配置文件名,另一种可打印的装饰器,可以允许你当用http://localhost/aaa/a.html?printable=true方式访问时给出原始页面以供打印(免得把header,footer等的花哨的图片也搭上)

(但一般不用建立它,默认设置足够了:com/opensymphony/module/sitemesh/factory/sitemesh-default.xml):

范例:

xml 代码
  1. <sitemesh>  
  2.   <page-parsers>  
  3.     <parser default="true" class="com.opensymphony.module.sitemesh.parser.DefaultPageParser" />  
  4.     <parser content-type="text/html" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />  
  5.     <parser content-type="text/html;charset=ISO-8859-1" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />  
  6.   </page-parsers>  
  7.   
  8.   <decorator-mappers>  
  9.     <mapper class="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">  
  10.       <param name="config" value="/WEB-INF/decorators.xml" />  
  11.     </mapper>  
  12.       <mapper class="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">  
  13.          <param name="decorator" value="printable" />  
  14.          <param name="parameter.name" value="printable" />  
  15.                  <param name="parameter.value" value="true" />  
  16.       </mapper>  
  17.   </decorator-mappers>  
  18. </sitemesh>   

decorators.xml :定义构成复合视图的所有页面构件的描述(主要结构页面,header,footer...),如下例:

xml 代码
  1. <decorators defaultdir="/_decorators">  
  2.   <decorator name="main" page="main.jsp">  
  3.     <pattern>*</pattern>  
  4.   </decorator>  
  5.   <decorator name="printable" page="printable.jsp" role="customer" webapp="aaa" />  
  6. </decorators>  
  • defaultdir: 包含装饰器页面的目录
  • page : 页面文件名
  • name : 别名
  • role : 角色,用于安全
  • webapp : 可以另外指定此文件存放目录
  • Patterns : 匹配的路径,可以用*,那些被访问的页面需要被装饰。

 

 

最重要的是写出装饰器本身(也就是那些要复用页面,和结构页面)。
其实,重要的工作就是制作装饰器页面本身(也就是包含结构和规则的页面),然后把他们描述到decorators.xml中。

让我们来先看一看最简单的用法:其实最常用也最简单的用法就是我们的hello例子,面对如此众多的技术,我想只要达到功能点到为止即可,没必要去研究太深(除非您有更深的需求)。

java 代码
  1. <%@ page contentType="text/html; charset=GBK"%>   
  2. <%@ taglib uri="sitemesh-decorator" prefix="decorator" %>   
  3.   
  4. <html>   
  5.   <head>   
  6.     <title><decorator:title default="装饰器页面..." /></title>   
  7.     <decorator:head />   
  8.   </head>   
  9.   <body>   
  10.     sitemesh的例子<hr>   
  11.     <decorator:body />   
  12.     <hr>chen56@msn.com   
  13.   </body>   
  14. </html>   
  15.   

我们在装饰器页面只用了2个标签:

<decorator:title default="装饰器页面..." />    : 把请求的原始页面的title内容插入到<title></title>中间。

<decorator:body /> : 把请求的原始页面的body内的全部内容插入到相应位置。

然后我们在decorator.xml中加入以下描述即可:

<decorator name="main" page="main.jsp">
    <pattern>*</pattern>
</decorator>

这样,请求的所有页面都会被重新处理,并按照main.jsp的格式重新展现在你面前。

 

让我们看看更多的用法。(抄袭sitemesh文档)
以下列着全部标签:
java 代码
  1. Decorator Tags Page Tags    
  2. 被用于建立装饰器页面. 被用于从原始内容页面访问装饰器.    
  3. <decorator:head />   
  4. <decorator:body />   
  5. <decorator:title />   
  6. <decorator:getProperty />   
  7. <decorator:usePage />   
  8.     
  1. <decorator:head />   
  2.   
  3. 插入原始页面(被包装页面)的head标签中的内容(不包括head标签本身)。   
  4.   
  5. <decorator:body />    
  6. 插入原始页面(被包装页面)的body标签中的内容。   
  7.   
  8. <decorator:title [ default="..." ] />   
  9.   
  10. 插入原始页面(被包装页面)的title标签中的内容,还可以添加一个缺省值。   
  11.   
  12. 例:   
  13.   
  14. /_decorator/main.jsp中 (装饰器页面): <title><decorator:title default="却省title-hello"  /> - 附加标题</title>   
  15.   
  16. /aaa.jsp中 (原始页面):<title>aaa页面</title>   
  17.   
  18. 访问/aaa.jsp的结果:<title>aaa页面 - 附加标题</title>   
  19.   
  20. <decorator:getProperty property="..." [ default="..." ] [ writeEntireProperty="..." ]/>   
  21.   
  22. 在标签处插入原始页面(被包装页面)的原有的标签的属性中的内容,还可以添加一个缺省值。   
  23.   
  24. sitemesh文档中的例子很好理解:   
  25. The decorator: <body bgcolor="white"<decorator:getProperty property="body.onload" writeEntireProperty="true" />>   
  26. The undecorated page: <body οnlοad="document.someform.somefield.focus();">   
  27. The decorated page: <body bgcolor="white" οnlοad="document.someform.somefield.focus();">   
  28.   
  29. 注意,writeEntireProperty="true"会在插入内容前加入一个空格。   
  30.   
  31. <decorator:usePage id="..." />   
  32. 象jsp页面中的<jsp:useBean>标签一样,可以使用被包装为一个Page对象的页面。 (懒的用)   
  33.   
  34. 例:可用<decorator:usePage id="page" /> :<%=page.getTitle()%>达到<decorator:title/>的访问结果。   
  35.   
  36.     
  37.   
  38. <page:applyDecorator name="..." [ page="..." title="..." ] >   
  39. <page:param name="..."> ... </page:param>   
  40. <page:param name="..."> ... </page:param>   
  41. </page:applyDecorator>   
  42.   
  43. 应用包装器到指定的页面上,一般用于被包装页面中主动应用包装器。这个标签有点不好理解,我们来看一个例子:   
  44.   
  45. 包装器页面 /_decorators/panel.jsp:<p><decorator:title /></p>  ... <p><decorator:body /></p>   
  46.   并且在decorators.xml中有<decorator name="panel" page="panel.jsp"/>   
  47.   
  48. 一个公共页面,即将被panel包装:/_public/date.jsp:     
  49.   ... <%=new java.util.Date()%>  ...<decorator:getProperty property="myEmail" />   
  50.   
  51. 被包装页面 /page.jsp :    
  52.   <title>page的应用</title>    
  53.   .....     
  54.   <page:applyDecorator name="panel" page="/_public/date.jsp" >   
  55.     <page:param name="myEmail"> chen_p@neusoft.com </page:param>   
  56.   </page:applyDecorator>   
  57.   
后会是什末结果呢?除了/page.jsp会被默认的包装页面包装上header,footer外,page.jsp页面中还内嵌了date.jsp页面,并且此date.jsp页面还会被panel.jsp包装为一个title加body的有2段的页面,第1段是date.jsp的title,第2段是date.jsp的body内容。

另外,page:applyDecorator中包含的page:param标签所声明的属性值还可以在包装页面中用decorator:getProperty标签访问到。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值