`
Reunion Island
  • 浏览: 30824 次
  • 性别: Icon_minigender_1
最近访客 更多访客>>
社区版块
存档分类
最新评论

使用sitemesh建立复合视图

JSPWebXMLWebwork框架 
阅读更多

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.jar WEB-INF/lib
sitemesh-decorator.tld WEB-INF
sitemesh-page.tld WEB-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 onload="document.someform.somefield.focus();">   
  27. The decorated page: <body bgcolor="white" onload="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标签访问到。

分享到：
| 网上找的关于http-equiv的知识，以前总是忽 ...
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    使用sitemesh替换tiles2，spring mvc+spring web flow+sitemsh

    这通常涉及到创建自定义的 `ViewResolver` 实现，它将 Flow 视图名称转换为 Sitemesh 可以识别的格式。 在实践过程中，你可能还需要调整 Sitemesh 的配置以满足项目需求，比如设置默认装饰器、排除特定 URL 不使用...

    SiteMesh教程及SiteMesh官方文档翻译

    #### 使用SiteMesh简化网页布局 SiteMesh是一款用于Web应用程序中的页面布局和装饰的框架。它采用Decorator模式，通过过滤器（filter）拦截请求和响应，将不同的页面组件如头部（head）、主体内容（content）以及...

    xdoclet_appfuse打包

    5. "使用sitemesh建立复合视图.doc"：SiteMesh是一个网页布局框架，它可以将页面的装饰和内容分离，这个文档指导如何用SiteMesh来创建和管理网站的统一外观。 6. "Acegi+hibernate 动态实现基于角色的权限管理.doc...

    springMVC与sitemesh的结合

    **Spring MVC的ModelAndView与Sitemesh**：Spring MVC的Controller返回的ModelAndView对象中的属性可以在装饰器中使用，通过`&lt;decorator:property name="yourModelAttribute"/&gt;`标签访问，实现数据在装饰器和视图...

    Sitemesh 3 的使用及配置

    ### Sitemesh 3 的使用及配置 #### 一、Sitemesh 3 简介 Sitemesh 是一个非常实用的Web页面布局与修饰框架，它通过Servlet中的Filter来实现网页的装饰功能，类似于ASP.NET中的“母版页”技术。这种技术允许开发者...

    siteMesh demo+文档

    3. **定义装饰模板**：SiteMesh允许你创建一个或多个装饰模板，这些模板定义了页面的结构，如页眉、页脚、侧边栏等。你可以使用HTML或者JSP来编写模板。 4. **应用装饰**：通过在JSP页面中使用特殊的注解（例如`&lt;@...

    sitemesh

    Sitemesh通过在Web应用中引入“母版”（Master Page）的概念，使得开发者可以轻松地创建一致性的页面模板，提高网页设计的效率和用户体验。 母版（Master Page）是Sitemesh的核心概念，它是一个包含公共元素（如页...

    java sitemesh 页面框架

    2. **复杂性**：对于简单的页面布局，使用Sitemesh可能显得过度工程化。 在提供的压缩包中，"SiteMesh"可能包含了Sitemesh的源码、文档、示例项目或者其他配置文件。通过研究这些资源，你可以更好地理解和学习如何...

    sitemesh3-demo

    5. **MVC集成**: Sitemesh3与Spring MVC、Struts2等框架有良好的集成，可以方便地在这些框架的视图层应用Sitemesh的装饰功能。 6. **动态装饰**: Sitemesh3支持动态装饰，允许在运行时根据请求信息决定是否应用装饰...

    sitemesh框架简单例子

    要开始使用Sitemesh，你需要在你的项目中引入Sitemesh的依赖。如果你的项目是基于Maven的，可以在pom.xml文件中添加对应的依赖项。对于其他构建工具，可以找到相应的库文件并将其添加到类路径中。 接下来，配置...

    siteMesh使用示例

    如果需要对某些特定页面不应用装饰，或者只对特定部分进行装饰，可以使用 `excludes` 和 `includes` 属性在 `web.xml` 中配置 SiteMesh 过滤器。 9. **优化与性能** SiteMesh 通常对性能的影响很小，但可以通过...

    SiteMesh教程.pdf

    通过使用SiteMesh标签库中的标签，可以在装饰器中插入实际页面的内容，实现动态的页面装饰。 ***Mesh的基本组件： - Decorator Filter：这是SiteMesh的核心组件，负责拦截请求、传递页面内容给装饰器，并将组合后的...

    页面装饰器(sitemesh)实例源代码

    3. **创建装饰模板**：Sitemesh使用HTML文件作为装饰模板，你可以根据需求创建一个基础模板，例如`layout.html`，该模板通常包含页头、页脚、侧边栏等公共部分。 4. **设置页面内容**：对于每个需要装饰的页面，...

    sitemesh jar包机tld文件

    总结来说，"sitemesh jar包机tld文件"是SiteMesh框架在JSP页面布局中的关键组件，通过引入sitemesh-2.4.1.jar，并使用sitemesh-page.tld和sitemesh-decorator.tld定义的标签，开发者可以轻松创建和管理具有统一外观...

    sitemesh3官方下载包

    开发者可以通过阅读这些文档来了解如何使用Sitemesh3提供的接口和类，以便在自己的代码中集成Sitemesh3的功能。 3. **demo** 目录：这是一个示例应用程序，展示了Sitemesh3如何与实际的Web应用结合使用。通过分析和...

    sitemesh的使用和例子

    例如，可以使用`&lt;sitemesh:head&gt;`、`&lt;sitemesh:body&gt;`等标签来标记要被装饰器替换的部分。 ### 自定义装饰器 除了默认装饰器，还可以为特定URL或扩展名定义自定义装饰器。在`decorators.xml`中添加相应规则即可。 ...

    spring mvc sitemesh velocity整合

    集成过程包括配置Hibernate SessionFactory，创建实体类，定义映射文件，以及在控制器中使用SessionFactory进行数据操作。 总的来说，Spring MVC、Sitemesh和Velocity的整合提供了一种高效且灵活的Web开发模式，...

    SiteMesh

    4. **配置（Configuration）**: SiteMesh的配置文件（通常为`sitemesh.xml`）用于设置装饰策略，包括哪些URL需要被装饰，以及使用哪个装饰器等。 **使用步骤** 1. **集成SiteMesh**: 将SiteMesh的JAR文件添加到...

    sitemesh教程

    - **使用sitemesh-blank.war**：也可以直接使用预打包好的`sitemesh-blank.war`文件作为起点，该文件包含了SiteMesh的基本配置。 ##### 2. 添加SiteMesh库 - 将`siteMesh-2.4.1.jar`文件拷贝到项目的`[web-app]/...

Magicbox
Global site tag (gtag.js) - Google Analytics