简介：
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/j2eehttp://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描述各装饰器页面。
<decoratorsdefaultdir="/decorators">
<decorator name="main"page="main.jsp">
<pattern>*</pattern>
</decorator>
</decorators>上面配置文件指定了装饰器页面所在的路径，并指定了一个名为main的装饰器，该装饰器默认装饰web应用根路径下的所有页面。
四、建立装饰器页面 /decorators/main.jsp
<%@ 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种信息:
PageParsers ：负责读取stream的数据到一个Page对象中以被SiteMesh解析和操作。(不太常用，默认即可)
DecoratorMappers : 不同的装饰器种类，我发现2种比较有用都列在下面。一种通用的mapper,可以指定装饰器的配置文件名，另一种可打印的装饰器，可以允许你当用http://localhost/aaa/a.html?printable=true方式访问时给出原始页面以供打印(免得把header,footer等的花哨的图片也搭上)
(但一般不用建立它，默认设置足够了：com/opensymphony/module/sitemesh/factory/sitemesh-default.xml）：
范例：
| <sitemesh> |
| decorators.xml ：定义构成复合视图的所有页面构件的描述(主要结构页面，header,footer...)，如下例：
· defaultdir: 包含装饰器页面的目录 · page : 页面文件名 · name : 别名 · role : 角色，用于安全 · webapp : 可以另外指定此文件存放目录 · Patterns : 匹配的路径，可以用*,那些被访问的页面需要被装饰。 |
| 最重要的是写出装饰器本身(也就是那些要复用页面，和结构页面)。 | |
| 其实，重要的工作就是制作装饰器页面本身(也就是包含结构和规则的页面)，然后把他们描述到decorators.xml中。 让我们来先看一看最简单的用法：其实最常用也最简单的用法就是我们的hello例子，面对如此众多的技术，我想只要达到功能点到为止即可，没必要去研究太深(除非您有更深的需求)。
我们在装饰器页面只用了2个标签： <decorator:title default="装饰器页面..." /> ： 把请求的原始页面的title内容插入到<title></title>中间。 <decorator:body /> ： 把请求的原始页面的body内的全部内容插入到相应位置。 然后我们在decorator.xml中加入以下描述即可： <decorator name="main" page="main.jsp"> 这样，请求的所有页面都会被重新处理，并按照main.jsp的格式重新展现在你面前。 |
| 让我们看看更多的用法。(抄袭sitemesh文档) | ||||||
| 以下列着全部标签：
<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文档中的例子很好理解： 注意，writeEntireProperty="true"会在插入内容前加入一个空格。 <decorator:usePage id="..." /> 例：可用<decorator:usePage id="page" /> ：<%=page.getTitle()%>达到<decorator:title/>的访问结果。 <page:applyDecorator name="..." [ page="..." title="..." ] > 应用包装器到指定的页面上，一般用于被包装页面中主动应用包装器。这个标签有点不好理解，我们来看一个例子： 包装器页面 /decorators/panel.jsp：<p><decorator:title /></p> ... <p><decorator:body /></p> 最后会是什末结果呢？除了/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中设置： 2.在WEB-INFO/decorators.xml中定义相应的printable装饰器 3.最后编写printable装饰器/decorators/printable.jsp
这样就可以让一个原始页面通过?printable=true开关来切换不同的装饰器页面。 |
| 中文问题 |
| 由于sitemesh内部所使用的缺省字符集为iso-8859-1，直接使用会产生乱码，我们可以通过以下方法纠正之： · 方法1：可以在您所用的application server的配置文件中找一找，有没有设置encoding或charset的项目，然后设成gbk或gb2312即可 · 方法2：这也是我们一直使用的方法。 |
| 总结：使用sitemesh最通常的途径： |
| 1.配置好环境， 2.在WEB-INFO/decroators.xml中描述你将建立的包装器。 3.开发在decroators.xml中描述的包装器，最好存放在/_decorators目录下 4.ok ，可以看看辛勤的成果了 :) |
J2EE：SiteMesh（页面装饰器）简介及应用
最近公司做项目，需要用到SiteMesh框架，坦白的说之前没怎么用过，所以在网上查看了许多相关资料，自己总结了一下，希望对大家有所帮助。
SiteMesh是OpenSymphony团队开发的JEE框架之一,它是一个非常优秀的页面装饰器框架,它通过对所有的用户请求进行过滤,并对服务器向客户端响应也进行过滤,从而给原始的服务器响应加入一定的装饰,可以是header,footer等,然后将经过装饰后的页面送回浏览者.对于被装饰的页面而言,它无需知道自身被谁装饰,也无从知道自身被谁装饰,SiteMesh通过配置文件来配置指定的装饰器,用于过滤某些页面,则该装饰器会装饰这些页面,从而提供更好的页面效果,通过SiteMesh的页面装饰,可以提供更好的代码复用,所有的页面装饰效果耦合在目标页面中,无需使用include指令来显式包含装饰效果,目标页面与装饰页面完全分高.提供更好的解耦,而且可以应用中所有的页面都使用相同的装饰页面,整个Web应用会有更统一的风格,会提供更好的整体效果.
SiteMesh通过Filter来截取request和response,然后给原始的页面加入一定的装饰,再把结果返回给客户端.
SiteMesh应用
1. 定义装饰器页面
装饰器页面就是一个普通的JSP页面,但这个页面包含了一些SiteMesh标签,看下面的页面代码:
|
<%@ 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> <div style="font:9pt" align="center">SiteMesh</div> </body> </html> |
它与传统的JSP页面并没有太大的区别,它包含了三个SiteMesh标签:
1,:将被装饰页面的title部分插入该页面的此处.
2,:将被装饰页面的head部分插入该页面的此处.
3,:将被装饰页面的body部分插入该页面的此处.
2. 配置装饰器页面
下面在配置文件中配置该装饰器页面,配置用WEB-INF\decorators.xml文件,内容如下:
这时访问其它的页面,可以看到所有的页面都被main.jsp装饰过了.
3. 更复杂的装饰器页面
下面将在装饰器页面中使用其他装饰器,也就是装饰器页面中嵌套装饰器页面,通过这种方式可以提供更高程度的解耦.在装饰器页面中导入其他装饰器页面使用如下标签:
看如下的装饰器页面代码:
|
<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator"%> <%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page"%> <html> <head> <title><decorator:title default="SiteMesh的装饰器页"/></title> <link href="decorators/main.css" rel="stylesheet" type="text/css"> <decorator:head/> </head> <body> <table width="100%" height="100%"> <tr> <td valign="top"> <!--引入一个页面，临时指定所用的装饰器--> <page:applyDecorator page="/book.html" name="panel" /> <page:applyDecorator page="/link.html" name="panel" /> </td> <td width="100%"> <table width="100%" height="100%"> <tr> <td id="pageTitle"> <decorator:title/> </td> </tr> <tr> <td valign="top" height="100%"> <decorator:body /> </td> </tr> <tr> <td id="footer"> <b>被包含的内容</b><br> SithMesh提供页面装饰支持 </td> </tr> </table> </td> </tr> </table> </body> </html> |
从上面的页面代码中可以看到,上面页面一样只使用了标签来导入被装饰页面的标题部分,并不一定是导入到装饰器页面的title部分,可以导入到任何部分.此外,上面装饰器页面还使用了标签,该标签用于直接将目标页面导入装饰器页面,导入目标页面时,使用panel装饰器来装饰该页面.这意味着,该装饰器还依赖于另一个装饰器:panel,panel装饰器的页面代码如下:
|
<%@ page contentType="text/html; charset=GBK"%> <%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %> <p> <table width=250 border=0 cellpadding=0 cellspacing=0> <tr> <th class="panelTitle"> <decorator:title default="小面板页面" /> </th> </tr> <tr> <td class="panelBody"> <decorator:body /> </td> </tr> </table> </p> |
这个页面仅仅定义了一个表格,因为上面定义了两个装饰器页面,因此也需要使用decorator.xml文件来定义装饰器页面,代码如下:
|
<decorators defaultdir="/decorators"> <!--在excludes元素下指定的页面将不会由SiteMesh来装饰--> <excludes> <pattern>/exclude.jsp</pattern> <pattern>/exclude/*</pattern> <pattern>/document/openCatalogSelect.do</pattern> </excludes> <!--创建一个名为main的装饰器，该装饰器页面为main.jsp, 用于装饰pattern指定的URL的所有页面--> <decorator name="main" page="main.jsp"> <pattern>/*</pattern> </decorator> <!--定义一个装饰器,但该装饰器默认不装饰任何页面--> <decorator name="panel" page="panel.jsp"/> </decorators> |
Struts2、Sitemesh、FreeMarker 最新版本整合配置
由于新版本的Struts2改进了国际化的性能，所以进行了Jar包的升级，同时再升级了Sitemesh和FreeMarker的版本。但是突然发现，原先的整合方案下，FTL文件无法获得request、response、action等Freemarker内置的对象，经过追踪与查找，终于找到了新的整合方案。
web.xml的配置：
viewplaincopy to clipboardprint?
<filter>
<filter-name>struts-prepare</filter-name>
<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareFilter</filter-class>
</filter>
<filter>
<filter-name>sitemesh</filter-name>
<filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
</filter>
<filter>
<filter-name>struts-execute</filter-name>
<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsExecuteFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>struts-prepare</filter-name>
<url-pattern>/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
<filter-mapping>
<filter-name>sitemesh</filter-name>
<url-pattern>/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
<dispatcher>INCLUDE</dispatcher>
</filter-mapping>
<filter-mapping>
<filter-name>struts-execute</filter-name>
<url-pattern>/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
<servlet>
<servlet-name>sitemesh-freemarker</servlet-name>
<servlet-class>com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet</servlet-class>
<init-param>
<param-name>TemplatePath</param-name>
<param-value>/</param-value>
</init-param>
<init-param>
<param-name>default_encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>sitemesh-freemarker</servlet-name>
<url-pattern>*.ftl</url-pattern>
</servlet-mapping>
<servlet>
<servlet-name>JspSupportServlet</servlet-name>
<servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<filter>
<filter-name>struts-prepare</filter-name>
<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareFilter</filter-class>
</filter>
<filter>
<filter-name>sitemesh</filter-name>
<filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
</filter>
<filter>
<filter-name>struts-execute</filter-name>
<filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsExecuteFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>struts-prepare</filter-name>
<url-pattern>/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
<filter-mapping>
<filter-name>sitemesh</filter-name>
<url-pattern>/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
<dispatcher>INCLUDE</dispatcher>
</filter-mapping>
<filter-mapping>
<filter-name>struts-execute</filter-name>
<url-pattern>/*</url-pattern>
<dispatcher>REQUEST</dispatcher>
<dispatcher>FORWARD</dispatcher>
</filter-mapping>
<servlet>
<servlet-name>sitemesh-freemarker</servlet-name>
<servlet-class>com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet</servlet-class>
<init-param>
<param-name>TemplatePath</param-name>
<param-value>/</param-value>
</init-param>
<init-param>
<param-name>default_encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>sitemesh-freemarker</servlet-name>
<url-pattern>*.ftl</url-pattern>
</servlet-mapping>
<servlet>
<servlet-name>JspSupportServlet</servlet-name>
<servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
sitemesh.xml的配置：
view plaincopy toclipboardprint?<?xml version="1.0" encoding="UTF-8"?>
<sitemesh>
<propertyname="decorators-file" value="/WEB-INF/decorator.xml"/>
<excludesfile="${decorators-file}"/>
<page-parsers>
<parserdefault="true"class="com.opensymphony.module.sitemesh.parser.DefaultPageParser"/>
<parsercontent-type="text/html"class="com.opensymphony.module.sitemesh.parser.FastPageParser"/>
<parsercontent-type="text/html;charset=UTF-8"class="com.opensymphony.module.sitemesh.parser.FastPageParser"/>
</page-parsers>
<decorator-mappers>
<mapperclass="com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper">
<param name="property.1"value="meta.decorator"/>
<paramname="property.2" value="decorator"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper">
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper">
<paramname="match.MSIE" value="ie"/>
<paramname="match.Mozilla [" value="ns"/>
<paramname="match.Opera" value="opera"/>
<paramname="match.Lynx" value="lynx"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">
<paramname="decorator" value="printable"/>
<paramname="parameter.name" value="printable"/>
<paramname="parameter.value" value="true"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper">
<paramname="decorator" value="robot"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper">
<paramname="decorator.parameter" value="decorator"/>
<paramname="parameter.name" value="confirm"/>
<paramname="parameter.value" value="true"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.FileDecoratorMapper">
</mapper>
<mapperclass="org.apache.struts2.sitemesh.NoneDecoratorMapper">
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">
<paramname="config" value="${decorators-file}"/>
</mapper>
</decorator-mappers>
</sitemesh>
<?xml version="1.0" encoding="UTF-8"?>
<sitemesh>
<propertyname="decorators-file" value="/WEB-INF/decorator.xml"/>
<excludes file="${decorators-file}"/>
<page-parsers>
<parserdefault="true"class="com.opensymphony.module.sitemesh.parser.DefaultPageParser"/>
<parsercontent-type="text/html"class="com.opensymphony.module.sitemesh.parser.FastPageParser"/>
<parser content-type="text/html;charset=UTF-8"class="com.opensymphony.module.sitemesh.parser.FastPageParser"/>
</page-parsers>
<decorator-mappers>
<mapperclass="com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper">
<param name="property.1"value="meta.decorator"/>
<paramname="property.2" value="decorator"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper">
</mapper>
<mapper class="com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper">
<paramname="match.MSIE" value="ie"/>
<paramname="match.Mozilla [" value="ns"/>
<paramname="match.Opera" value="opera"/>
<paramname="match.Lynx" value="lynx"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">
<paramname="decorator" value="printable"/>
<paramname="parameter.name" value="printable"/>
<param name="parameter.value"value="true"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper">
<paramname="decorator" value="robot"/>
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper">
<paramname="decorator.parameter" value="decorator"/>
<paramname="parameter.name" value="confirm"/>
<paramname="parameter.value" value="true"/>
</mapper>
<mapper class="com.opensymphony.module.sitemesh.mapper.FileDecoratorMapper">
</mapper>
<mapperclass="org.apache.struts2.sitemesh.NoneDecoratorMapper">
</mapper>
<mapperclass="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">
<paramname="config" value="${decorators-file}"/>
</mapper>
</decorator-mappers>
</sitemesh>
decorator.xml的配置：
view plaincopy toclipboardprint?<?xml version="1.0" encoding="UTF-8"?>
<decorators defaultdir="/decorators">
<excludes>
<pattern>/styles/*</pattern>
<pattern>/images/*</pattern>
<pattern>/js/*</pattern>
<pattern>/decorators/*</pattern>
</excludes>
<decorator name="master"page="MainMasterPage.ftl">
<pattern>*.do</pattern>
</decorator>
</decorators>
<?xml version="1.0" encoding="UTF-8"?>
<decorators defaultdir="/decorators">
<excludes>
<pattern>/styles/*</pattern>
<pattern>/images/*</pattern>
<pattern>/js/*</pattern>
<pattern>/decorators/*</pattern>
</excludes>
<decorator name="master"page="MainMasterPage.ftl">
<pattern>*.do</pattern>
</decorator>
</decorators>
这样的话，无论母版页还是子页，都可以使用 request、response和action内置对象了。
${request.localAddr}、${request.localPort}:
<%=request.getLocalAddr()%>、<%=request.getLocalPort()%>
下面是另一外篇文章：
SiteMesh教程
2009-05-20 14:01:32
标签：
| 简介： |
| 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/j2eehttp://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/） <decorator name="main" page="main.jsp"> <pattern>*</pattern> </decorator> </decorators> |
上面配置文件指定了装饰器页面所在的路径，并指定了一个名为main的装饰器，该装饰器默认装饰web应用根路径下的所有页面。
四、建立装饰器页面 /decorators/main.jsp
| <%@ page contentType="text/html; charset=GBK"%> |
五、建立一个的被装饰页面 /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的想法，但可怜的我还不懂它到底是一个什末东东，有兴趣的人可以研究 | ||||||
| 让我们看看怎样配置环境 | ||||||
| 除了要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等的花哨的图片也搭上) 范例：
decorators.xml ：定义构成复合视图的所有页面构件的描述(主要结构页面，header,footer...)，如下例：
defaultdir: 包含装饰器页面的目录 page : 页面文件名 name : 别名 role : 角色，用于安全 webapp : 可以另外指定此文件存放目录 Patterns : 匹配的路径，可以用*,那些被访问的页面需要被装饰。 | ||||||
| 最重要的是写出装饰器本身(也就是那些要复用页面，和结构页面)。 | ||||||
| 其实，重要的工作就是制作装饰器页面本身(也就是包含结构和规则的页面)，然后把他们描述到decorators.xml中。 让我们来先看一看最简单的用法：其实最常用也最简单的用法就是我们的hello例子，面对如此众多的技术，我想只要达到功能点到为止即可，没必要去研究太深(除非您有更深的需求)。
我们在装饰器页面只用了2个标签： <decorator:title default="装饰器页面..." /> ： 把请求的原始页面的title内容插入到<title></title>中间。 <decorator:body /> ： 把请求的原始页面的body内的全部内容插入到相应位置。 然后我们在decorator.xml中加入以下描述即可： <decorator name="main" page="main.jsp"> 这样，请求的所有页面都会被重新处理，并按照main.jsp的格式重新展现在你面前。 | ||||||
| 让我们看看更多的用法。(抄袭sitemesh文档) | ||||||
| 以下列着全部标签：
<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文档中的例子很好理解： 注意，writeEntireProperty="true"会在插入内容前加入一个空格。 <decorator:usePage id="..." /> 例：可用<decorator:usePage id="page" /> ：<%=page.getTitle()%>达到<decorator:title/>的访问结果。 <page:applyDecorator name="..." [ page="..." title="..." ] > 应用包装器到指定的页面上，一般用于被包装页面中主动应用包装器。这个标签有点不好理解，我们来看一个例子： 包装器页面 /decorators/panel.jsp：<p><decorator:title /></p> ... <p><decorator:body /></p> 最后会是什末结果呢？除了/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中设置： 2.在WEB-INFO/decorators.xml中定义相应的printable装饰器 3.最后编写printable装饰器/decorators/printable.jsp
这样就可以让一个原始页面通过?printable=true开关来切换不同的装饰器页面。 |
| 中文问题 |
| 由于sitemesh内部所使用的缺省字符集为iso-8859-1，直接使用会产生乱码，我们可以通过以下方法纠正之： 方法1：可以在您所用的application server的配置文件中找一找，有没有设置encoding或charset的项目，然后设成gbk或gb2312即可 方法2：这也是我们一直使用的方法。 |
| 总结：使用sitemesh最通常的途径： |
| 1.配置好环境， 2.在WEB-INFO/decroators.xml中描述你将建立的包装器。 3.开发在decroators.xml中描述的包装器，最好存放在/_decorators目录下 4.ok ，可以看看辛勤的成果了 :) |
扫一扫
287
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
