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
相关推荐
要使用Sitemesh,开发者需要了解其配置文件(通常为`sitemesh.xml`),以及如何编写装饰器模板。此外,还需要熟悉如何在JSP或Servlet中使用`@decorator`注解或者`<%@ page decorator="..." %>`指令来指定装饰器。 ...
sitemesh.jar包 sitemesh.jar 包sitemesh.jar 包sitemesh.jar包
SiteMesh可以与多种JSP标签库、模板引擎以及前端技术结合使用,如Struts、Velocity、Jakarta、JSR 168 Portlets等。这意味着开发人员可以利用这些技术在SiteMesh装饰的页面中实现更加丰富的功能和设计。 6. 页面...
sitemesh-2.4.1.jar sitemesh-2.4.1.jar sitemesh-2.4.1.jar sitemesh-2.4.1.jar sitemesh-2.4.1.jar sitemesh-2.4.1.jar
201.2.0/middlegenide_1.2.0.zip/download?use_mirror=nchc 下载文件:middlegenide_1.2.0.zip (7)Sitemesh: 本书使用版本:2.2 官方网站:http://www.opensymphony.com/sitemesh/index.html 下载页面:...
com.opensymphony.module.sitemesh.filter.PageFilter <param-name>debug.pagewriter <param-value>true <filter-name>sitemesh <url-pattern>/* ``` 2. **定义修饰器**:在`WEB-INF`目录下创建...
sitemesh-2.3.jar
用于在SSH2工程中使用sitemesh-2.4.jar 包;
sitemesh-2.2.1.jarsitemesh-2.2.1.jarsitemesh-2.2.1.jar
sitemesh-3.0-alpha-2.jar
2. `sitemesh-decorator.tld`: 这个文件定义了装饰器(Decorator)的标签,如`<decorator:include>`和`<decorator:head>`等,它们用于在装饰器模板中指定要插入页面内容的位置。装饰器模板通常是一个独立的JSP文件,...
Struts2是一个非常流行的Java Web开发框架,它提供了一种模型-视图-控制器(MVC)架构,帮助开发者构建可维护、结构清晰的Web应用。Sitemesh则是一个页面布局和装饰框架,用于统一网站的外观和感觉,增强页面的...
2. **匹配装饰模板**:根据请求的URL确定应使用的装饰模板。 3. **提取页面内容**:从被访问的普通页面中抽取内容部分。 4. **装饰并发送**:将抽取的内容嵌入到装饰模板的相应位置,形成完整的装饰后页面,再发送给...
struts2-sitemesh-plugin-2.1.8.1.jar
SiteMesh 是一个网页布局和修饰的框架,利用它可以将网页的内容和页面结构分离,以达到页面结构共享的目的。Sitemesh是由一个基于Web页面布局、装饰以及与现存Web应用整合的框架。它能帮助我们在由大 量页面构成的...
sitemesh 装饰页面技术.
解压缩`sitemesh-2.2.1.rar`后,你将找到包含库文件、文档和其他资源的目录结构,按照官方文档的指引进行配置和部署即可开始使用。 总的来说,Sitemesh 2.2.1是一个强大的工具,可以帮助开发者提高Web应用程序的...
4. **设置页面内容**:对于每个需要装饰的页面,可以使用特殊的注释来指示Sitemesh如何将内容插入到模板中。例如,`<@s.content/>`表示将当前页面的内容插入到模板的指定位置。 5. **运行与测试**:在MyEclipse中...
在每个 JSP 页面中,可以使用 `@decorator` 来指定使用哪个装饰模板,如 `@decorator(name="layout")`。而 `@include` 用于插入静态内容或 JSP 文件。 5. **登录页面示例** 假设有一个 `login.jsp` 页面,我们需要...
<filter-class>org.sitemesh.config.ConfigurableSiteMeshFilter <filter-name>sitemesh <url-pattern>/* ``` 这段配置表示所有的请求都会经过Sitemesh Filter的处理,从而使得所有页面都能够应用指定的...