簡介: | |||
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描述各裝飾器頁面。
上面配置文件指定了裝飾器頁面所在的路徑,並指定了一個名爲main的裝飾器,該裝飾器默認裝飾web應用根路徑下的所有頁面。
四、 建立裝飾器頁面 /decorators/main.jsp
五、建立一個的被裝飾頁面 /index.jsp(內容頁面)
最後訪問index.jsp,將生成如下頁面:
而且,所有的頁面也會如同index.jsp一樣,被sitemesh的filter使用裝飾模式修改成如上圖般模樣,卻不用再使用include標籤。
|
裝飾器 decorator概念 | ||||||
爲了建立可複用的web應用程序,一個通用的方法是建立一個分層系統,如同下面一個普通的web應用:
可糟糕的是前端的頁面邏輯很難被複用,當你在每一個頁面中用數之不盡的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 可以設置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): 範例:
decorators.xml :定義構成複合視圖的所有頁面構件的描述(主要結構頁面,header,footer...),如下例:
|
||||||
最重要的是寫出裝飾器本身(也就是那些要複用頁面,和結構頁面)。 | ||||||
其實,重要的工作就是製作裝飾器頁面本身(也就是包含結構和規則的頁面),然後把他們描述到decorators.xml中。
讓我們來先看一看最簡單的用法:其實最常用也最簡單的用法就是我們的hello例子,面對如此衆多的技術,我想只要達到功能點到爲止即可,沒必要去研究太深(除非您有更深的需求)。
我們在裝飾器頁面只用了2個標籤:
<decorator:title default="裝飾器頁面..." /> : 把請求的原始頁面的title內容插入到<title></title>中間。
<decorator:body /> : 把請求的原始頁面的body內的全部內容插入到相應位置。
然後我們在decorator.xml中加入以下描述即可:
<decorator name="main" page="main.jsp">
<pattern>*</pattern> </decorator> 這樣,請求的所有頁面都會被重新處理,並按照main.jsp的格式重新展現在你面前。
|
||||||
讓我們看看更多的用法。(抄襲sitemesh文檔) | ||||||
以下列着全部標籤:
插入原始頁面(被包裝頁面)的head標籤中的內容(不包括head標籤本身)。
<decorator:body />
插入原始頁面(被包裝頁面)的body標籤中的內容。
插入原始頁面(被包裝頁面)的title標籤中的內容,還可以添加一個缺省值。
例:
/aaa.jsp中 (原始頁面):<title>aaa頁面</title>
在標籤處插入原始頁面(被包裝頁面)的原有的標籤的屬性中的內容,還可以添加一個缺省值。
sitemesh文檔中的例子很好理解:
The decorator: <body bgcolor="white"<decorator:getProperty property="body. 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對象的頁面。 (懶的用) <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"> [email protected] </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內容。
|
可打印的界面裝飾 | |
前面說過有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
這樣就可以讓一個原始頁面通過?printable=true開關來切換不同的裝飾器頁面。
|
中文問題 |
由於sitemesh內部所使用的缺省字符集爲iso-8859-1,直接使用會產生亂碼,我們可以通過以下方法糾正之:
|
總結:使用sitemesh最通常的途徑: |
1.配置好環境,
2.在WEB-INFO/decroators.xml中描述你將建立的包裝器。
3.開發在decroators.xml中描述的包裝器,最好存放在/_decorators目錄下
4.ok ,可以看看辛勤的成果了 :)
|