http://www.iocblog.net/static/2007/569.html
注:sitemesh,一個不錯的tiles替代方案,比tiles做的更漂亮優雅。本文是sitemesh官方推薦的入門文檔,本來想自己翻譯的,突然發現有人先行一步了,就轉過來看吧。
以前我通常使用舊式的方法來建立自己的web應用:手工排版,仔細使用每一個字節使其工作在Unicode下,同時使用make文件來適應不同的CPU……
或許現在我們可以換一種方式。
盡管我從沒有感覺到需要使用assembly (CISC or
RISC)來建立web應用,但也會偶爾覺得我的開發伙伴的工作相當繁瑣。特別是我發現很多的開發者在痛苦的尋求一種比較好的方式來控制web應用的基本模塊:例如那些頁頭、頁尾、導航欄、打印頁面、手持設備的輕量級頁面,以及其他更多的問題。到了最后,令人驚異的是大部分人都采用了落后的
includes和復制粘貼方式。
根據經驗,我可以采用在 java.net 上開源的servlet 過濾器 SiteMeshn
來簡單明了并優雅的解決這些問題。作為一種替代新的templating語言(XSLT)或部署您的頁面到新的系統的解決方法,應用SiteMesh可以相當容易處理你的頁面,這一切只需要普通的HTML,JSP,servlet(包括Struts),以及其他常用的技術。
工作原理
SiteMesh
利用了一種很少人知道的servlet規范實現了一種頁面過濾器。設想一下,現在有一個簡單的jsp頁面用來返回當前的日期和時間。通常這個頁面請求來到應用服務器,頁面被處理,最后處理結果返回到web瀏覽器。SiteMesh作為一個頁面過濾器,在頁面被處理之后,返回web瀏覽器之前,對頁面做了一些附加的操作。這個變化簡單描述為圖一和圖二所示的附加步驟。

圖一:普通頁面處理情況

