`

SiteMesh在java中的简单使用

SiteMesh在java中的简单使用 
阅读更多

转载自：http://www.blogjava.net/shiwenfeng/archive/2009/10/27/299925.html

 

Site Mesh是open symphony团队开发的j2ee应用框架之一，是一个用来在JSP中实现页面布局和装饰（layout and decoration）的框架组件，能够帮助网站开发人员较容易实现页面中动态内容和静态装饰外观的分离，旨在提高页面的可维护性和复用性。Site Mesh是开源的，可以在www.sf.net下找到。
           Site mesh应用Decorator模式，用filter截取request和response,把页面组件head ,content ,banner结合为一个完整的视图。通常我们都是用include标签在每个jsp页面中来不断的包含各种header, style sheet, scripts and footer，现在，在site mesh的帮助下，我们可以删除他们了。下面是一个使用SiteMesh实现页面内容的简单事例(参考的是其他网络上的帖子)。需要的文件有：

 

sitemesh.jar
WEB-INF/lib
sitemesh-decorator.tld
WEB-INF
sitemesh-page.tld
WEB-INF

 

Web.xml中的写法： 

[html] view plaincopy
  1. <!-- Sitemesh filter -->  
  2.     <filter>  
  3.         <filter-name>sitemeshFilter</filter-name>  
  4.         <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>  
  5.     </filter>  
  6.     <filter-mapping>  
  7.         <filter-name>sitemeshFilter</filter-name>  
  8.         <url-pattern>/*</url-pattern>  
  9.     </filter-mapping>  

配置文件：

 

[html] view plaincopy
  1. <sitemesh>  
  2.   <mapping path="/*" decorator="/decorator.html"/>  
  3. </sitemesh>  



 

decorator文件的写法

 

 

[html] view plaincopy
  1. <?xml version="1.0" encoding="UTF-8"?>  
  2. <decorators defaultdir="/WEB-INF/layouts/">  
  3.     <excludes>  
  4.         <pattern>/static/*</pattern>  
  5.     </excludes>  
  6.       
  7.     <decorator name="default" page="default.jsp">  
  8.         <pattern>/*</pattern>  
  9.     </decorator>  
  10. </decorators>  


excludes标签中的内容是不需要装饰的目录或文件。

 

装饰模板网页文件的写法：

 

[html] view plaincopy
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
  2. <html>  
  3. <head>  
  4. <title>Mini-Web示例:<sitemesh:title/></title>  
  5. <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />  
  6. <meta http-equiv="Cache-Control" content="no-store" />  
  7. <meta http-equiv="Pragma" content="no-cache" />  
  8. <meta http-equiv="Expires" content="0" />  
  9.   
  10. <sitemesh:head/>  
  11. </head>  
  12.   
  13. <body>  
  14.     <div class="container">  
  15.         <%@ include file="/WEB-INF/layouts/header.jsp"%>  
  16.         <div id="content" class="span-24 last">  
  17.                 <sitemesh:body/>  
  18.         </div>  
  19.         <%@ include file="/WEB-INF/layouts/footer.jsp"%>  
  20.     </div>  
  21. </body>  
  22. </html>  

 

填入到模板文件中网页：

 

[html] view plaincopy
  1. <%@ page contentType="text/html; charset=GBK"%>  
  2. <html>  
  3.      <head>  
  4.        <title>Agent Test</title>  
  5.      </head>  
  6.      <body>  
  7.        <p>本页只有一句，就是本句.</p>  
  8.      </body>  
  9. </html>  


SiteMesh介绍：

 

 

简介：
    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描述各装饰器页面。 

<decorators defaultdir="/decorators">
       <decorator name="main" page="main.jsp">
           <pattern>*</pattern>
       </decorator>
</decorators>

  上面配置文件指定了装饰器页面所在的路径，并指定了一个名为main的装饰器，该装饰器默认装饰web应用根路径下的所有页面。

四、 建立装饰器页面 /decorators/main.jsp

  • <%@ page contentType="text/html; charset=GBK"%>
    <%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator"%> <html>
    <head>
    <title><decorator:title default="装饰器页面..." /></title>
    <decorator:head />
    </head>
    <body>
    sitemesh的例子<hr>
    <decorator:body />
            <hr>chen56@msn.com
    </body>
    </html>
     

    五、建立一个的被装饰页面 /index.jsp(内容页面)

  • <%@ page contentType="text/html; charset=GBK"%>
<html>
     <head>
       <title>Agent Test</title>
     </head>
     <body>
       <p>本页只有一句，就是本句.</p>
     </body>
</html>

    最后访问index.jsp，将生成如下页面：

        而且，所有的页面也会如同index.jsp一样，被sitemesh的filter使用装饰模式修改成如上图般模样，却不用再使用include标签。
装饰器     decorator概念
    为了建立可复用的web应用程序,一个通用的方法是建立一个分层系统，如同下面一个普通的web应用：
  • 前端: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外，还有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 content-type="text/html" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />
<parser content-type="text/html;charset=ISO-8859-1" class="com.opensymphony.module.sitemesh.parser.FastPageParser" />
</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" />
</decorators>
  • defaultdir: 包含装饰器页面的目录
  • page : 页面文件名
  • name : 别名
  • role : 角色，用于安全
  • webapp : 可以另外指定此文件存放目录
  • Patterns : 匹配的路径，可以用*,那些被访问的页面需要被装饰。

　
最重要的是写出装饰器本身(也就是那些要复用页面，和结构页面)。
    其实，重要的工作就是制作装饰器页面本身(也就是包含结构和规则的页面)，然后把他们描述到decorators.xml中。

    让我们来先看一看最简单的用法：其实最常用也最简单的用法就是我们的hello例子，面对如此众多的技术，我想只要达到功能点到为止即可，没必要去研究太深(除非您有更深的需求)。

<%@ page contentType="text/html; charset=GBK"%>
<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>
<html>
     <head>
       <title><decorator:title default="装饰器页面..." /></title>
       <decorator:head />
     </head>
     <body>
       sitemesh的例子<hr>
       <decorator:body />
       <hr>chen56@msn.com
     </body>
</html>

我们在装饰器页面只用了2个标签：

<decorator:title default="装饰器页面..." />       ： 把请求的原始页面的title内容插入到<title></title>中间。

<decorator:body /> ： 把请求的原始页面的body内的全部内容插入到相应位置。

然后我们在decorator.xml中加入以下描述即可：

<decorator name="main" page="main.jsp">
<pattern>*</pattern>
</decorator>

这样，请求的所有页面都会被重新处理，并按照main.jsp的格式重新展现在你面前。

　
让我们看看更多的用法。(抄袭sitemesh文档)
以下列着全部标签：
Decorator Tags Page Tags
被用于建立装饰器页面. 被用于从原始内容页面访问装饰器.
<decorator:head />
<decorator:body />
<decorator:title />
<decorator:getProperty />
<decorator:usePage /> 		<page:applyDecorator />
<page:param

<decorator:head />

插入原始页面(被包装页面)的head标签中的内容(不包括head标签本身)。

<decorator:body />

插入原始页面(被包装页面)的body标签中的内容。

<decorator:title [ default="..." ] />

插入原始页面(被包装页面)的title标签中的内容，还可以添加一个缺省值。

例：

/decorator/main.jsp中 （装饰器页面）: <title><decorator:title default="却省title-hello"     /> - 附加标题</title>

/aaa.jsp中 (原始页面)：<title>aaa页面</title>

访问/aaa.jsp的结果：<title>aaa页面 - 附加标题</title>

<decorator:getProperty property="..." [ default="..." ] [ writeEntireProperty="..." ]/>

在标签处插入原始页面(被包装页面)的原有的标签的属性中的内容，还可以添加一个缺省值。

sitemesh文档中的例子很好理解：
The decorator: <body bgcolor="white"<decorator:getProperty property="body.onload" 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对象的页面。 (懒的用)

例：可用<decorator:usePage id="page" /> ：<%=page.getTitle()%>达到<decorator:title/>的访问结果。

<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"> chen_p@neusoft.com </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内容。

另外，page:applyDecorator中包含的page:param标签所声明的属性值还可以在包装页面中用decorator:getProperty标签访问到。

 

可打印的界面装饰
     前面说过有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

<%@ taglib uri="sitemesh-decorator" prefix="decorator" %>
<html>
<head>
<title><decorator:title /></title>
<decorator:head />
</head>
<body>

<h1><decorator:title /></h1>
<p align="right"><i>(printable version)</i></p>

<decorator:body />

</body>
</html>

这样就可以让一个原始页面通过?printable=true开关来切换不同的装饰器页面。

　
中文问题
由于sitemesh内部所使用的缺省字符集为iso-8859-1，直接使用会产生乱码，我们可以通过以下方法纠正之：
  • 方法1：可以在您所用的application server的配置文件中找一找，有没有设置encoding或charset的项目，然后设成gbk或gb2312即可
  • 方法2：这也是我们一直使用的方法。
    1.在每一个jsp页里设置: <%@ page contentType="text/html; charset=gbk"%> 来告诉server你所要求的字符集。
    2.在每个jsp页的head中定义：<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=gbk"> 来告诉浏览器你所用的字符集。
总结：使用sitemesh最通常的途径：

1.配置好环境，

2.在WEB-INFO/decroators.xml中描述你将建立的包装器。

3.开发在decroators.xml中描述的包装器，最好存放在/_decorators目录下

4.ok ，可以看看辛勤的成果了 :)
分享到：
| 基于Spring框架的Shiro配置
评论
发表评论

您还没有登录,请您登录后再发表评论

相关推荐

    java sitemesh 页面框架

    1. **易用性**：Sitemesh的配置简单，可以快速集成到现有的Java Web应用中。 2. **灵活性**：支持多种装饰模式，可以为不同类型的页面使用不同的装饰器。 3. **可扩展性**：可以通过自定义Filter或使用表达式语言...

    sitemesh例子

    在“sitemesh例子”中，我们将探讨如何使用 Sitemesh 来实现这一目标。 **安装与配置 Sitemesh** 1. **下载 Sitemesh**：首先从官方仓库或者 Maven 仓库下载 Sitemesh 的 JAR 包，将其添加到项目的类路径中。 2. *...

    SiteMesh教程及SiteMesh官方文档翻译

    要在项目中使用SiteMesh，首先需要在`WEB-INF/web.xml`文件中添加相应的过滤器配置。下面是一段示例代码： ```xml &lt;web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi=...

    siteMesh使用示例

    如果需要对某些特定页面不应用装饰，或者只对特定部分进行装饰，可以使用 `excludes` 和 `includes` 属性在 `web.xml` 中配置 SiteMesh 过滤器。 9. **优化与性能** SiteMesh 通常对性能的影响很小，但可以通过...

    初试sitemesh实现模块简易整合

    Sitemesh 是一个开源的网页布局框架，用于在Java Web应用程序中实现页面装饰（Decorator）模式。它可以帮助开发者统一网站的头部、底部、侧边栏等通用部分，使得网站设计更加整洁且易于维护。本篇文章将详细介绍如何...

    sitemesh简单demo

    这个“sitemesh简单demo”是一个使用 Maven 构建的项目，旨在提供一个快速入门的示例，帮助初学者理解并掌握 sitemesh 的基本用法。 在 Web 开发中，sitemesh 通过拦截 HTTP 请求，将用户定义的页面模板（通常称为...

    sitemesh 例子

    Sitemesh 是一款开源的网页布局和装饰框架，主要...然后，你需要在你的JSP或HTML页面中使用`&lt;@s.decorator name="decoratorName" /&gt;`标签，指定要使用的装饰器。例如： ```jsp ;charset=UTF-8" language="java" %&gt; ...

    sitemesh-2.2.1.jar sitemesh-2.2.1.jar

    此外，还需要熟悉如何在JSP或Servlet中使用`@decorator`注解或者`&lt;%@ page decorator="..." %&gt;`指令来指定装饰器。 总结起来，Sitemesh-2.2.1.jar是一个强大的Web界面布局工具，它通过分离内容和样式，提高了Web...

    spring mvc sitemesh velocity整合

    集成过程包括配置Hibernate SessionFactory，创建实体类，定义映射文件，以及在控制器中使用SessionFactory进行数据操作。 总的来说，Spring MVC、Sitemesh和Velocity的整合提供了一种高效且灵活的Web开发模式，...

    sitemesh简单教程页面装配器

    然而，前端页面的逻辑很难复用，尤其是在需要在每个页面中使用`include`标签来嵌入头部、脚部等公共元素的情况下。这种方式会导致大量的代码重复，一旦需要更改这些公共元素，就必须逐个页面进行修改，非常不便。 ...

    sitemesh3官方下载包

    开发者可以通过阅读这些文档来了解如何使用Sitemesh3提供的接口和类，以便在自己的代码中集成Sitemesh3的功能。 3. **demo** 目录：这是一个示例应用程序，展示了Sitemesh3如何与实际的Web应用结合使用。通过分析和...

    sitemesh jar包

    同时，与Spring Boot中的Thymeleaf相比，Sitemesh的配置和使用相对简单，但在某些复杂场景下可能不如Thymeleaf灵活。 总的来说，Sitemesh作为一个强大的页面装饰工具，为Java Web开发者提供了简洁、高效的方式来...

    jsp 页面框架sitemesh 全面帮助文档及示例

    **Sitemesh** 是一个流行的Java Web开发框架，主要用于页面布局和装饰。...通过深入学习这些资源，开发者可以全面理解Sitemesh的工作方式，掌握如何在实际项目中有效地使用Sitemesh来提升Web应用的用户体验。

    sitemesh布局知识点汇总

    下面是一个简单的Sitemesh安装和配置示例，以展示如何在项目中集成Sitemesh： ##### 1. 安装步骤 - **添加依赖**：将Sitemesh的jar包（例如`sitemesh-2.1.jar`）放置到项目的lib目录下。 - **配置Web.xml**：在Web...

    springmvc + mybatis + sitemesh3登陆 超简洁例子mysql

    5. **MD5验证**：MD5（Message-Digest Algorithm 5）虽然在安全性上已不再理想，但在这个简单的示例中，它仍可用于演示密码的加密存储。在实际应用中，通常会使用更安全的哈希算法如SHA-256，甚至结合盐值（salt）...

    sitemesh的使用方法demo

    通过这个简单的 demo，你可以学习到如何在实际项目中集成和使用 Sitemesh，以提高网站的整体一致性和美观性。同时，Sitemesh 还支持自定义装饰策略、多装饰器应用、动态装饰等功能，可以根据项目需求进行深入研究和...

    一个Struts2+Spring2.5+SiteMesh的小DEMO

    在这个"Struts2+Spring2.5+SiteMesh的小DEMO"中，开发者可能已经创建了一个简单的Hello World应用，展示了这三个框架如何协同工作。`helloWorld`可能是这个应用的一个入口点，例如，它可能对应一个Struts2的动作类，...

    sitemesh2 集成velocity 装饰页面乱码

    在给定的文件`VelocityView.java`中，可能包含了自定义的Velocity视图实现，以适应sitemesh的装饰需求。这个类可能覆盖了默认的velocity视图处理方式，如设置适当的字符编码，或者实现了特定的装饰逻辑。具体实现...

    SpringMVC-Freemarker_Sitemesh3例子

    `src`目录则是源代码存放的地方，通常包含Java源码（`src/main/java`）、资源文件（`src/main/resources`）和Freemarker模板文件（可能在`src/main/webapp/WEB-INF/views`中）。 为了实现SpringMVC、Freemarker和...

    sitemesh教程

    在这个页面中，你可以使用Sitemesh提供的标签库，如`&lt;decorator:title&gt;`和`&lt;decorator:head&gt;`等，来插入页面的头部信息，而`&lt;decorator:body/&gt;`标签则会被内容页面替换，显示具体的内容。 以下是一个简单的装饰器...

Magicbox
Global site tag (gtag.js) - Google Analytics