SiteMesh装饰器使用总结

SiteMesh是一个Java WEB项目的网页布局和修饰框架。

  • 可以将网页的内容和页面结构分离,达到页面结构共享的目的。
  • 页面装饰效果耦合在目标页面中,无需使用include指令显示包含装饰效果,目标页面和装饰页面完全分离
  • 整个web应用可以使用相同的装饰页面,风格统一,整体效果更好。
  • SiteMesh通过Filter拦截请求和响应,给原始页面加入装饰,再把装饰后的结果返回给客户端。
  • 根据页面URL查找合适的装饰模板页
  • 提取被访问页的内容,放置到装饰模板中的适当位置。

用法

1.加入siteMesh Jar包

2.在web.xml中配置siteMesh Filter

WEB-INF/web.xml文件

<web-app ......>
        ......
    <filter>
        <filter-name>sitemeshFilter</filter-name>
        <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
    </filter>
    <filter-mapping>
        <filter-name>sitemeshFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
</web-app>

如果Web.xml中配置了taglib,jsp页面中引入taglib的方式

<web-app ...>
...
  <taglib>
    <taglib-uri>sitemesh-decorator</taglib-uri>
    <taglib-location>/WEB-INF/sitemesh-decorator.tld</taglib-location>
  </taglib>
  <taglib>
    <taglib-uri>sitemesh-page</taglib-uri>
    <taglib-location>/WEB-INF/sitemesh-page.tld</taglib-location>
  </taglib>
...
</web-app>
<%@taglib uri="sitemesh-decorator"?prefix="decorator" %>

3.创建装饰器配置文件

指定装饰模板与URL的对应关系,也可以配置那些URL不需要模板控制。

WEB-INF/decorators.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<!-- Any urls that are excluded will never be decorated by Sitemesh -->
<excludes>
  <pattern>/Login*</pattern>
  <patterm>/index.jsp*<pattern>
