SiteMesh介绍

SiteMesh介绍（转）

以前我通常使用旧式的方法来建立自己的web应用：手工排版，仔细使用每一个字节使其工作在Unicode下，同时使用make文件来适应不同的CPU……

或许现在我们可以换一种方式。

尽管我从没有感觉到需要使用assembly (CISC or RISC)来建立web应用，但也会偶尔觉得我的开发伙伴的工作相当繁琐。特别是我发现很多的开发者在痛苦的寻求一种比较好的方式来控制web应用的基本模块：例如那些

1 页头
2 页尾
3 导航栏
4 打印页面
5 手持设备的轻量级页面

以及其他更多的问题。到了最后，令人惊异的是大部分人都采用了落后的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），

1 < decorator:title >  
2 < decorator:body >

 不要惊讶于标签<decorator:title>在原始页面中显示<title>标签中的内容， <decorator:body> 中的内容也是如此。我们在这个页面的HEAD和BODY元素都使用了同一个title标签,同时，我们还增加了一个到可打印版本页面的链接。

作为对照，图三显示了原始处理页面，图四显示了被修饰过的处理页面。留意被装饰页面在浏览器窗口显示的标题文字和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解开后的内容

我们花点时间描述一下这些文件的作用。

1  :  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 >  
     < 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 >  
</ web - app >  

注意：这里需要注意一下url-pattern的写法-- 如果使用的是Tomcat 5（而不是 Tomcat 4 ），需要将默认的*修改如*.jsp的形式。最新的servlet规范不再支持*样式。

2 : decorators.xml

WEB-INF/decorators.xml 文件用来将一个装饰器名字同一个专门的JSP装饰文件绑定

< 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），它将被默认运用于所有文件。

2.1  :   缺省的，SiteMesh使用下面的逻辑来选择使用哪一个装饰器：

 

这个逻辑在sitemesh-2.0.1.jar 包的 \com\opensymphony\module\sitemesh\factor\sitemesh-default.xml 文件里被描述。

sitemesh-default.xml  :

< sitemesh >
     < property name = " decorators-file "  value = " /WEB-INF/decorators.xml " />
     < excludes file = " ${decorators-file} " />

     < page - parsers >
         < parser content - type = " text/html "   class = " com.opensymphony.module.sitemesh.parser.FastPageParser "   />
     </ page - parsers >
     < decorator - mappers >

            //页面是否使用meta装饰器标签（meta decorator tag）特别指定了一个装饰器？
         < mapper  class = " com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper " >
             < param name = " property.1 "  value = " meta.decorator "   />
             < param name = " property.2 "  value = " decorator "   />
         </ mapper >

            //页面是否是一个框架集（是的话则不应用装饰器）？
         < mapper  class = " com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper " />

            //页面是否使用了printable=true 参数（是的话则使用打印装饰器）
         < 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 >

            //页面时候使用装饰器文件名特别指定了一个装饰器
         < mapper  class = " com.opensymphony.module.sitemesh.mapper.FileDecoratorMapper " />

            //页面是否匹配 decorators.xml 文件里描述的样式？
         < mapper  class = " com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper " >
             < param name = " config "  value = " ${decorators-file} "   />
         </ mapper >

     </ decorator - mappers >
</ sitemesh >

你可以针对诸如：客户端操作系统，web浏览器，用户代理等在WEB-INF\sitemesh.xml文件里，通过一个变量覆盖这个行为, 可以在sitemesh-example.war 找到例子。

通常第一条规则仅用来确定该装饰器是否被使用（Conceptually, the first rule that evaluates to true determines the decorator that is used. ）在上面的例子中，当出现printable=true 参数的时候，装饰器printable.jsp （规则 #3）替代了 main.jsp （规则 #5）。在SiteMesh中，这些规则被描述为 mappers。

3 :  decorators/*.jsp

这三个decorators目录下的文件是decorators.xml文件中描述的不同装饰器JSP文件。上面是一个简单的装饰器例子，在后面我们将讨论更复杂的示例。

4 :  sitemesh-2.0.1.jar

这是SiteMesh最主要的二进制文件，通常被安装在 WEB-INF/lib 目录下。可以在www.opensymphony.com/sitemesh/api 找到这个库的javadoc。

*.tld

SiteMesh使用两个标签库，但大多数人都只需要sitemesh-decorator.tld。还有一个是 ：sitemesh-page.tld 你可以在 www.opensymphony.com/sitemesh/tags.html 找到相应的文档。我们已经讲述了最主要的标签：head，title和body。在下一章我们来讨论剩下的标签：getProperty。