`

用Sitemesh控制页面布局

JSPWebXML浏览器HTML 
阅读更多

关键字: sitemesh 页面布局

简介：
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的定义: 
    <filter>
     <filter-name>sitemesh</filter-name>
     <filter-class>com.opensymphony.module.sitemesh.filter.PageFilter</filter-class>
</filter>

<filter-mapping>
     <filter-name>sitemesh</filter-name>
     <url-pattern>/*</url-pattern>
</filter-mapping>

<taglib>
     <taglib-uri>sitemesh-decorator</taglib-uri>
     <taglib-location>/WEB-INF/sitemesh-decorator.tld</taglib-location>
</taglib>

<taglib>
     <taglib-uri>sitemesh-page</taglib-uri>
     <taglib-location>/WEB-INF/sitemesh-page.tld</taglib-location>
</taglib>

  2. copy所需jar和dtd文件至相应目录，访问opensymphony.sourceforge.net的cvs以获取sitemesh最新版本。
    sitemesh.jar WEB-INF/lib
    sitemesh-decorator.tld WEB-INF
    sitemesh-page.tld WEB-INF

  3. 建立WEB-INF/decorators.xml描述各装饰器页面(可仿照sitemesh例子)。 
    <decorators defaultdir="/_decorators">
       <decorator name="main" page="main.jsp">
           <pattern>*</pattern>
       </decorator>
</decorators>



  4. 建立装饰器页面 /_decorators/main.jsp
     
    <%@ page contentType="text/html; charset=GBK"%>
<%@ taglib uri="sitemesh-decorator" prefix="decorator" %>

<html>
     <head>
       <title><decorator:title default="装饰器页面..." /></title>
       <decorator:head />
     </head>
     <body>
       sitemesh的例子<hr>
       <decorator:body />
       <hr>chen56@msn.com
     </body>
</html>


  5. 建立一个的被装饰页面 /index.jsp(内容页面) 
    <%@ page contentType="text/html; charset=GBK"%>
<html>
     <head>
       <title>Agent Test</title>
     </head>
     <body>
       <p>本页只有一句，就是本句.</p>
     </body>
</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）：

范例：

<sitemesh>
     <page-parsers>
       <parser default="true" class="com.opensymphony.module.sitemesh.parser.DefaultPageParser" />
       <parser content-type="text/html" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />
       <parser content-type="text/html;charset=ISO-8859-1" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />
     </page-parsers>

     <decorator-mappers>
       <mapper class="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">
         <param name="config" value="/WEB-INF/decorators.xml" />
       </mapper>
         <mapper class="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">
            <param name="decorator" value="printable" />
            <param name="parameter.name" value="printable" />
                    <param name="parameter.value" value="true" />
         </mapper>
  </decorator-mappers>
</sitemesh>

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

<decorators defaultdir="/_decorators">
     <decorator name="main" page="main.jsp">
       <pattern>*</pattern>
     </decorator>
     <decorator name="printable" page="printable.jsp" role="customer" webapp="aaa" />
</decorators>

 

  • defaultdir: 包含装饰器页面的目录
  • page : 页面文件名
  • name : 别名
  • role : 角色，用于安全
  • webapp : 可以另外指定此文件存放目录
  • Patterns : 匹配的路径，可以用*,那些被访问的页面需要被装饰。

　

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

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

<%@ page contentType="text/html; charset=GBK"%>
<%@ taglib uri="sitemesh-decorator" prefix="decorator" %>

<html>
     <head>
       <title><decorator:title default="装饰器页面..." /></title>
       <decorator:head />
     </head>
     <body>
       sitemesh的例子<hr>
       <decorator:body />
       <hr>chen56@msn.com
     </body>
</html>

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

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

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

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

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

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

　

让我们看看更多的用法。(抄袭sitemesh文档)
以下列着全部标签：
Decorator Tags Page Tags
被用于建立装饰器页面. 被用于从原始内容页面访问装饰器.
<decorator:head />
<decorator:body />
<decorator:title />
<decorator:getProperty />
<decorator:usePage />
 <page:applyDecorator />
<page:param
　

<decorator:head />

插入原始页面(被包装页面)的head标签中的内容(不包括head标签本身)。

<decorator:body />

插入原始页面(被包装页面)的body标签中的内容。

<decorator:title [ default="..." ] />

插入原始页面(被包装页面)的title标签中的内容，还可以添加一个缺省值。

例：

/_decorator/main.jsp中 （装饰器页面）: <title><decorator:title default="却省title-hello"     /> - 附加标题</title>

/aaa.jsp中 (原始页面)：<title>aaa页面</title>

访问/aaa.jsp的结果：<title>aaa页面 - 附加标题</title>

<decorator:getProperty property="..." [ default="..." ] [ writeEntireProperty="..." ]/>

在标签处插入原始页面(被包装页面)的原有的标签的属性中的内容，还可以添加一个缺省值。

sitemesh文档中的例子很好理解：
The decorator: <body bgcolor="white"<decorator:getProperty property="body.onload" writeEntireProperty="true" />>
The undecorated page: <body onload="document.someform.somefield.focus();">
The decorated page: <body bgcolor="white" onload="document.someform.somefield.focus();">

注意，writeEntireProperty="true"会在插入内容前加入一个空格。

<decorator:usePage id="..." />
象jsp页面中的<jsp:useBean>标签一样，可以使用被包装为一个Page对象的页面。 (懒的用)

例：可用<decorator:usePage id="page" /> ：<%=page.getTitle()%>达到<decorator:title/>的访问结果。

　

<page:applyDecorator name="..." [ page="..." title="..." ] >
<page:param name="..."> ... </page:param>
<page:param name="..."> ... </page:param>
</page:applyDecorator>

应用包装器到指定的页面上，一般用于被包装页面中主动应用包装器。这个标签有点不好理解，我们来看一个例子：

包装器页面 /_decorators/panel.jsp：<p><decorator:title /></p>     ... <p><decorator:body /></p>
     并且在decorators.xml中有<decorator name="panel" page="panel.jsp"/>

一个公共页面，即将被panel包装：/_public/date.jsp:  
     ... <%=new java.util.Date()%>     ...<decorator:getProperty property="myEmail" />

被包装页面 /page.jsp ：
     <title>page的应用</title>
     .....  
     <page:applyDecorator name="panel" page="/_public/date.jsp" >
       <page:param name="myEmail"> chen_p@neusoft.com </page:param>
     </page:applyDecorator>

最后会是什末结果呢？除了/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标签访问到。

 

可打印的界面装饰
前面说过有1种可打印的装饰器，可以允许你当用http://localhost/aaa/a.html?printable=true方式访问时，应用其他的装饰器(自己指定)，给出原始页面以供打印(免得把header,footer等的花哨的图片也搭上)。

让我们来看一看怎样实现他：

1.首先在WEB-INFO/sitemesh.xml中设置：
     <mapper class="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">
       <param name="decorator" value="printable" />
       <param name="parameter.name" value="printable" />
       <param name="parameter.value" value="true" />
     </mapper>
这样就可以通过?printable=true来使用名为printable的装饰器，而不是用原来的装饰器。

2.在WEB-INFO/decorators.xml中定义相应的printable装饰器
     <decorator name="printable" page="printable.jsp"/>

3.最后编写printable装饰器/decorators/printable.jsp

<%@ taglib uri="sitemesh-decorator" prefix="decorator" %>
<html>
<head>
     <title><decorator:title /></title>
     <decorator:head />
</head>
<body>

     <h1><decorator:title /></h1>
     <p align="right"><i>(printable version)</i></p>

     <decorator:body />

</body>
</html>

这样就可以让一个原始页面通过?printable=true开关来切换不同的装饰器页面。

　

中文问题
由于sitemesh内部所使用的缺省字符集为iso-8859-1，直接使用会产生乱码，我们可以通过以下方法纠正之：
  • 方法1：可以在您所用的application server的配置文件中找一找，有没有设置encoding或charset的项目，然后设成gbk或gb2312即可
  • 方法2：这也是我们一直使用的方法。
    1.在每一个jsp页里设置: <%@ page contentType="text/html; charset=gbk"%> 来告诉server你所要求的字符集。
    2.在每个jsp页的head中定义：<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=gbk"> 来告诉浏览器你所用的字符集。
总结：使用sitemesh最通常的途径：

1.配置好环境，

2.在WEB-INFO/decroators.xml中描述你将建立的包装器。

3.开发在decroators.xml中描述的包装器，最好存放在/_decorators目录下

4.ok ，可以看看辛勤的成果了 :)

 

原文地址 http://hi.baidu.com/zhengmh/blog/item/45e0681fb2fa08c9a7866984.html#send

分享到：
| WARN No configuration found. Configuring ...
评论
发表评论

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

相关推荐

    java sitemesh 页面框架

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

    sitemesh简单教程页面装配器

    Sitemesh是一款用于Web应用中的页面布局管理工具，它通过采用装饰器（Decorator）设计模式，实现了对Web页面布局的灵活管理和重用。传统的Web开发中，开发者往往需要在每个JSP页面中不断地使用`include`标签来嵌入...

    springmvc+mybatis+ehcache+freemarker+sitemesh页面布局（注解）整合实例完美运行

    Sitemesh是一个页面布局框架，用于为Web应用添加统一的页面布局。它可以通过装饰器模式，将通用的头部、底部、侧边栏等元素统一管理，使开发者可以专注于每个页面的实质性内容。在本实例中，Sitemesh可能被用来实现...

    sitemesh jar包

    **Sitemesh** 是一个开源的网页布局和装饰框架，主要用在Java Web应用程序中，用于提供页面布局和模板设计的解决方案。它可以帮助开发者统一网站的外观和感觉，通过分离内容、样式和布局，使代码更加模块化和可维护...

    SiteMesh

    SiteMesh 是一个开源的Web应用程序框架，主要用于帮助开发者实现页面布局和装饰功能。它通过拦截HTTP请求，将页面内容与布局模板相结合，从而提供了一种简单有效的方式来管理和控制Web应用的外观和感觉。在Web开发中...

    sitemesh框架简单例子

    Sitemesh是一款强大的Web页面布局和装饰框架，它主要用于帮助开发者实现网站的统一外观和感觉。这个框架的主要功能是将页面的主体内容与页眉、页脚、侧边栏等通用部分分离，使得在大量网页中保持一致的设计风格变得...

    SiteMesh教程.pdf

    通过以上的知识点，可以看出SiteMesh提供了一种灵活而强大的方式来控制和装饰网站的页面布局和外观，减轻了开发人员维护网站模板和页面样式的负担。使用SiteMesh可以提高开发效率，简化Web应用的维护过程，并且可以...

    siteMesh使用示例

    SiteMesh 是一个开源的 Web 应用程序框架，主要用于页面布局和装饰，它可以帮助开发者实现网站的统一界面风格，简化页面的布局工作。在本示例中，我们将深入探讨 SiteMesh 的基本用法，特别是在登录和注册页面的应用...

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

    Sitemesh 是一个流行的页面布局和装饰框架，它可以为我们的应用程序提供统一的外观和感觉。Tiles2 虽然功能强大，但在某些情况下，Sitemesh 提供了更简单、更轻量级的解决方案。 首先，让我们理解 Spring MVC 和 ...

    springMVC与sitemesh的结合

    而Sitemesh则是一个页面布局和装饰框架，主要用于处理Web应用中的页面布局问题，比如统一头部、底部和侧边栏，提升用户体验并简化开发。 将Spring MVC与Sitemesh结合使用，可以实现更高效的Web应用开发。以下是对这...

    SiteMesh入门示例

    SiteMesh 是一个开源的 Web 应用程序框架，主要用于页面布局和装饰，它可以帮助开发者统一网站的外观和感觉，提供了一种优雅的方式来管理和装饰（或模板化）Web 应用程序的页面。在这个"SiteMesh入门示例"中，我们将...

    sitemesh2 集成velocity 装饰页面乱码

    sitemesh是一款开源的Web页面布局和装饰框架，而velocity则是一个轻量级的Java模板引擎，用于生成动态网页内容。下面我们将深入探讨这个集成过程中的关键知识点。 首先，我们来理解sitemesh2的工作原理。sitemesh...

    spring mvc sitemesh velocity整合

    在本项目中，Spring MVC与两个额外的技术——Sitemesh和Velocity进行了整合，增强了应用的模板渲染和页面布局能力。 Sitemesh 是一个开源的Web应用装饰器框架，主要用于统一网站的页面布局和样式。通过Sitemesh，...

    sitemesh-3.0.0的库和源码

    Sitemesh 是一个开源的Web应用程序框架，主要用于帮助开发者实现网站的统一外观和感觉，即页面布局和装饰功能。它通过拦截HTTP请求，将页面内容与预先定义好的模板结合，从而实现页面的统一风格。在Sitemesh 3.0.0...

    sitemesh装饰器入门

    Sitemesh 是一个开源的 Web 应用程序框架，它主要用来帮助开发者实现页面布局和装饰功能。Sitemesh 的核心概念是“装饰器”，这个概念源自于软件设计模式中的装饰者模式。通过使用 Sitemesh，我们可以将通用的头部、...

    freemarker 与sitemesh 整合例子

    Freemarker是一个模板引擎，主要用于生成动态HTML或其他文本格式的输出，而Sitemesh则是一个页面布局和装饰框架，用于统一网站的外观和感觉。这两者的整合可以帮助开发者更好地管理和呈现网页内容。 **Freemarker**...

    sitemesh教程

    它通过应用Decorator模式，使得开发者能够轻松地创建一致的页面布局，而无需在每个单独的JSP页面中重复包含头部、样式表、脚本和页脚等元素。Sitemesh通过Filter拦截HTTP请求和响应，然后将页面的不同部分（如head、...

    Struts2整合SiteMesh

    Struts2是一个强大的MVC（模型-视图-控制器）框架，它在Java Web开发中广泛应用，极大地简化了业务逻辑处理和页面展示的分离。...在实际开发中，还可以根据需求调整装饰器的定义，实现更复杂、多样的页面布局。

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