圖二:SiteMesh對頁面處理情況
現在看一個簡單的例子。
<html>
<head>
<title>Simple Document</title>
</head>
<body>
Hello World! <br />
<%= 1+1 %>
</body>
</html>
你會發現這個頁面有一個title和body(類似普通的HTML頁面)。你也會發現一小段JSP代碼——它將會如同你期望的那樣被處理。同時你可以使用任何你想使用的JSP語法和特性來替換這一小段代碼。
現在來看一個簡單的SiteMesh "裝飾(decorator)"頁面。列表2顯示了一個被SiteMesh調用的JSP頁面。
<%@ taglib uri="sitemesh-decorator"
prefix="decorator" %>
<html>
<head>
<title>
My Site - <decorator:title default="Welcome!" />
</title>
<decorator:head />
</head>
<body>
<h1><decorator:title default="Welcome!" /></h1>
<p><decorator:body /></p>
<p><small>
(<a
href="?printable=true">printable version</a>
</small></p>
</body>
</html>
查看這個裝飾器(decorator),我們能看到一些有趣的東西。首先,在第一行申明了一個SiteMesh標簽庫。這個標簽庫包含了與原始頁面一起工作時所需的所有東西。你能看到我們使用了兩個SiteMesh的裝飾標簽(declared
tags), <decorator:title>
和 <decorator:body>
。不要驚訝于標簽<decorator:title>在原始頁面中顯示<title>標簽中的內容, <decorator:body>
中的內容也是如此。我們在這個頁面的HEAD和BODY元素都使用了同一個title標簽。(We're making a few fairly radical
changes to the page, including repeating the title both in the HEAD
element as well as the BODY
. )同時,我們還增加了一個到可打印版本頁面的鏈接。
作為對照,圖三顯示了原始處理頁面,圖四顯示了被修飾過的處理頁面。留意被裝飾頁面在瀏覽器窗口顯示的標題文字和HTML內容。同時也可以看到增加了一個可打印頁面的鏈接——這個我們回頭再說。

圖三:原始未修飾頁面

圖四:被修飾頁面
很明顯,對比起使用include(例如<jsp:include page="foo.jsp"
flush="true"
/>)來說,以這樣的方式使用頁頭、頁尾系統結構要清晰得多。這種方式更易移植、更易理解,同時也鼓勵了JSP頁面不再使用導航或其他類似的表現層代碼。我發現在JSP頁面中使用裝飾器和CSS的組合比標準HTML的標簽更容易去除格式信息。
安裝SiteMesh
注意下面的屏幕截圖是基于Windows XP Professional, Tomcat 5.0.19,和Java 2 SDK
1.4.2_03的環境之上的。在這里我假定你的Tomcat已經安裝完畢并且可以正常工作了。你或許會有一些混淆,但我們已經成功地在Tomcat 4.1 和
WebLogic 測試過,同時 SiteMesh 也支持大部分的web應用服務器。
本文描述的SiteMesh 2.0.1可以在 下載到。
在java.net 上SiteMesh's 的項目庫中有四個文件可以下載。sitemesh-2.0.1.jar 是其核心 JAR 文件,
sitemesh-2.0.1-sources.zip 的作用正如同其名字所述, sitemesh-example.war
則提供了一個復雜的例子用來顯示一些SiteMesh的高級特性。
為了使描述更加簡單,我們從sitemesh-blank.war
文件開始。將該WAR文件放入Tomcat 的webapps
目錄,WAR包將自動解壓顯示內容(SoSo注:這里的前提是你的tomcat已經開始工作),如圖五所示。

圖五: SiteMesh_blank.WAR解開后的內容
我們花點時間描述一下這些文件的作用。
web.xml
首先,WEB-INF/web.xml 文件顯示如列表3,這些語句用來安裝SiteMesh
過濾器和標簽庫。如果你決定在一個已有的Web應用中使用SiteMesh,你必須把這些語句添加到你的WEB-INF/web.xml
文件中。
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- Start of SiteMesh stuff -->
<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>*.jsp</url-pattern>
</filter-mapping>
<taglib>
<taglib-uri>sitemesh-page</taglib-uri>
<taglib-location>/WEB-INF/sitemesh-page.tld</taglib-location>
</taglib>
<taglib>
<taglib-uri>sitemesh-decorator</taglib-uri>
<taglib-location>/WEB-INF/sitemesh-decorator.tld</taglib-location>
</taglib>
<!-- End of SiteMesh stuff -->
</web-app>
注意:這里需要注意一下url-pattern
的寫法-- 如果使用的是Tomcat
5(而不是 Tomcat 4 ),需要將默認的*修改如*.jsp的形式。最新的servlet規范不再支持*樣式。
decorators.xml
WEB-INF/decorators.xml
文件用來將一個裝飾器名字同一個專門的JSP裝飾文件綁定。作為一個例子,這里將JSP裝飾文件minimal.jsp同一個稱為handheld的裝飾器綁定起來。
<decorators defaultdir="/decorators">
<decorator name="main" page="main.jsp">
<pattern>*</pattern>
</decorator>
<decorator name="panel" page="panel.jsp"/>
<decorator name="printable" page="printable.jsp"/>
</decorators>
正如我們在代碼列表里看到的一樣,我們定義了三個裝飾器,他們分別綁定了三個類似的JSP頁面。我們可以看到一個默認裝飾器(main.jsp),它將被默認運用于所有文件。
缺省的,SiteMesh使用下面的邏輯來選擇使用哪一個裝飾器:
這個邏輯在sitemesh-2.0.1.jar 包的
\com\opensymphony\module\sitemesh\factor\sitemesh-default.xml
文件里被描述。你可以針對諸如:客戶端操作系統,web瀏覽器,用戶代理等在WEB-INF\sitemesh.xml文件里,通過一個變量覆蓋這個行為。(You
can override this behavior with a wide variety of built-in
mappers for things like language, client operating system, web browser/user
agent, etc. by creating a WEB-INF\sitemesh.xml file.
)可以在sitemesh-example.war 找到例子。
|
- 頁面是否使用meta裝飾器標簽(meta decorator tag)特別指定了一個裝飾器?
- 頁面是否是一個框架集(是的話則不應用裝飾器)?
- 頁面是否使用了
printable=true
參數(是的話則使用打印裝飾器)
- 頁面時候使用裝飾器文件名特別指定了一個裝飾器?
- 頁面是否匹配 decorators.xml 文件里描述的樣式?
通常第一條規則僅用來確定該裝飾器是否被使用(Conceptually, the first rule that evaluates to true
determines the decorator that is used. )在上面的例子中,當出現printable=true
參數的時候,裝飾器printable.jsp
(規則 #3)替代了 main.jsp
(規則 #5)。在SiteMesh中,這些規則被描述為
mappers。
decorators/*.jsp
這三個decorators目錄下的文件是decorators.xml文件中描述的不同裝飾器JSP文件。上面是一個簡單的裝飾器例子,在后面我們將討論更復雜的示例。
sitemesh-2.0.1.jar
這是SiteMesh最主要的二進制文件,通常被安裝在 WEB-INF/lib 目錄下。可以在www.opensymphony.com/sitemesh/api
找到這個庫的javadoc。
*.tld
SiteMesh使用兩個標簽庫,但大多數人都只需要sitemesh-decorator.tld。你可以在 www.opensymphony.com/sitemesh/tags.html
找到相應的文檔。我們已經講述了最主要的標簽:head,title和body。在下一章我們來討論剩下的標簽:getProperty。
SiteMesh高級特性
SiteMesh的一個重要特性是使用原始HTML的meta標簽(例如<meta
name="foo"
content="bar">)從基礎頁面傳遞信息到裝飾器。作為一個例子,下面我們使用一個meta標簽來定義HTML頁面的作者。
<html>
<meta name="author" content="test@example.com">
<head>
<title>Simple Document</title>
</head>
<body>
Hello World! <br />
<%= 1+1 %>
</body>
</html>
我們定義一個“smart”裝飾器來研究meta標簽,如果出現這個標簽,則可以得到一個相應的HTML:
<%@ taglib uri="sitemesh-decorator" prefix="decorator" %>
<decorator:usePage id="myPage" />
<html>
<head>
<title>My Site -
<decorator:title default="Welcome!" />
</title>
<decorator:head />
</head>
<body>
<h1><decorator:title default="Welcome!" /></h1>
<h3>
<a href="mailto:<decorator:getProperty property="meta.author"
default="staff@example.com" />">
<decorator:getProperty property="meta.author"
default="staff@example.com" />
</a></h3><hr />
<decorator:body />
<p><small>
(<a href="?printable=true">printable version</a>
</small>
</p>
</body>
</html>
可以看到我們使用了getProperty標簽的一個默認屬性——如果沒有指定author,我們就設定其為staff。如果你決定使用這個模型儲存頁面的meta數據,你或許需要和你的開發伙伴一起來確定將使用什么標簽以及如何使用他們。簡單的,你或許想要使用meta標簽來描述諸如頁面作者及時間戳之類的東西。更復雜一些,你或許會想像XML文件一樣標準化的管理你的站點導航,同時使用meta標簽來通過頁面節點轉到裝飾器。(At
the complex end, you may do things like standardize on an XML file to manage
your site navigation and use a meta
tag to
pass the page's node to the decorator. )
圖六顯示了應用上面的裝飾器JSP頁面之后生成的結果。

圖六:meta標簽顯示
這些頁面屬性非常強大,并且擁有著很多不同的特性,并不僅止于meta標簽(
常用頁面特性列表)。使用SiteMesh一段時間之后,你就會開始思考HTML和JSP作為一種簡單標記語言的機制——接近最原始的HTML——無需操作就可以完整的切換到XML/XSL
或其他模版引擎。
小結
綜上所述,SiteMesh
提供了一個強大、易用、易結合的機制來使用頁面模版。可以想象,它將會有很廣泛的用戶群。例如,你可以定義一個裝飾器針對不同的瀏覽器輸出額外的頁面調試信息(和特定web瀏覽器結合之后將產生一個特別的功能,你可以強制指定使用某一種用戶代理)。你也可以定義一個裝飾器產生stripped-down
XML輸出,用來進行簡單的自動化測試。你甚至可以使用裝飾器從其他頁面提取內容,例如輸出到一些簡單的門戶容器。
從sitemesh-blank.war入手比較容易,但我建議學習 sitemesh-example.war
以獲取更多的特性和思想。
不論你如何使用SiteMesh,我都發現它將大量的代碼從表現層中移到我的裝飾器中,而無需學習一種新的編程語言或是模版系統。
對了,作為最后的補充,如果你仍然對組合建立web頁面感興趣,可以查看home.worldonline.dk/viksoe/asmil.htm
。
祝好運并享受編程的樂趣!