Sitemesh 是由一个基于 Web 页面布局、装饰及与现存 Web 应用整合的框架。它能帮助我们由大量页面工程的项目中创建一致的页面布局和外观,如一 致的导航条、一致的 banner 、一致的版权等。它不仅能处理动态的内容,如 JSP 、 PHP 、 ASP 、 CGI 等产生的内容,还能处理静态的内容,比如 HTML 的内容,使得它的内容也符合你的页面结构的要求。甚至它能像 include 那样将 HTML 文件作为一个面板的形式嵌入到别的文件中去。它的主要思想是装饰模式。
前提:依赖于 >=Servlet 2.3 版本里引入的新功能 —— 过滤器 (Filters) 。
好处:
使用 sitemesh 给我们带来的是不仅仅是页面结构问题,它的出现让我们有更多的时间去关注底层业务逻辑,而不是整个页面的风格和结构。它让我们摆脱了大量用 include 方式复用页面尴尬局面,它也提供了很大的灵活性以及给我们提供了整合异构 Web 系统页面的一种方案。
部署:
首先需要导入 sitemesh-2.4.2.jar 由于是 struts2.1.8 整合 sitemesh 的所以还需要导入 struts2-sitemesh-plugin-2.1.6.jar( 目前还没有 struts2-sitemesh-plugin-2.1.8.jar 的 ).
Web.xml 文件中的配置:
< filter >
< filter-name > struts2 </ filter-name >
< filter-class > org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter </ filter-class >
</ filter >
< filter >
< filter-name > struts-cleanup </ filter-name >
< filter-class > org.apache.struts2.dispatcher.ActionContextCleanUp </ filter-class >
</ filter >
< filter >
< filter-name > sitemesh </ filter-name >
< filter-class > com.opensymphony.module.sitemesh.filter.PageFilter </ filter-class >
</ filter >
< filter-mapping >
< filter-name > struts-cleanup </ 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 >
</ filter-mapping >
< filter-mapping >
< filter-name > struts2 </ filter-name >
< url-pattern > /* </ url-pattern >
< dispatcher > REQUEST </ dispatcher >
< dispatcher > FORWARD </ dispatcher >
</ filter-mapping >
以上的配置是根据 url 进行装饰的。如果想根据物理路径来进行装饰,就把 sitemesh 和 struts2 位置换一下就 ok 了。
Sitemesh 自己也需要配置文件:比如 decorators.xml , sitemesh.xml , sitemesh-decorator.tld , sitemesh-page.tld 。 decorators.xml 是必须要的,其它的可要可不要,主要取决于项目的复杂性。
decorators.xml 配置文件的讲解:
<? xml version = "1.0" encoding = "utf-8" ?>
< decorators defaultdir = "/WEB-INF/decorators" ><!—- 定义一个绝对路径 —>
<!-- excludes 标签标示不需要进行装饰的 url -- >
< excludes >
< pattern > /css /* </ pattern >
< pattern > /js /* </ pattern >
< pattern > /images/* </ pattern >
< pattern > /buyer/viewmerchantproduct * </ pattern >
< pattern > /buyer/toindex.do* </ pattern >
< pattern > /buyer/buyerlogout.do </ pattern >
< pattern > */admin -ajax /* </ pattern >
< pattern > */merchant/tomerchantlogin.do* </ pattern >
< pattern > */admin /toadminlogin.do* </ pattern >
< pattern > */admin /adminlogin.do* </ pattern >
< pattern > /merchant/info/login.do* </ pattern >
< pattern > /merchant/report/* </ pattern >
</ excludes >
<!—- 以下是定义一些模板 主要包括模板的 name 和 page -->
< decorator name = "adminmain" page = "adminmain.jsp" >
< pattern > /admin /* </ pattern >
</ decorator >
< decorator name = "buyerbackstagemain" page = "buyerbacktage.jsp" >
< pattern > /buyer/backstage/* </ pattern >
</ decorator >
< decorator name = "seobuyermain" page = "seobuyermain.jsp" >
< pattern > /buyer/viewcategoryproduct.do* </ pattern >
< pattern > /buyer/viewrootcategory.do* </ pattern >
< pattern > /buyer/viewstandproductdetail.do* </ pattern >
< pattern > /buyer/viewproductreview.do* </ pattern >
</ decorator >
< decorator name = "buyermain" page = "buyermain.jsp" >
< pattern > /admin /previewproduct /* </ pattern >
< pattern > /buyer/* </ pattern >
< pattern > /adminpreview /previewbuyerhelpatricle.do </ pattern >
< pattern > /adminpreview /previewbuyerupdateatricle.do </ pattern >
</ decorator >
</ decorators >
注意:模板的名字不要相同 , 如果相同错是不会报,只会被最后的那个相同名字的模板装饰。
url 拦截优先级:主要是配备的越精确优先级就高,不是谁在前面谁的优先级就高。
sitemesh 标签讲解:
<decorator:title default="Welcome to test sitemesh!" /> :读取被装饰页面的标题,并给出了默认标题。
<decorator:head /> :读取被装饰页面的 <head> 中的内容;
<decorator:body /> :读取被装饰页面的 <body> 中的内容;
当然还有很多的标签,这里不再详细描述。