使用sitemesh建立複合檢視

maqianmaqian發表於2010-09-16
使用sitemesh建立複合檢視 sitemesh是opensymphony團隊開發的j2ee應用框架之一，旨在提高頁面的可維護性和複用性。opensymphony的另一個廣為人知的框架為webwork是用作web層的表示框架。他們都是開源的，可以在www.sf.net下找到。 應用於以下大專案的例子：http://opensource.thoughtworks.com/projects/sitemesh.html http://www.jboss.org/ http://www.theserverside.com/ http://www.opensymphony.com/ http://www.atlassian.com/ 簡介： sitemesh應用Decorator模式，用filter擷取request和response,把頁面元件head,content,banner結合為一個完整的檢視。通常我們都是用include標籤在每個jsp頁面中來不斷的包含各種header, stylesheet, scripts and footer，現在，在sitemesh的幫助下，我們可以開心的刪掉他們了。如下圖，你想輕鬆的達到複合檢視模式，那末看完本文吧。 　 hello sitemesh： 在WEB-INF/web.xml中copy以下filter的定義: <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><taglib><taglib-uri>sitemesh-decorator</taglib-uri><taglib-location>/WEB-INF/sitemesh-decorator.tld</taglib-location></taglib><taglib><taglib-uri>sitemesh-page</taglib-uri><taglib-location>/WEB-INF/sitemesh-page.tld</taglib-location></taglib> copy所需jar和dtd檔案至相應目錄，訪問opensymphony.sourceforge.net的cvs以獲取sitemesh最新版本。 sitemesh.jar WEB-INF/lib sitemesh-decorator.tld WEB-INF sitemesh-page.tld WEB-INF 建立WEB-INF/decorators.xml描述各裝飾器頁面(可仿照sitemesh例子)。 <decorators defaultdir="/_decorators"><decorator name="main" page="main.jsp"><pattern>*</pattern></decorator></decorators> 建立裝飾器頁面 /_decorators/main.jsp <head></head> sitemesh的例子
<body></body>
chen56@msn.com 建立一個的被裝飾頁面 /index.jsp(內容頁面) Agent Test

本頁只有一句，就是本句.

最後訪問index.jsp，將生成如下頁面： 而且，所有的頁面也會如同index.jsp一樣，被sitemesh的filter使用裝飾模式修改成如上圖般模樣，卻不用再使用include標籤。 裝飾器 decorator概念 建立可複用的web應用程式,一個通用的方法是建立一個分層系統，如同下面一個普通的web應用： 前端，front-end: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, copy到WEB-INF中的sitemesh-decorator.tld,sitemesh-page.tld檔案外，還有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><parser content-type="text/html" class="com.opensymphony.module.sitemesh.parser.FastPageParser"></parser><parser content-type="text/html;charset=ISO-8859-1" class="com.opensymphony.module.sitemesh.parser.FastPageParser"></parser></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"></decorator></decorators> defaultdir: 包含裝飾器頁面的目錄 page : 頁面檔名 name : 別名 role : 角色，用於安全 webapp : 可以另外指定此檔案存放目錄 Patterns : 匹配的路徑，可以用*,那些被訪問的頁面需要被裝飾。 　 最重要的是寫出裝飾器本身(也就是那些要複用頁面，和結構頁面)。 其實，重要的工作就是製作裝飾器頁面本身(也就是包含結構和規則的頁面)，然後把他們描述到decorators.xml中。 讓我們來先看一看最簡單的用法：其實最常用也最簡單的用法就是我們的hello例子，面對如此眾多的技術，我想只要達到功能點到為止即可，沒必要去研究太深(除非您有更深的需求)。 <head></head> sitemesh的例子
<body></body>
chen56@msn.com 我們在裝飾器頁面只用了2個標籤： ： 把請求的原始頁面的title內容插入到中間。 <body></body> ： 把請求的原始頁面的body內的全部內容插入到相應位置。 然後我們在decorator.xml中加入以下描述即可： <decorator name="main" page="main.jsp"><pattern>*</pattern></decorator> 這樣，請求的所有頁面都會被重新處理，並按照main.jsp的格式重新展現在你面前。 　 讓我們看看更多的用法。(抄襲sitemesh文件) 以下列著全部標籤： Decorator Tags Page Tags 被用於建立裝飾器頁面. 被用於從原始內容頁面訪問裝飾器. <head></head> <body></body> <getproperty></getproperty><usepage></usepage><applydecorator></applydecorator> 插入原始頁面(被包裝頁面)的head標籤中的內容(不包括head標籤本身)。 <body></body> 插入原始頁面(被包裝頁面)的body標籤中的內容。 插入原始頁面(被包裝頁面)的title標籤中的內容，還可以新增一個預設值。 例： /_decorator/main.jsp中 （裝飾器頁面）: - 附加標題 /aaa.jsp中 (原始頁面)：aaa頁面 訪問/aaa.jsp的結果：aaa頁面 - 附加標題<getproperty property="..." default="..." writeentireproperty="..."></getproperty> 在標籤處插入原始頁面(被包裝頁面)的原有的標籤的屬性中的內容，還可以新增一個預設值。 sitemesh文件中的例子很好理解： The decorator:

相關文章