Sitemesh 3 的使用及配置

1 . Sitemesh 3 簡介

Sitemesh 是一個網頁佈局和修飾的框架,基於 Servlet 中的 Filter,類似於 ASP.NET 中的‘母版頁’技術。參考:百度百科,相關類似技術:Apache Tiles

官網:http://wiki.sitemesh.org/wiki/display/sitemesh/Home 。

2 . Sitemesh 3 下載

最新版本:3.0.0-SNAPSHOT

① GitHub 地址:https://github.com/sitemesh/sitemesh3

② maven:

1 <dependency>
2   <groupId>org.sitemesh</groupId>
3   <artifactId>sitemesh</artifactId>
4   <version>3.0.0</version>
5 </dependency>

3 . 配置 Sitemesh 3 過濾器

在 web.xml 中添加 Sitemesh Filter: 

複製代碼
 1 <web-app>
 2 
 3   ...
 4 
 5   <filter>
 6     <filter-name>sitemesh</filter-name>
 7     <filter-class>org.sitemesh.config.ConfigurableSiteMeshFilter</filter-class>
 8   </filter>
 9   <filter-mapping>
10     <filter-name>sitemesh</filter-name>
11     <url-pattern>/*</url-pattern>
12   </filter-mapping>
13   
14 </web-app>
複製代碼

4 . 準備兩個頁面:demo.html 和 decorator.html

① demo.html - “被裝飾的頁面”,實際要呈現的內容頁。

複製代碼
1 <!DOCTYPE html>
2 <html>
3 <head>
4     <title>內容頁的標題</title>
5 </head>
6 <body>
7     內容頁的body部分
8 </body>
9 </html>
複製代碼

② decorator.html - “裝飾頁面”,所謂的“母版頁”。

複製代碼
 1 <!DOCTYPE html>
 2 <html>
 3 <head>
 4 <title>
 5     <sitemesh:write property='title' /> - ltcms
 6 </title>
 7 <sitemesh:write property='head' />
 8 </head>
 9 <body>
10     <header>header</header>
11     <hr />
12     demo.html的title將被填充到這兒:
13     <sitemesh:write property='title' /><br />
14     demo.html的body將被填充到這兒:
15     <sitemesh:write property='body' />
16     <hr />
17     <footer>footer</footer>
18 </body>
19 </html>
複製代碼

5 . 添加 /WEB-INF/sitemesh3.xml

複製代碼
1 <?xml version="1.0" encoding="UTF-8"?>
2 <sitemesh>
3     <!-- 指明滿足“/*”的頁面,將被“/WEB-INF/views/decorators/decorator.html”所裝飾 -->
4     <mapping path="/*" decorator="/WEB-INF/views/decorators/decorator.html" />
5 
6     <!-- 指明滿足“/exclude.jsp*”的頁面,將被排除,不被裝飾 -->
7     <mapping path="/exclude.jsp*" exclue="true" />
8 </sitemesh>
複製代碼

6 . 運行效果

訪問 demo.html 頁面,實際效果如下:

7 . sitemesh3.xml 配置詳解

複製代碼
 1 <sitemesh>
 2     <!--默認情況下,
 3         sitemesh 只對 HTTP 響應頭中 Content-Type 爲 text/html 的類型進行攔截和裝飾,
 4         我們可以添加更多的 mime 類型-->
 5   <mime-type>text/html</mime-type>
 6   <mime-type>application/vnd.wap.xhtml+xml</mime-type>
 7   <mime-type>application/xhtml+xml</mime-type>
 8   ...
 9   
10   <!-- 默認裝飾器,當下面的路徑都不匹配時,啓用該裝飾器進行裝飾 -->
11   <mapping decorator="/default-decorator.html"/>
12   
13   <!-- 對不同的路徑,啓用不同的裝飾器 -->
14   <mapping path="/admin/*" decorator="/another-decorator.html"/>
15   <mapping path="/*.special.jsp" decorator="/special-decorator.html"/>
16 
17   <!-- 對同一路徑,啓用多個裝飾器 -->
18   <mapping>
19     <path>/articles/*</path>
20     <decorator>/decorators/article.html</decorator>
21     <decorator>/decorators/two-page-layout.html</decorator>
22     <decorator>/decorators/common.html</decorator>
23   </mapping>
24 
25   <!-- 排除,不進行裝飾的路徑 -->
26   <mapping path="/javadoc/*" exclue="true"/>
27   <mapping path="/brochures/*" exclue="true"/>
28   
29   <!-- 自定義 tag 規則 -->
30   <content-processor>
31     <tag-rule-bundle class="com.something.CssCompressingBundle" />
32     <tag-rule-bundle class="com.something.LinkRewritingBundle"/>
33   </content-processor>
34   ...
35 
36 </sitemesh>
複製代碼

8 . 自定義 tag 規則

Sitemesh 3 默認只提供了 body,title,head 等 tag 類型,我們可以通過實現 TagRuleBundle 擴展自定義的 tag 規則:

複製代碼
 1 public class MyTagRuleBundle implements TagRuleBundle {
 2     @Override
 3     public void install(State defaultState, ContentProperty contentProperty,
 4             SiteMeshContext siteMeshContext) {
 5         defaultState.addRule("myHeader", new ExportTagToContentRule(contentProperty.getChild("myHeader"), false));
 6         
 7     }
 8     
 9     @Override
10     public void cleanUp(State defaultState, ContentProperty contentProperty,
11             SiteMeshContext siteMeshContext) {
12     }
13 }
複製代碼

最後在 sitemesh3.xml 中配置即可:

1 <content-processor>
2     <tag-rule-bundle class="com.lt.common.ext.sitemesh3.MyTagRuleBundle" />
3 </content-processor>

 


轉自:http://www.cnblogs.com/luotaoyeah/p/3776879.html

發佈了56 篇原創文章 · 獲贊 14 · 訪問量 7萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章