文档章节

SiteMesh 2.X 的使用(网页结构模板)

乐在克里特
 乐在克里特
发布于 2017/02/23 14:53
字数 2391
阅读 2
收藏 0

SiteMesh是基于Servlet的filter的,即过滤流。它是通过截取reponse,并进行装饰后再交付给客户。

其中涉及到两个名词: 装饰页面(decorator page)和 “被装饰页面(Content page)" , 即 SiteMesh通过对Content Page的装饰,最终得到页面布局和外观一直的页面,

并返回给客户

运行环境需要:servlet2.3 , JDK1.4 以上。

正常模式下的web访问流程

加入SiteMesh装饰的web访问流程 

 

一:搭建SiteMesh环境及简单使用

1.1:准备资源

siteMesh2.4.jar, sitemesh-page.tld , sitemesh-decorator.tld 这个三个必要文件

将jar包复制进/WEB-INF/lib目录下, 两个tld文件导入/WEB-INF下即可

在web.xml中加入siteMesh的filter和taglib

<filter>  
   <filter-name>sitemesh</filter-name>  
   <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>  
 </filter>  
  
 <filter-mapping>  
   <filter-name>sitemesh</filter-name>  
   <url-pattern>/*</url-pattern>  
 </filter-mapping>   
  
<!-- not required for containers that fully support JSP 1.2 -->  
 <taglib>  
   <taglib-uri>sitemesh-page</taglib-uri>  
   <taglib-location>/WEB-INF/lib/sitemesh-page.tld</taglib-location>  
 </taglib>  
 <taglib>  
   <taglib-uri>sitemesh-decorator</taglib-uri>  
   <taglib-location>/WEB-INF/lib/sitemesh-decorator.tld</taglib-location>  
 </taglib>  

1.2 建立decorators.xml

在/WEB-INF下创建decorators.xml文件,siteMesh通过该文件来获知"装饰页面"和"被装饰页面"的映射 

 decorators.xml

<?xml version="1.0" encoding="UTF-8"?>  
  
<!-- 默认目录 -->  
<decorators defaultdir="/decorators">  
  
    <!-- 缺省装饰页 -->  
    <decorator name="main" page="main.jsp">  
        <pattern>/*</pattern>  
    </decorator>  
       
    <!-- 自定义装饰页,我们下面实例就是这部分起作用 -->  
    <decorator name="mai" page="mai.jsp">  
        <pattern>/mai.html</pattern>  
    </decorator>  
  
    <!-- 只装饰一个页面也可用这种方式定义 -->  
    <decorator name="panel" page="panel.jsp"/>  
  
    <!-- 装饰velocity模板 -->  
    <decorator name="velocity" page="velocity.vm">  
        <pattern>/velocity.html</pattern>  
    </decorator>  
      
    <!-- 装饰freeMarker模板 -->  
    <decorator name="freemarker" page="freemarker.ftl">  
        <pattern>/freemarker.html</pattern>  
    </decorator>  
  
    <decorator name="test" page="test.jsp">  
        <pattern>/agent.jsp</pattern>  
    </decorator>  
</decorators>  

下边是对上边中所缺少的一些补充

<?xml version="1.0" encoding="utf-8"?>    
<decorators defaultdir="/decorators">    
    <!-- 此处用来定义不需要过滤的页面 -->    
    <excludes>    
    </excludes>    
    
 <!-- 用来定义装饰器要过滤的页面 -->    
    <decorator name="main" page="main.jsp">    
        <pattern>/*</pattern>    
    </decorator>    
</decorators>

     1.3 装饰页的创建

在web目录(或者webContent)下创建文件夹decorators,在文件夹中建立mai.jsp文件

<%@ page language="java" contentType="text/html; charset=UTF-8"  
    pageEncoding="UTF-8"%>  
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
<html>  
  
/*这里导入了SiteMesh的标签库 */  
  
<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
<%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page" %>  
<head>  
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
  
OK,there is a decorator begin!<hr />  
    /*这里的意思是,被装饰页的title内容将会在这里插入 */  
    <decorator:title></decorator:title>  
    
</head>  
<body>  
    /*被修饰页的body内容将在这里插入  
    <decorator:body></decorator:body>  
  
<hr />Yse,there is a decorator end !  
  
</body>  
</html>  

1.4 被修饰页的创建

在web目录(或webContent)下创建mai.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">  
<html>  
<head>  
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
<title>Insert title here</title>  
</head>  
<body>  
this is the Content Page !!!  
</body>  
</html>  

1.5 使用tomcat进行示例运行,访问http://localhost:8080/{your project name}/mai.html , 运行结果如下:

 
 

1.6 sitemesh.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.HTMLPageParser" />  
    </page-parsers>  
  
    <decorator-mappers>  
  
        <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">  
        </mapper>  
  
        <mapper class="com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper">  
            <param name="match.MSIE" value="ie" />  
            <param name="match.Mozilla [" value="ns" />  
            <param name="match.Opera" value="opera" />  
            <param name="match.Lynx" value="lynx" />  
        </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>  
  
        <mapper class="com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper">  
            <param name="decorator" value="robot" />  
        </mapper>  
  
        <mapper class="com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper">  
            <param name="decorator.parameter" value="decorator" />  
            <param name="parameter.name" value="confirm" />  
            <param name="parameter.value" value="true" />  
        </mapper>  
  
        <mapper class="com.opensymphony.module.sitemesh.mapper.FileDecoratorMapper">  
        </mapper>  
  
        <mapper class="com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper">  
            <param name="config" value="${decorators-file}" />  
        </mapper>  
  
    </decorator-mappers>  
  
</sitemesh>  

 使用总结:整个过程配置是相对简单的,先导入所需资源,然后再配置filter,之后是derator page和content page的创建以及他们之间的映射关系,配置命令是相对简单的,简单的需求上面这些已经足矣。


二:使用示例

2.1 例子1

在{myapp}/WEB-INF/decorators.xml文件中添加以下decorator

<decorator name="mydecorator1" page="mydecorator1.jsp">  
        <pattern>/test1.jsp</pattern>  
    </decorator>

在{myapp}/decorators目录下添加mydecorator1.jsp文件,内容如下:

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
<html>  
    <head>  
        <title>My Site - <decorator:title default="Welcome!" /></title>  
        <decorator:head />  
    </head>  
    <body>  
        <decorator:body />  
        <p>This message is in /decorators/mydecorator1.jsp</p>         
    </body>  
</html>  

在{myapp}目录下添加test1.jsp文件,内容如下:

<%@page contentType="text/html"%>  
<%@page pageEncoding="UTF-8"%>  
<html>  
    <head>  
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
        <title>This is test1</title>  
    </head>  
    <body>  
    <b>This is test1</b>  
    </body>  
</html>  
  • 打开浏览器,访问http://localhost:8080/myapp/test1.jsp,将会出现一下内容:

This is test1

This message is in /decorators/mydecorator1.jsp

 

2.2 例子2(decorator:getProperty

有时候,我们期望修改页面中某个有固定标记的片段,例如我们的jsp中有一个标记<mytag>...</mytag>,此时可以用如下方法实现:

在{myapp}/WEB-INF/decorators.xml文件中添加以下decorator

<decorator name="mydecorator2" page="mydecorator2.jsp">  
   <pattern>/test2.jsp</pattern>  
</decorator>  


在{myapp}/decorators目录下添加mydecorator2.jsp文件,内容如下:

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
  
<html>  
    <head>  
        <title>My Site - <decorator:title default="Welcome!" /></title>  
        <decorator:head />  
    </head>  
  
    <body>  
        <decorator:body />  
        <decorator:getProperty property="page.content1"/>  
        <decorator:getProperty property="page.content2"/>  
          
        <!-- do nothing -->  
        <decorator:getProperty property="page.content3"/>  
        <p>This message is in /decorators/mydecorator2.jsp</p>  
    </body>  
</html>  


在{myapp}目录下添加test2.jsp文件,内容如下:

<%@page contentType="text/html"%>  
<%@page pageEncoding="UTF-8"%>  
<html>  
    <head>  
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
        <title>This is test2</title>  
    </head>  
     
    <body>  
    <b>This is test2</b>  
    <b>Use <decorator:getProperty> tag</b>  
     
    <content tag="content1"><p>This is content1</p></content>  
    <content tag="content2"><p>This is content2</p></content>  
    <content tag="content4"><p>This is content4, it shouldn't be display</p></content>  
    </body>  
</html>  


打开浏览器,访问http://localhost:8080/myapp/test2.jsp,将会出现一下内容:

 

This is test2

Use <decorator:getProperty> tag

This is content1

This is content2

This message is in /decorators/mydecorator2.jsp

 

2.3 例子3 (page:applyDecorator tag

在{myapp}/WEB-INF/decorators.xml文件中添加以下decorator:

 

<decorator name="mydecorator3" page="mydecorator3.jsp">  
    <pattern>/test3.jsp</pattern>  
</decorator>  
<decorator name="mydecorator31" page="mydecorator31.jsp">  
</decorator> 

在{myapp}/decorators目录下添加mydecorator3.jsp文件,内容如下:

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
<%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page" %>  
<html>  
    <head>  
        <title>My Site - <decorator:title default="Welcome!" /></title>  
        <decorator:head />  
    </head>  
  
    <body>  
        <decorator:body />  
        <page:applyDecorator name="mydecorator31">  
            <content tag="content1"><p>This is content1</p></content>  
            <content tag="content2"><p>This is content2</p></content>  
        </page:applyDecorator>  
    </body>  
</html>  


在{myapp}/decorators目录下添加mydecorator31.jsp文件,内容如下: 

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
<%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page" %>  
  
<p><i>begin</i></>  
<decorator:getProperty property="page.content1"/>  
<decorator:getProperty property="page.content2"/>  
<p><i>end</i></>  
在{myapp}目录下添加test3.jsp文件,内容如下:  
<%@page contentType="text/html"%>  
<%@page pageEncoding="UTF-8"%>  
<html>  
    <head>  
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
        <title>This is test3</title>  
    </head>  
     
    <body>  
    <b>This is test3</b>  
    <b>Use <page:applyDecorator> tag</b>  
    </body>  
</html>  


注意:相对于例子2,这里已经没有了<content tag="XXX"/>标签。

打开浏览器,访问http://localhost:8080/myapp/test3.jsp,将会出现一下内容:

 

This is test3

Use <page:applyDecorator> tag

begin

This is content1

This is content2

end

这里,我在mydecorator3.jsp中应用了mydecorator31.jsp的的decorator,并且将原来在test2.jsp中的 <content />标签复制到mydecorator3.jsp中,此时对于<content tag="xxx"/>的标签将会由mydecorator31.jsp了装饰。

 

2.4 例子4(page:parm tag)

在{myapp}/WEB-INF/decorators.xml文件中添加以下decorator:

<decorator name="mydecorator4" page="mydecorator4.jsp">  
        <pattern>/test4.jsp</pattern>  
    </decorator>  
      
    <decorator name="mydecorator41" page="mydecorator41.jsp">  
    </decorator>  


在{myapp}/decorators目录下添加mydecorator4.jsp文件,内容如下:

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
<%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page" %>  
  
<html>  
    <head>  
        <title>My Site - <decorator:title default="Welcome!" /></title>  
        <decorator:head />  
    </head>  
    <body>  
        <decorator:body />  
        <page:applyDecorator name="mydecorator41" >  
            <content tag="content1"><p>This is content1</p></content>  
            <content tag="content2"><p>This is content2</p></content>  
            <page:param name="page.content1"><p>This content1 has been replaced</p></page:param>  
        </page:applyDecorator>  
    </body>  
</html>  


在{myapp}/decorators目录下添加mydecorator41.jsp文件,内容如下: 

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator" %>  
<%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page" %>  
  
<p><i>begin</i></>  
<decorator:getProperty property="page.content1"/>  
<decorator:getProperty property="page.content2"/>  
<p><i>end</i></>  


在{myapp}目录下添加test4.jsp文件,内容如下:

<%@page contentType="text/html"%>  
<%@page pageEncoding="UTF-8"%>  
<html>  
    <head>  
        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">  
        <title>This is test4</title>  
    </head>  
     
    <body>  
    <b>This is test4</b>  
    <b>Use <page:param> tag</b>  
    </body>  
</html>   


打开浏览器,访问http://localhost:8080/myapp/test4.jsp,将会出现一下内容:

 

This is test4

Use <page:param> tag

begin

This content1 has been replaced

This is content2

end

这里,我在mydecorator4.jsp中应用了mydecorator41.jsp的的decorator,并且添加了<page:param name="page.content1">标签,那么此时页面上将会用<page:param>标签中的内容替换原来在<decorator:getProperty property="page.content1"/>中的内容,因此页面将不在This is content1”而显示This content1 has been replaced

 

SiteMesh的一个重要特性是使用原始HTML的meta标签(例如<meta name="foo" content="bar">)从基础页面传递信息到装饰器。作为一个例子,下面我们使用一个meta标签来定义HTML页面的作者。

<html>   
     <meta name="author" content="test@example.com">   
     <head>   
         <title> Simple Document </title>   
     </head>   
     <body>   
        Hello World!< br/>   
        <%=1 + 1%>   
     </body>   
</html>   


我们定义一个“smart”装饰器来研究meta标签,如果出现这个标签,则可以得到一个相应的HTML:

<%@taglib uri = "sitemesh-decorator"  prefix = "decorator"%>   
<decorator:usePage id = " myPage "  />   
<html>  
     <head>   
         <title>   
            My Site - <decorator:title default="Welcome!"/>   
         </title>   
         <decorator:head/>   
     </head>   
     <body>   
         <h1><decorator:title default="Welcome!"/></h1>   
         <h3>   
             <a href="mailto: <decorator:getProperty property= "meta.author" default="staff@example.com"/>">   
                 <decorator:getProperty property="meta.author" default="staff@example.com"/>   
             </a>   
         </h3>   
         <hr/>   
         <decorator:body/>   
         <p>   
             <small>(<a href="/?printable=true">printable version</a> )</small>   
         </p>   
     </body>   
</html>    


可以看到我们使用了 getProperty标签的 一个默认属性——如果没有指定author,我们就设定其为staff。如果你决定使用这个模型储存页面的meta数据,你或许需要和你的开发伙伴一起来 确定将使用什么标签以及如何使用他们。简单的,你或许想要使用meta标签来描述诸如页面作者及时间戳之类的东西。更复杂一些,你或许会想像XML文件一 样标准化的管理你的站点导航,同时使用meta标签来通过页面节点转到装饰器。

 

转载:http://blog.csdn.net/drift_away/article/details/8088758

参考资料:http://my.oschina.net/thinkinginc/blog/76180

参考资料:http://www.cnblogs.com/mailingfeng/archive/2011/12/21/2296041.html

© 著作权归作者所有

共有 人打赏支持
乐在克里特
粉丝 16
博文 268
码字总数 394729
作品 0
杭州
程序员
私信 提问
sitemesh传递值的问题

我的系统结构是 velocity + sitemesh + spring mvc + mybatis 现在使用了sitemesh模板后,出了一些问题,sitemesh模板中(不是页面是模板)无法获取 后台传输过来的数据 model.addAttribute...

學楽
2016/09/25
189
0
页面修饰框架SiteMesh的简单使用

SiteMesh 简介; SiteMesh 是一个网页布局和修饰的框架,利用它可以将网页的内容和页面结构分离,以达到页面结构共享的目的。 Sitemesh是由一个基于Web页面布局、装饰以及与现存Web应用整合的...

长平狐
2012/09/03
348
0
关于前端使用SiteMesh的一些介绍

Overview 在网站开发的过程中,通常一个网站会有一个整体的风格,页面都有很多共同的菜单,横栏的底部信息。以前我们会采用标签在每个页面中来不断的包含各种, , and ,现在,在的帮助下,我...

facula
2018/06/15
0
0
使用SiteMesh简化网页布局

在公司项目使用了 Appfuse ,其带有 SiteMesh 对于网页布局简化让我感觉很好用,本文旨在对对 Sitemesh 的基本原理和在项目中使用 Sitemesh 的实现流程、使用技巧的介绍。 1. 基本原理 Site...

红薯
2008/12/01
3.9K
2
教程:一分钟完成SiteMesh Template模板组合

首先要感谢发明Markdown的家伙,这东西真是好用吖! SiteMesh概述 嗯,请自行Google之。 教程:一分钟完成Template模板组合 1.内容页面 简单的示例内容页面源代码如下: 应该是内容页面 Week...

gsyn77
2013/02/26
0
0

没有更多内容

加载失败,请刷新页面

加载更多

SpringMVC工作原理

SpringMVC的工作原理图: SpringMVC流程 1、 用户发送请求至前端控制器DispatcherServlet。 2、 DispatcherServlet收到请求调用HandlerMapping处理器映射器。 3、 处理器映射器找到具体的处理...

呵呵哒灬
28分钟前
1
0
数据库技术-Mysql主从复制与数据备份

数据库技术-Mysql 主从复制的原理: MySQL中数据复制的基础是二进制日志文件(binary log file)。一台MySQL数据库一旦启用二进制日志后,其作为master,它的数据库中所有操作都会以“事件”...

须臾之余
昨天
12
0
Git远程仓库——GitHub的使用(一)

Git远程仓库——GitHub的使用(一) 一 、 Git远程仓库 由于你的本地仓库和GitHub仓库之间的传输是通过SSH加密的,所以需要一下设置: 步骤一、 创建SSH key 在用户主目录下,看看有没有.ss...

lwenhao
昨天
4
0
SpringBoot 整合

springBoot 整合模板引擎 SpringBoot 整合Mybatis SpringBoot 整合redis SpringBoot 整合定时任务 SpringBoot 整合拦截器...

细节探索者
昨天
1
0
第二个JAVA应用

第二个JAVA应用 方法一:配置文件: # cd /usr/local/tomcat/conf/# vim server.xml</Host> <Host name="www.wangzb.cc" appBase="/data/wwwroot/www.wangzb.cc" //引用所......

wzb88
昨天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部