decorators.xml的用法
|
简介：
sitemesh应用Decorator模式，用filter截取request和response,把页面组件head,content,banner结合为一个完整的视图。通常我们都是用include标签在每个jsp页面中来不断的包含各种header,stylesheet,scripts and footer，现在，在sitemesh的帮助下，我们可以开心的删掉他们了。如下图，你想轻松的达到复合视图模式，那末看完本文吧。 一、在WEB-INF/web.xml中copy以下filter的定义: <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 ，可以看看辛勤的成果了 （编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |