sitemesh入門

openkk 13年前發布 | 4K 次閱讀 Lifeograph

sitemesh應用Decorator模式，用filter截取request和response,把頁面組件 head,content,banner結合為一個完整的視圖。通常我們都是用include標簽在每個jsp頁面中來不斷的包含各種header, stylesheet, scripts and footer，現在，在sitemesh的幫助下，我們可以開心的刪掉他們了。如下圖，你想輕松的達到復合視圖模式，那末看完本文吧。 
一、在WEB-INF/web.xml中copy以下filter的定義:

  1. <?xml version="1.0" encoding="GBK"?>  
  2. <web-app xmlns="http://java.sun.com/xml/ns/j2ee"  
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
  4. xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"  
  5. version="2.4">  
  6.   
  7. <filter>  
  8.   <filter-name>sitemesh</filter-name>  
  9.      <filter-class>com.opensymphony.module.sitemesh.filter.PageFilter</filter-class>  
  10.   </filter>  
  11.   
  12.   <filter-mapping>  
  13.      <filter-name>sitemesh</filter-name>  
  14.      <url-pattern>/*</url-pattern>  
  15.   </filter-mapping>  
  16.   
  17. </web-app>  

二、copy所需sitemesh-2.3.jar到WEB-INF\lib下。（這里可以下載http://www.opensymphony.com/sitemesh/）

三、 建立WEB-INF/decorators.xml描述各裝飾器頁面。

  1. <decorators defaultdir="/decorators">  
  2.        <decorator name="main" page="main.jsp">  
  3.            <pattern>*</pattern>  
  4.        </decorator>  
  5. </decorators>   

  上面配置文件指定了裝飾器頁面所在的路徑，并指定了一個名為main的裝飾器，該裝飾器默認裝飾web應用根路徑下的所有頁面。

 

四、 建立裝飾器頁面 /decorators/main.jsp

  1. <%@ page contentType="text/html; charset=GBK"%>  
  2. <%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator"%> <html>  
  3.       <head>  
  4.           <title><decorator:title default="裝飾器頁面..." /></title>  
  5.           <decorator:head />  
  6.       </head>  
  7.      <body>  
  8.         sitemesh的例子<hr>  
  9.         <decorator:body />  
  10.         <hr>chen56@msn.com   
  11.     </body>  
  12. </html>  
  13.   

五、建立一個的被裝飾頁面 /index.jsp(內容頁面)

  1. <%@ page contentType="text/html; charset=GBK"%>  
  2. <html>  
  3.      <head>  
  4.        <title>Agent Test</title>  
  5.      </head>  
  6.      <body>  
  7.        <p>本頁只有一句，就是本句.</p>  
  8.      </body>  
  9. </html>    
  10.   

最后訪問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種信息:
Page Parsers ：負責讀取stream的數據到一個Page對象中以被SiteMesh解析和操作。(不太常用，默認即可)

Decorator Mappers : 不同的裝飾器種類，我發現2種比較有用都列在下面。一種通用的mapper,可以指定裝飾器的配置文件名，另一種可打印的裝飾器，可以允許你當用http://localhost/aaa/a.html?printable=true方式訪問時給出原始頁面以供打印(免得把header,footer等的花哨的圖片也搭上)

(但一般不用建立它，默認設置足夠了：com/opensymphony/module/sitemesh/factory/sitemesh-default.xml）：

范例：

  1. <sitemesh>  
  2.      <page-parsers>  
  3.        <parser default="true" class="com.opensymphony.module.sitemesh.parser.DefaultPageParser" />  
  4.        <parser content-type="text/html" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />  
  5.        <parser content-type="text/html;charset=ISO-8859-1" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />  
  6.      </page-parsers>  
  7.   
  8.      <decorator-mappers>  
  9.        <mapper class="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">  
  10.          <param name="config" value="/WEB-INF/decorators.xml" />  
  11.        </mapper>  
  12.          <mapper class="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">  
  13.             <param name="decorator" value="printable" />  
  14.             <param name="parameter.name" value="printable" />  
  15.                     <param name="parameter.value" value="true" />  
  16.          </mapper>  
  17.   </decorator-mappers>  
  18. </sitemesh>     
  19.   

decorators.xml ：定義構成復合視圖的所有頁面構件的描述(主要結構頁面，header,footer...)，如下例：

  1. <decorators defaultdir="/decorators">  
  2.      <decorator name="main" page="main.jsp">  
  3.        <pattern>*</pattern>  
  4.      </decorator>  
  5.      <decorator name="printable" page="printable.jsp" role="customer" webapp="aaa" />  
  6. </decorators>    
  7.   

defaultdir: 包含裝飾器頁面的目錄
page : 頁面文件名
name : 別名
role : 角色，用于安全
webapp : 可以另外指定此文件存放目錄
Patterns : 匹配的路徑，可以用*,那些被訪問的頁面需要被裝飾。
　
 
最重要的是寫出裝飾器本身(也就是那些要復用頁面，和結構頁面)。 
    其實，重要的工作就是制作裝飾器頁面本身(也就是包含結構和規則的頁面)，然后把他們描述到decorators.xml中。
    讓我們來先看一看最簡單的用法：其實最常用也最簡單的用法就是我們的hello例子，面對如此眾多的技術，我想只要達到功能點到為止即可，沒必要去研究太深(除非您有更深的需求)。

  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.        sitemesh的例子<hr>  
  10.        <decorator:body />  
  11.        <hr>chen56@msn.com   
  12.      </body>  
  13. </html>  
  14.     
  15.   

我們在裝飾器頁面只用了2個標簽：

<decorator:title default="裝飾器頁面..." />       ： 把請求的原始頁面的title內容插入到<title></title>中間。

<decorator:body /> ： 把請求的原始頁面的body內的全部內容插入到相應位置。

然后我們在decorator.xml中加入以下描述即可：

  1. <decorator name="main" page="main.jsp">  
  2.        <pattern>*</pattern>  
  3. </decorator>  


這樣，請求的所有頁面都會被重新處理，并按照main.jsp的格式重新展現在你面前。

　
 
讓我們看看更多的用法。(抄襲sitemesh文檔) 
以下列著全部標簽： Decorator Tags Page Tags
被用于建立裝飾器頁面. 被用于從原始內容頁面訪問裝飾器.

  1. <decorator:head />  
  2. <decorator:body />  
  3. <decorator:title />  
  4. <decorator:getProperty />  
  5. <decorator:usePage />  
  6. <page:applyDecorator />  
  7. <page:param />

 

插入原始頁面(被包裝頁面)的head標簽中的內容(不包括head標簽本身)。

  1. <decorator:body />   

插入原始頁面(被包裝頁面)的body標簽中的內容。

  1. <decorator:title [ default="..." ] />  

插入原始頁面(被包裝頁面)的title標簽中的內容，還可以添加一個缺省值。

例：

/decorator/main.jsp中 （裝飾器頁面）: <title><decorator:title default="卻省title-hello"     /> - 附加標題</title>

/aaa.jsp中 (原始頁面)：<title>aaa頁面</title>

訪問/aaa.jsp的結果：<title>aaa頁面 - 附加標題</title>

  1. <decorator:getProperty property="..." [ default="..." ] [ writeEntireProperty="..." ]/>  

在標簽處插入原始頁面(被包裝頁面)的原有的標簽的屬性中的內容，還可以添加一個缺省值。

sitemesh文檔中的例子很好理解：

  1. The decorator: <body bgcolor="white"<decorator:getProperty property="body.onload" writeEntireProperty="true" />>  
  2. The undecorated page: <body onload="document.someform.somefield.focus();">  
  3. The decorated page: <body bgcolor="white" onload="document.someform.somefield.focus();">  

注意，writeEntireProperty="true"會在插入內容前加入一個空格。

  1. <decorator:usePage id="..." />  

象jsp頁面中的<jsp:useBean>標簽一樣，可以使用被包裝為一個Page對象的頁面。 (懶的用)

例：可用<decorator:usePage id="page" /> ：<%=page.getTitle()%>達到<decorator:title/>的訪問結果。

  1. <page:applyDecorator name="..." [ page="..." title="..." ] >  
  2. <page:param name="..."> ... </page:param>  
  3. <page:param name="..."> ... </page:param>  
  4. </page:applyDecorator>  

應用包裝器到指定的頁面上，一般用于被包裝頁面中主動應用包裝器。這個標簽有點不好理解，我們來看一個例子：

包裝器頁面 /decorators/panel.jsp：

  1. <p><decorator:title /></p>     ... <p><decorator:body /></p>  

     并且在decorators.xml中有<decorator name="panel" page="panel.jsp"/>

一個公共頁面，即將被panel包裝：/public/date.jsp: 

  1. ... <%=new java.util.Date()%>     ...<decorator:getProperty property="myEmail" />  

被包裝頁面 /page.jsp ：

  1. <title>page的應用</title>    
  2. .....     
  3. <page:applyDecorator name="panel" page="/_public/date.jsp" >  
  4.   <page:param name="myEmail"> chen_p@neusoft.com </page:param>  
  5. </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中設置：

  1. <mapper class="com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper">  
  2.   <param name="decorator" value="printable" />  
  3.   <param name="parameter.name" value="printable" />  
  4.   <param name="parameter.value" value="true" />  
  5. </mapper>  

這樣就可以通過?printable=true來使用名為printable的裝飾器，而不是用原來的裝飾器。

2.在WEB-INFO/decorators.xml中定義相應的printable裝飾器

  1. <decorator name="printable" page="printable.jsp"/>  

3.最后編寫printable裝飾器/decorators/printable.jsp

  1. <%@ taglib uri="sitemesh-decorator" prefix="decorator" %>  
  2. <html>  
  3. <head>  
  4.      <title><decorator:title /></title>  
  5.      <decorator:head />  
  6. </head>  
  7. <body>  
  8.   
  9.      <h1><decorator:title /></h1>  
  10.      <p align="right"><i>(printable version)</i></p>  
  11.   
  12.      <decorator:body />  
  13.   
  14. </body>  
  15. </html>    
  16.   

這樣就可以讓一個原始頁面通過?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 ，可以看看辛勤的成果了 :)
 


本文來自CSDN博客，轉載請標明出處：http://blog.csdn.net/gotohbu/archive/2009/08/11/4435520.aspx

 本文由用戶 openkk 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。
 轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。
 本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！