</excludes>
<decorators defaultdir="/WEB-INF/views">   <!--defaultdir属性为模板文件的存放路径-->
    <!-- 默认装饰模板配置, 在需要装饰的页面增加<meta name="decorator" content="default"/> -->
    <decorator name="main" page="layouts/main.jsp" >
        <pattern>/api/certs/*</pattern>
        <pattern>/api/provs/*</pattern>
        <pattern>/api/macs/*</pattern>
    </decorator>
  <decorator name="panel" page="layouts/panle.jsp">
  </decorator>
    <!-- 下面可以写多个 -->
</decorators>

decorator标签属性

  • page  装饰模板文件
  • name  装饰模板别名
  • role  角色
  • webapp  单独指导装饰文件存放目录

使用SiteMesh最主要的工作就是创建装饰模板,然后在decorators.xml配置装饰模板应用于哪些页面URL。一般项目可以抽象出主模板,二级页面模板,三级页面模板,弹出窗口模板等,但数量往往不会超过8个。

4.创建装饰模板

WEB-INF/views/layouts/main.jsp

<%@page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<%@taglib prefix="decorator" uri="http://www.opensymphony.com/sitemesh/decorator" %>
<html>
  <head>
    <title> <decorator:title default="default title"/> </title> 
    <decorator:head/>
  </head>
  <body <decorator:getProperty property=“body.onload" writeEntireProperty=“1"/> >
    <jsp:include page="/header.jsp"></jsp:include>
    ......
    <decorator:body/>
    ......
    从meta中获取变量company的名称:
    <decorator:getProperty property=“meta.company”/>
    ......
    <decorator:usePage id=“myPage" />
    <%=myPage.getRequest().getAttribute(“username”)%>
    ......
    <jsp:include page="/footer.jsp"></jsp:include>
  </body>
</html> 

Sitemesh标签

<decorator:head />

填充被装饰页面的head标签内容

<decorator:body />

填充被装饰页面的body标签内容

<decorator:title default="default title"  />

填充被装饰页面的title标签内容,

<decorator:getProperty property="" default=""  writeEntireProperty="{true|false|1|0}"/>

读取被装饰页面中的相关标签的属性值,writeEntrieProperty表示只显示"value",还是显示"prop=value"

<decorator:usePage id="" />

<%=myPage.getRequest().getAttribute(“username”)%>

  将被装饰页面构造为一个对象,可以在装饰页面的JSP中直接引用。

5.被装饰页面

<html lang=“en”>
  <head>
    <title>我的sitemesh</title>
    <meta name="decorator" content="default"/>
    <meta name=“company” content=“smartdot”/>
    <meta name=“Author” content=“zhangsan”/>
    <script>
      function count(){return 10;}
    </script>
  </head>
  <body onload=“count()”>
    <p>这是一个被修饰页面</p>
  </body>
</html>

主动应用装饰器

在装饰模板中和被包装页面中都可以主动应用装饰器。使用的标签为applyDecorator或apply-decorator,可以内嵌param标签提供参数,装饰模板中用getProperty标签可以读取param提供的参数值。

<%@page contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
<%@taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<%@ taglib uri="http://www.opensymphony.com/sitemesh/page" prefix="page"%>
......
<body>
  <page:applyDecorator page="/common/top.jsp" name="panel">
    <page:param name="paramName">
      ......
    </page:param>
  </page:applyDecorator>
......
</body>

panel装饰模板中配置:

<div class="....">
  <decorator:body/>    top.jsp的body
  <decorator:getProperty property="paramName"/>
</div>

applyDecorator属性

  • name  要使用的装饰模板名,decorators.xml中配置的
  • page  要装饰的页面

原理

http://my.oschina.net/georgele/blog/49137?p=1

http://my.oschina.net/s2jh/blog/361044

参考文档

http://m.blog.csdn.net/blog/kpchen_0508/41281749

http://blog.csdn.net/jzh440/article/details/7770013

时间: 2024-10-18 19:13:27

SiteMesh装饰器使用总结的相关文章

关于Springmvc中include与Sitemesh装饰器的基本使用

关于Springmvc中include与Sitemesh装饰器的使用 !!!转载请注明出处=>http://www.cnblogs.com/funnyzpc/p/7283443.html 静态包含:example:<%@include file="xxx.jsp"%> 文件的包含是发生在 jsp向servlet转换时期 ,相当于将jsp编译成html静态文件,由于对包含的文件不再编译(直接拷贝到父页面),则只产生一个class文件. 动态包含:example<j

使用 sitemesh/decorator装饰器装饰jsp页面(原理及详细配置)

摘要:首先这个Decorator解释一下这个单词:“装饰器”,我觉得其实可以这样理解,他就像我们用到的Frame,他把每个页面共有的东西提炼了出来,也可能我们也会用各种各样的include标签,将我们的常用页面给包括进来:比如说页面的top,bottom这些每个页面几乎都有,而且都一样,如果我们在每个页面都include,可以发现我们的程序有很多冗余,重复.相比之下装饰器给我们提供了一个较好的选择,他在你要显示的页面根本看不出任何include信息,可以说完全解耦. 一.SiteMesh介绍 S

【sitemesh】Jsp的装饰器组件sitemesh

姑且不论这东西到底有没有用,毕竟Jsp页面编程完全可以利用JSP的include命令,像传统网页编程一样,先写好几个页眉页脚header.html.footer.html.banner.html之类,再于每个页面利用<jsp:include page="xxx.html" />引入这几个页面.这样一来好维护,二来代码清晰不麻烦,三来去到asp.net.vbscript.php等服务器编程页面我们一样这样搞.要不是html没有include命令,甚至来不至于用到服务器后端语言

freemarker 集成 sitemesh 装饰html页面 shiro 标签

guest标签:验证当前用户是否为"访客",即未认证(包含未记住)的用户: shiro标签:<shiro:guest></shiro:guest>  : freemark中: <@shiro.guest>  </@shiro.guest> user标签:认证通过或已记住的用户 shiro标签:<shiro:user> </shiro:user>  :freemark中: <@shiro.user> &l

Day4 - 迭代器&amp;生成器、装饰器、Json &amp; pickle 数据序列化、软件目录结构规范

---恢复内容开始--- 本节内容 迭代器&生成器 装饰器 Json & pickle 数据序列化 软件目录结构规范 作业:ATM项目开发 1.列表生成式,迭代器&生成器 列表生成式 需求:列表a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],要求把列表里的每个值加1 1 a = [0, 1, 2, 3, 4, 5, 6, 7, 8, 9] 2 b = [] 3 for i in a: 4 b.append(i+1) 5 a = b 6 print(a) 普通青

python3 装饰器

看廖雪峰官网的python3装饰器有感 装饰器即将一个函数作为变量在新的函数中调用此函数. 作业: 能否写出一个@log的decorator,使它既支持: @logdef f():     pass 又支持: @log('execute')def f():     pass      例1: import functools import time def log(*args,**kwargs):     # *args 是个元组     if args and isinstance(args,

day14 带函数的装饰器、多个装饰器装饰一个函数

一.带参数的装饰器:------开关 __author__ = 'Administrator' F=True def outer(F): def wap(fun):#gg def inner(*args,**kwargs): if F: print("inner before") ret=fun(*args,**kwargs)#gg() print("inner after") else: ret=fun(*args,**kwargs) return ret ret

Python 装饰器

一.定义 器即函数 装饰即修饰,意指为其他函数添加新功能 装饰器本身可以是任意可调用对象,被装饰的对象本身也可以是任意可调用对象 实现装饰器: 装饰器=高阶函数+函数嵌套+闭包 二.原则: 1 .开放封闭原则:对扩展是开放的,对修改是封闭 2.1 装饰器的遵循的原则:1 不修改被装饰对象的源代码 2 不修改被调用对象的调用方式 三.目的 装饰器的目的是:在遵循1和2原则的前提,为其他新功能函数添加 四.定义位置 @装饰器名,必须写在被装饰对象的正上方,并且是单独一行 import time de

装饰器、生成器、迭代器

装饰器的前奏 装饰器:本质是函数 功能:就是装饰成其他函数  就是为其他函数添加附加功能的 高阶函数+嵌套函数=装饰器 原则:1.不能修改被装饰的函数的源代码 2.不能修改被装饰的函数的调用方式 总结一句话:装饰器对被装饰的函数是完全透明的 实现装饰器的只是储备: 1.函数名即"变量"   将函数体赋值给变量   和内存回收机制一样 2.高阶函数 2.1.把函数名作为实参传递给形参(可返回被修饰函数的地址)(不修改源代码的情况可添加新的功能) 2.2返回值中包含函数地址(不修改函数的调