`

SiteMesh教程

    博客分类：
  • java
JSPWebXML浏览器HTML 
阅读更多
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
    　
    插入原始页面(被包装页面)的head标签中的内容(不包括head标签本身)。
    <decorator:body />
    插入原始页面(被包装页面)的body标签中的内容。
    插入原始页面(被包装页面)的title标签中的内容，还可以添加一个缺省值。
    例：
    /decorator/main.jsp中 （装饰器页面）:
    /aaa.jsp中 (原始页面)：<title> aaa页面 </title>
    访问/aaa.jsp的结果：<title> aaa页面 - 附加标题 </title>
    在标签处插入原始页面(被包装页面)的原有的 标签的属性 中的内容，还可以添加一个缺省值。
    sitemesh文档中的例子很好理解：
    The decorator:     <body bgcolor="white"<decorator:getProperty property="body. 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>
    应用包装器到指定的页面上，一般用于被包装页面中主动应用包装器。这个标签有点不好理解，我们来看一个例子：
    包装器页面 /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.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 ，可以看看辛勤的成果了 :)
    分享到：
    | struts 2 Spring Hibernate 的jar包官网下 ...
    评论
    发表评论

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

    相关推荐

      SiteMesh教程及SiteMesh官方文档翻译

      ### SiteMesh教程及SiteMesh官方文档翻译 #### 使用SiteMesh简化网页布局 SiteMesh是一款用于Web应用程序中的页面布局和装饰的框架。它采用Decorator模式，通过过滤器（filter）拦截请求和响应，将不同的页面组件...

      sitemesh教程

      ### SiteMesh教程：官方文档翻译（含Freemarker但不包括velocity部分） #### 一、简介 SiteMesh是一个强大的Web页面布局工具，它允许开发者在Web应用中使用模板化的设计来构建网页。通过使用SiteMesh，可以很容易...

      SiteMesh教程.doc

      ### SiteMesh教程知识点详解 #### 一、SiteMesh概述与应用场景 **1.1 SiteMesh简介** SiteMesh是一个基于Java、J2EE和XML的开源框架，主要用于网站内容的装饰和布局管理。当一个企业级Web站点需要整合多种技术...

      SiteMesh教程.pdf

      SiteMesh是一种用于Java Web应用的装饰器设计模式框架，主要通过拦截Web页面请求，动态地将装饰页面如头部（header）、底部（footer）、样式表（stylesheet）和脚本文件（scripts）等页面元素与实际页面组合在一起，...

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

      - **SiteMesh教程.doc**：这是一份Word文档，可能详细介绍了如何使用Sitemesh，包括基本概念、配置和实例。 - **SiteMesh学习入门.jpg**：可能是介绍Sitemesh基本概念的流程图或者关键步骤的截图。 - **sitemesh...

      sitemesh教程-页面装饰技术原理及应用

      Sitemesh是一种页面装饰技术，其核心思想是使用过滤器（filter）拦截网页访问请求，并根据访问的URL选择合适的装饰模板来修饰目标页面。Sitemesh可以将装饰模板（外观页面）和内容页面分离，使得网页装饰逻辑与具体...

      SiteMesh实战

      通过阅读《SiteMesh教程.docx》文档，你将更深入地了解如何配置和使用SiteMesh，包括如何调试、处理动态内容、以及与Spring MVC等框架的集成。文档中可能还会涵盖高级特性，如装饰器优先级、多装饰器支持、自定义...

      sitemesh简单教程页面装配器

      ### Sitemesh简单教程页面装配器 #### 一、Sitemesh概述 Sitemesh是一款用于Web应用中的页面布局管理工具，它通过采用装饰器（Decorator）设计模式，实现了对Web页面布局的灵活管理和重用。传统的Web开发中，...

      sitemesh框架简单例子

      在“sitemesh框架简单例子”这个教程中，我们将深入理解Sitemesh的基本概念和用法。 首先，我们需要了解Sitemesh的工作原理。Sitemesh通过拦截HTTP请求，对返回的HTML内容进行装饰。它使用一种叫做装饰器...

      sitemesh

      在给定的博文链接中，虽然没有直接的内容提供，但通常会涉及sitemesh的使用方法、配置教程以及一些实际应用案例。 **标签：“源码”、“工具”** - **源码**：sitemesh作为一个开源项目，其源代码可供开发者研究和...

      sitemesh-3.0.0的库和源码

      - **文档**：可能包含的API文档、示例和教程，方便开发者快速上手。 **5. 应用场景** Sitemesh 主要适用于那些需要保持一致界面风格的大型Web应用，例如企业级门户、电商网站、内容管理系统等。通过Sitemesh，...

      sitemesh使用教程

      SiteMesh 是一个开源的 J2EE 页面布局和装饰框架，主要用来解决Web应用程序中的内容与表现层分离的问题。它的设计灵感来源于设计模式中的装饰者模式，可以类比为Swing界面中的外观风格改变器。SiteMesh的核心价值...

      sitemesh3包

      "帮助文档" 部分则为开发者提供了详细的教程、API 参考和解决方案。这包括了如何集成 Sitemesh3 到现有项目、如何定义和应用装饰器、如何处理动态内容等主题。好的文档可以帮助开发者节省大量的学习和调试时间，提高...

      sitemesh-2.4.zip

      这个目录可能包含了 Sitemesh 的用户文档，包括 HTML 或 PDF 格式的教程、API 文档等。这些文档对于理解如何使用和配置 Sitemesh 非常有帮助。 7. **src** 源代码目录，包含 Sitemesh 框架的 Java 源文件。开发者...

      spring jsp freemaker sitemesh

      通过文件名"springJspFreemaker"我们可以推测，这个压缩包可能包含了使用Spring、JSP和FreeMarker开发的示例项目或教程。解压后，我们可能会找到相关的源代码、配置文件、以及说明文档，帮助学习者了解这三个技术...

      sitemesh-examples-hellowebapp

      本质上，它是Gradle可以立即运行的教程。 如果您的系统上未 ，则必须先然后再继续。 要在Jetty中运行SiteMesh演示，请执行以下操作： gradle jettyRun 所有必需的.jar文件将自动加载。 然后，您应该看到类似于...

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