sitemesh主要有三个主要文件:sitemesh.xml,decorators.xml和做布局用的jsp页面。
一、sitemesh.xml
对于sitemesh.xml这个文件,官方文档上说它不是必须的。sitemesh总是会有一个份默认的配制。如果你打算提供自己的sitemesh.xml,也最好放在web-inf目录下,目前我还没有找到该文件的位置是否可配制以及在何处配制的说明。从sitemesh.xml文件内容上看它主要负责配制3方面的信息:1.装饰器描述文件decorators.xml的存放位置和名称,默认是/WEB-INF/decorators.xml。2.page-parsers的配制。对这一项的不配制目前还是很清楚,大概是指明解析页面使用的类吧。其中字符集的设定可能需要注意,否则可能会出现乱码问题吧?个人猜测。3.decorator-mappers,目前尚不清楚用途。下面是官方提供的一份配制样本.
- <sitemesh>
- <property name="decorators-file" value="/WEB-INF/decorators.xml" />
- <excludes file="${decorators-file}" />
- <page-parsers>
- <parser content-type="text/html"
- class="com.opensymphony.module.sitemesh.parser.HTMLPageParser" />
- <parser content-type="text/html;charset=ISO-8859-1"
- class="com.opensymphony.module.sitemesh.parser.HTMLPageParser" />
- </page-parsers>
- <decorator-mappers>
- <mapper class="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">
- <param name="config" value="${decorators-file}" />
- </mapper>
- </decorator-mappers>
- </sitemesh>
二、decorators.xml
decorators.xml是配制的核心,它主要用来描述一系列的decorator.每一个decorator需要指明实际用来装饰的JSP页面是哪一个(在这个页面中往往会出现<decorator:head /><decorator:body /><decorator:title /><decorator:getProperty /><decorator:usePage />这些装饰标签),以及这个decorator要装饰的页面有哪些(也就是一系列的url pattern)。下面是oobbs系统的decorators.xml.在它里有两个decorator.分别对应该系统的用户页面和管理页面。需要特别说明的是defaultdir是用来指明装饰文件所在的默认文件夹,如果指定了这个文件夹,那么<decorator/>标签中的page属性中如果填入相对路径,它将会从defaultdir开始查找。在下面的例子中,由于page都给出的是绝对路径,因此defaultdir并不起作用。
- <decorators defaultdir="/decorators">
- <excludes>
- <pattern>/40*.jsp</pattern>
- <pattern>/*ajax=true*</pattern>
- <pattern>/scripts/dojo/*</pattern>
- <pattern>/struts/dojo/*</pattern>
- <pattern>/resources/*</pattern>
- <pattern>/admin/login.jsp</pattern>
- <pattern>/site/login.jsp</pattern>
- </excludes>
- <decorator name="adminDecorator" page="/admin/decorator.jsp">
- <pattern>/admin/*</pattern>
- </decorator>
- <decorator name="siteDecorator" page="/site/decorator.jsp">
- <pattern>/site/*</pattern>
- </decorator>
- </decorators>
三.做布局用的jsp页面
decorators.xml的配制中都会指向一些这样的页面。这些页面是一些普通的jsp页面,主要是用来布局的。像header,footer这样的框架部分用<jsp:include page="xxx.jsp" />引入,需要被装饰的部分用decorator标签替换就可以了。下面是一个样本。其中<decorator:body/>就代表被装饰页面的body部分,在生成html时,这部分会被sitemesh动态替换掉。
- <%@ include file="/admin/taglibs.jsp"%>
- <%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator"%>
- <%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page"%>
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
- <title><decorator:title/></title>
- <link rel="stylesheet" type="text/css" href="<c:url value='/admin/styles/layout.css'/>" />
- </head>
- <body>
- <div id="container">
- <div id="header">
- <jsp:include page="header.jsp" />
- </div>
- <div id="menu">
- <jsp:include page="menu.jsp" />
- </div>
- <div id="mainContent">
- <div id="sidebar">
- <jsp:include page="sidebar.jsp" />
- </div>
- <div id="content">
- <decorator:body/>
- </div>
- </div>
- <div id="footer">
- <jsp:include page="footer.jsp" />
- </div>
- </div>
- </body>
- </html>