首頁 > 其他

SiteMesh學習入門

來源：互聯網
上載者：User
創建阿里雲帳戶，並獲得超過 40 款產品的免費試用版；而企業帳戶則可以享有總值 $1200 的免費試用版。立即註冊！

簡介：

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/j2ee http://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描述各裝飾器頁面。

<decorators defaultdir="/decorators">
<decorator name="main" page="main.jsp">
<pattern>*</pattern>
</decorator>
</decorators>

上面設定檔指定了裝飾器頁面所在的路徑，並指定了一個名為main的裝飾器，該裝飾器預設裝飾web應用根路徑下的所有頁面。

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

#
<%@ 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>

五、建立一個的被裝飾頁面

#
<%@ 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種資訊:

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）：範例：

<sitemesh>
<page-parsers>
<parser default="true" class="com.opensymphony.module.sitemesh.parser.DefaultPageParser" />
<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 ，可以看看辛勤的成果了

本文章原先以中文撰寫並發佈於 aliyun.com，亦設英文版本，僅作資訊用途。本網站不對文章的準確性，完整性或可靠性或其任何翻譯作出任何明示或暗示的陳述或保證。如對該文章有任何疑慮或投訴，請傳送電郵至 info-contact@alibabacloud.com 並提供相關疑慮或投訴的詳細說明。職員會於 5 個工作天內與您聯絡，一經驗證之後，即會刪除該侵權內容。

聯繫我們

該頁面正文內容均來源於網絡整理，並不代表阿里雲官方的觀點，該頁面所提到的產品和服務也與阿里云無關，如果該頁面內容對您造成了困擾，歡迎寫郵件給我們，收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容，歡迎發送郵件至： info-contact@alibabacloud.com 進行舉報並提供相關證據，工作人員會在 5 個工作天內聯絡您，一經查實，本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

Get Started for Free

  • Sales Support

    1 on 1 presale consultation

    Chat Contact Sales

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

    Open a Ticket

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.

    Learn More