OS(OpenSymphony)的SiteMesh是一个用来在JSP中实现页面布局和装饰（layout and decoration）的框架组件，能够帮助网站开发人员较容易实现页面中动态内容和静态装饰外观的分离。
      Sitemesh是由一个基于Web页面布局、装饰以及与现存Web应用整合的框架。它能帮助我们在由大量页面构成的项目中创建一致的页面布局和外观，如 一致的导航条，一致的banner，一致的版权，等等。它不仅仅能处理动态的内容，如jsp，php，asp等产生的内容，它也能处理静态的内容，如 htm的内容，使得它的内容也符合你的页面结构的要求。甚至于它能将HTML文件象include那样将该文件作为一个面板的形式嵌入到别的文件中去。所 有的这些，都是GOF的Decorator模式的最生动的实现。尽管它是由java语言来实现的，但它能与其他Web应用很好地集成。官方：http://www.opensymphony.com/sitemesh/

原文链接：http://blog.csdn.net/fox_lht/article/details/7423968

Web.xml中的写法：

  1. <!-- Sitemesh filter -->
  2. <filter>
  3. <filter-name>sitemeshFilter</filter-name>
  4. <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
  5. </filter>
  6. <filter-mapping>
  7. <filter-name>sitemeshFilter</filter-name>
  8. <url-pattern>/*</url-pattern>
  9. </filter-mapping>

配置文件：

  1. <sitemesh>
  2. <mapping path="/*" decorator="/decorator.html"/>
  3. </sitemesh>

decorator文件的写法

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <decorators defaultdir="/WEB-INF/layouts/">
  3. <excludes>
  4. <pattern>/static/*</pattern>
  5. </excludes>
  6. <decorator name="default" page="default.jsp">
  7. <pattern>/*</pattern>
  8. </decorator>
  9. </decorators>

excludes标签中的内容是不需要装饰的目录或文件。

装饰模板网页文件的写法：

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <title>Mini-Web示例:<sitemesh:title/></title>
  5. <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
  6. <meta http-equiv="Cache-Control" content="no-store" />
  7. <meta http-equiv="Pragma" content="no-cache" />
  8. <meta http-equiv="Expires" content="0" />
  9. <sitemesh:head/>
  10. </head>
  11. <body>
  12. <div class="container">
  13. <%@ include file="/WEB-INF/layouts/header.jsp"%>
  14. <div id="content" class="span-24 last">
  15. <sitemesh:body/>
  16. </div>
  17. <%@ include file="/WEB-INF/layouts/footer.jsp"%>
  18. </div>
  19. </body>
  20. </html>

填入到模板文件中网页：

  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>

SiteMesh介绍：

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

<?xml version="1.0" encoding="GBK"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
version="2.4">

<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>

</web-app>

二、copy所需sitemesh-2.3.jar到WEB-INF\lib下。（这里可以下载http://www.opensymphony.com/sitemesh/）

三、 建立WEB-INF/decorators.xml描述各装饰器页面。

<decorators defaultdir="/decorators">

       <decorator name="main" page="main.jsp">

           <pattern>*</pattern>

       </decorator>

</decorators>

上面配置文件指定了装饰器页面所在的路径，并指定了一个名为main的装饰器，该装饰器默认装饰web应用根路径下的所有页面。

四、 建立装饰器页面 /decorators/main.jsp

  • <%@ page contentType="text/html; charset=GBK"%>
    <%@ taglib uri="http://www.opensymphony.com/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>

     

    五、建立一个的被装饰页面 /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应用：

  • 前端: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外，还有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="http://www.opensymphony.com/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://www.blogjava.net/shiwenfeng/archive/2009/10/27/299925.html

转：SiteMesh简介的更多相关文章

  1. Sitemesh 3 配置和使用(最新)

    Sitemesh 3 配置和使用(最新) 一 Sitemesh简介 Sitemesh是一个页面装饰器,可以快速的创建有统一外观Web应用 -- 导航 加 布局 的统一方案~ Sitemesh可以拦截任 ...

  2. SiteMesh入门（1-1）SiteMesh是什么？

    1.问题的提出 在开发Web 应用时,Web页面可能由不同的人参与开发,因此开发出来的界面通常千奇百怪.五花八门,风格难以保持一致. 为了统一界面的风格,Struts 框架提供了一个标签库Tiles ...

  3. Sitemesh 3使用及配置

    1:Sitemesh简介 SiteMesh是一个网页布局和修饰的框架,利用它可以将网页的内容和页面结构分离,以达到页面结构共享的目的. SiteMesh是基于Servlet的filter的,即过滤流. ...

  4. spring boot 集成 sitemesh

    一.Sitemesh简介 Sitemesh是由一个基于Web页面布局.装饰及与现存Web应用整合的框架,是一个装饰器.它能帮助我们在由大量页面工程的项目中创建一致的页面布局和外观,如一致的导航条.一致 ...

  5. Tiles & SiteMesh

    Tiles & SiteMesh 这两天在给公司的新项目搭框架,在配tiles框架的时候发现一个小问题:    比如开发团队一共5人,每人10个页面,如果按照简单的tiles框架配置方法,每个 ...

  6. SiteMesh学习入门

    http://www.java3z.com/cwbwebhome/article/article2/2962.html?id=1668 demo下载 简介:     sitemesh应用Decorat ...

  7. Sitemesh 3 的使用及配置

    1 . Sitemesh 3 简介 Sitemesh 是一个网页布局和修饰的框架,基于 Servlet 中的 Filter,类似于 ASP.NET 中的‘母版页’技术.参考:百度百科,相关类似技术:A ...

  8. Sitemesh 3

    Sitemesh 3 的使用及配置(收藏自:http://www.cnblogs.com/luotaoyeah/p/3776879.html) 1 . Sitemesh 3 简介 Sitemesh 是 ...

  9. JEESZ分布式框架简介

    声明:该框架面向企业,是大型互联网分布式企业架构,后期会介绍Linux上部署高可用集群项目. 项目基础功能截图(自提供了最小部分) 介绍 1.      项目核心代码结构截图 <modules& ...

随机推荐

  1. 【状压dp】送餐员

    [odevs2800]送餐员 题目描述 Description 有一个送外卖的,他手上有n份订单,他要把n份东西,分别送达n个不同的客户的手上.n个不同的客户分别在1~n个编号的城市中.送外卖的从0号 ...

  2. maven打包出现找不到java.lang包的问题

    修改pom文件中的bootclasspth路径为${java.home}/lib/rt.jar;${java.home}/lib/jce.jar windows为分号 linux为冒号

  3. zk选举过程

    1. 服务器启动时期的Leader选举 若进行Leader选举,则至少需要两台机器,这里选取3台机器组成的服务器集群为例.在集群初始化阶段,当有一台服务器Server1启动时,其单独无法进行和完成Le ...

  4. Oracle数据库中的所有用户名

    select * from dba_users; 查看数据库里面所有用户,前提是你是有dba权限的帐号,如sys,systemselect * from all_users;  查看你能管理的所有用户 ...

  5. 网页中输出漂亮格式的Php数组神器

    写网页的时候经常需要在页面中打印数组,但格式特别难看,看看一个html神器吧<pre>标签,能非常标准的显示数组格式 使用的时候只需要这样打印你的数组就OK了,太好用了,神器! 只需要两句 ...

  6. iOS：UIView、UIControl、UIButton、UILabel简单的属性和方法常识

    常见属性和方法 一 .UIVIew 常见属性 1.frame 位置和尺寸(以父控件的左上角为原点(0,0)) 2.center 中点 (以父控件的左上角为原点(0,0)) 3.bounds 位置和尺寸 ...

  7. Delphi中Frame的使用方法（2）

    Frame在写代码时和一般组件有什么不同呢?比如(1)中的客户信息的frame,如果想重写客户编辑按钮的click事件,会发生什么呢: procedure TBusOnSiteManager.Fram ...

  8. eclipse缺省的Server没有weblogic

    转自:http://www.javakfz.com/index.php/08/06/471.html eclipse缺省的Server没有weblogic,因此要下载个weblogic的插件.这个过程 ...

  9. 检索数据（mysqli的面向对象用法）

    <?php require('./kwd.php'); $conn=@new mysqli('localhost','root',$kwd,'mytestdb'); if($conn===fal ...

  10. 小白系列-免费广告路由器web认证设置(2)

    要设置认证页面图片.须要到后台注冊一个帐号,绑定路由器. 路由器管理后台网址 http://115.29.12.130/router 第一步:自己主动获取一个路由器ID(上一篇文章中的路由器ID也要改 ...