Created by 管理员 , last modified on 2017-10-07

简介

OS(OpenSymphony)的SiteMesh是一个用来在JSP中实现页面布局和装饰（layout and decoration）的框架组件，能够帮助网站开发人员较容易实现页面中动态内容和静态装饰外观的分离。

SiteMesh是基于Servlet的filter的，即过滤流。它是通过截取response，并进行装饰后再交付给客户。
其中涉及到两个名词： 装饰页面(decorator page)和 "被装饰页面(Content page)" , 即 SiteMesh通过对Content Page的装饰，最终得到页面布局和外观一致的页面，并返回给客户
sitemesh运行环境需要：servlet, JDK 。

注意：sitemesh标签默认的标签前缀是：decorator，在FDP框架中前缀名是sitemesh。

<sitemesh:title/>
<sitemesh:head/>
<sitemesh:body/>
<sitemesh:usePage/>
<sitemesh:getProperty/>

<page:applyDecorator>
<page:param/>

以下列着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 标签访问到。


用sitemesh来装饰动态的左侧菜单和内容部分

参考：http://www.cnblogs.com/javaexam2/archive/2011/07/17/2632546.html

在装饰文件中使用动态参数来动态加载某个left.jsp文件

实现原理：当前请求所在模块作为参数传递给sitemesh,sitemesh读取该参数，并去对应模块加载各自的left.jsp文件，这样就存在以下的问题
a)所在模块信息存放在哪里？
通常的做法是在动态页面的<head>元素中添加一个<meta>元素，meta元素其实可以简单的理解成一个key-value的数据节点，如在user模块的创建用户页面/user/createUser.jsp里添加
<meta name="moduleName" content="user"/> ，而在system模块的系统配置页面/system/sysConfig.jsp页面添加如下 <meta name="moduleName" content="system"/>
b)sitemsh怎么读？
对于所有的jsp页面，根据jsp页面所在的模块不同，也存放为不同的页面下，这里做一个统一的命名约束，对于各个模块的左侧菜单，都统一命名为left.jsp,其目录结构如下
/user/ left.jsp
/user/createUser.jsp
/system/ left.jsp
/system/sysConfig.jsp
有了这样的命名约束后，我们就可以在sitemesh的装饰页面做文章了

  1. < %@ page contentType = "text/html; charset=GBK" % >
  2. < %@ taglib uri = " http://www.opensymphony.com/sitemesh/decorator " prefix = "decorator" % >
  3. < html >
  4. < head >
  5. < title > < decorator:title default = "装饰器页面..." /> </ title >
  6. < decorator:head />
  7. </ head >
  8. < body >
  9. < jsp:include page = "/header.jsp" > </ jsp:include >
  10. < decorator:usePage id = "thePage" /> <!-- 把当前页面赋值给thePage这个变量-->
  11. < jsp:include page ="/ < %= thePage.getProperty("meta.moduleName") % > /left.jsp" > </ jsp:include >
  12. < decorator:body />
  13. < jsp:include page = "/footer.jsp" > </ jsp:include >
  14. </ body >
  15. </ html >