Sitemesh小记

一、前言

　　因参与公司框架改造，接触到了Sitemesh这个用于网页布局和修饰的框架，因之前没有接触过（汗颜），但是发现其小巧好用，便以此文记之~

二、正文

　　Sitemesh有什么作用呢？我相信很多人在使用jsp的时候，经常会将head部分单独放一个jsp，然后在需要使用的地方，用<%@ include file="/WEB-INF/layouts/header.jsp"%>加载进来，如果一两个文件还好，假如文件太多，难道要一个个配置进去？能不能有一种方法，减少这种体力劳动呢？这个时候Sitemesh派上用场了，通过配置，它可以自动为请求的页面添加上类似刚刚header.jsp中的内容，然后拼装完成之后，返回给用户的浏览器，惊不惊喜，意不意外？下面我就来介绍如何使用~

　　1. 在开始介绍Sitemesh前，先po一张官网的流程图

　　2. 本文基于的环境

　jdk1.8

  sitemash-2.4.2.jar

  servlet-api-3.0-alpha-1.jar

　　3. Maven配置文件pom.xml如下

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">

  <modelVersion>4.0.0</modelVersion>

  <groupId>com.sitemesh.test</groupId>

  <artifactId>Sitemesh</artifactId>

  <packaging>war</packaging>

  <version>1.0-SNAPSHOT</version>

  <name>Sitemesh Maven Webapp</name>

  <url>http://maven.apache.org</url>

  <dependencies>

    <dependency>

      <groupId>junit</groupId>

      <artifactId>junit</artifactId>

      <version>3.8.1</version>

      <scope>test</scope>

    </dependency>

    <dependency>

        <groupId>javax.servlet</groupId>

        <artifactId>servlet-api</artifactId>

        <version>3.0-alpha-1</version>

        <scope>provided</scope>

    </dependency>

    <dependency>

        <groupId>opensymphony</groupId>

        <artifactId>sitemesh</artifactId>

        <version>2.4.2</version>

    </dependency>

  </dependencies>

  <build>

    <finalName>Sitemesh</finalName>

    <plugins>

        <plugin>

            <groupId>org.apache.tomcat.maven</groupId>

            <artifactId>tomcat7-maven-plugin</artifactId>

            <version>2.2</version>

            <configuration>

              <port>8080</port>

              <path>/</path>

              <uriEncoding>UTF-8</uriEncoding>

            </configuration>

          </plugin>

    </plugins>

  </build>

</project>

　　4. 工程目录结构

　　7. 接下来，就说下使用sitemesh的步骤

　　1）首先，下载sitemesh对应的jar

　　笔者使用maven下载，如果看官不是使用maven，自己到Sitemesh官网下载对应jar，传送门：http://wiki.sitemesh.org/wiki/display/sitemesh/Download

　　2）在web.xml中配置Filter

  ............................

  <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>

  ............................

　　3）在WEB-INFO目录下建立一个layouts文件夹（这个文件夹随便命名，理论上，位置你可以放在webapp目录下任何地方，这个后续decorator.xml需要用到），并且在该文件夹下面建立三个文件：default.jsp、header.jsp、footer.jsp，三个文件的内容如下：

　　default.jsp

<%@ page contentType="text/html;charset=UTF-8"%>

<%@ taglib prefix="sitemesh" uri="http://www.opensymphony.com/sitemesh/decorator" %>  

<!DOCTYPE html>

<html>

    <head>

        <title>QuickStart示例:<sitemesh:title/></title>

        <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />

        <meta http-equiv="Cache-Control" content="no-store" />

        <meta http-equiv="Pragma" content="no-cache" />

        <meta http-equiv="Expires" content="0" />

        <sitemesh:head/>

    </head>

    <body>

        <div class="container">

            <%@ include file="/WEB-INF/layouts/header.jsp"%>

            <div id="content">

                <sitemesh:body/>

            </div>

            <%@ include file="/WEB-INF/layouts/footer.jsp"%>

        </div>

    </body>

</html>

　　这个文件中sitemesh标签说明如下：

<sitemesh:title/>这个标签会找到被装饰页面的title(<title></title>标签内)内容填入

<sitemesh:head/>找到被装饰页面的head(<head></head>标签内)内容填入

<sitemesh:body/>找到被装饰页面的body(<body></body>标签内)内容填入．

　　header.jsp

<%@page contentType="text/html;charset=utf-8" %>

This is the header!

　　footer.jsp

<%@page contentType="text/html;charset=utf-8" %>

This is the footer!

　　4）在WEB-INFO目录中建立文件decorators.xml

<?xml version="1.0" encoding="utf-8"?>

<decorators defaultdir="/WEB-INF/layouts/">

    <excludes>

        <pattern>/static/*</pattern><!--这边指定不需要装饰的页面，支持通配符-->

    </excludes>

    <!-- 用来定义装饰器要过滤的页面 -->

    <decorator name="default" page="default.jsp"><!--指明用于装饰的框架页面-->

        <pattern>/*</pattern><!--这边指定需要被装饰的页面，支持通配符-->

    </decorator>

</decorators>

　　5）访问工程index.jsp

　　首先，先看下index.jsp页面内容：

<%@page contentType="text/html;charset=utf-8" %>

<html>

    <head>

        <title>Sitemesh测试</title>

    </head>

    <body>

        <h2>Body 内容</h2>

    </body>

</html>

　　访问后页面展示的效果：

　　查看网页源码：

<!DOCTYPE html>

<html>

    <head>

        <title>QuickStart示例:Sitemesh测试</title>

        <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />

        <meta http-equiv="Cache-Control" content="no-store" />

        <meta http-equiv="Pragma" content="no-cache" />

        <meta http-equiv="Expires" content="0" />

    </head>

    <body>

        <div class="container">

            This is the header!

            <div id="content">

                <h2>Body 内容</h2>

            </div>

            This is the footer!

        </div>

    </body>

</html>

　　8、补充说明

　　假如在decorators.xml文件中，配置了多个decorator节点，如下：

<?xml version="1.0" encoding="utf-8"?>

<decorators defaultdir="/WEB-INF/layouts/">

    <!-- 此处用来定义不需要过滤的页面 -->

    <excludes>

        <pattern>/static/*</pattern>

    </excludes>

    <!-- 用来定义装饰器要过滤的页面 -->

    <decorator name="default" page="default.jsp">

        <pattern>/*</pattern>

    </decorator>

    <decorator name="default2" page="default2.jsp">

        <pattern>/*</pattern>

    </decorator>

</decorators>

　　过滤器的配置不变，现在我又有个页面叫index2.jsp，我需要的是被名为“default2”的decorator装饰时，如何指定呢？那么只需在index2.jsp中，进行如下配置：

　　其中name的值固定为“decorator”，content的内容与decorators.xml文件中decorator节点的name属性对应

　　总结：当浏览器里面请求页面数据时，过滤器SiteMeshFilter拦截请求，然后根据decorator.xml中配置内容，确定是否为excludes设置为不需要装饰的页面，如果不是，那么就使用decorator节点配置的装饰框架default.jsp，并且将其中<sitemesh:title />、<sitemesh:head />、<sitemesh:body />分别用请求页面的<title>、<head>、<body>部分的内容替换，最终输出到用户的浏览器

三、参考链接

https://www.cnblogs.com/china-li/archive/2013/05/15/3080154.html

四、联系本人

　　为方便没有博客园账号的读者交流，特意建立一个企鹅群（纯公益，非利益相关），读者如果有对博文不明之处，欢迎加群交流：261746360，小杜比亚-博客园

Sitemesh小记的更多相关文章

[原]Paste.deploy 与 WSGI, keystone 小记
Paste.deploy 与 WSGI, keystone 小记名词解释: Paste.deploy 是一个WSGI工具包,用于更方便的管理WSGI应用, 可以通过配置文件,将WSGI应用加载起来. ...
MySql 小记
MySql 简单小记以备查看 1.sql概述 1.什么是sql? 2.sql发展过程? 3.sql标准与方言的关系? 4.常用数据库? 5.MySql数据库安装? 2.关键概念表结构----- ...
Spring MVC学习笔记——SiteMesh的使用（转）
转自 SiteMesh的使用 SiteMesh的介绍就不多说了,主要是用来统一页面风格,减少重复编码的. 它定义了一个过滤器,然后把页面都加上统一的头部和底部. 需要先在WEB-INF/lib下引入s ...
Git小记
Git简~介 Git是一个分布式版本控制系统,其他的版本控制系统我只用过SVN,但用的时间不长.大家都知道,分布式的好处多多,而且分布式已经包含了集中式的几乎所有功能.Linus创造Git的传奇经历就 ...
广州PostgreSQL用户会技术交流会小记 2015-9-19
广州PostgreSQL用户会技术交流会小记 2015-9-19 今天去了广州PostgreSQL用户会组织的技术交流会分别有两个session 第一个讲师介绍了他公司使用PostgreSQL-X2 ...
东哥读书小记之《MacTalk人生元编程》
一直以来的自我感觉:自己是个记性偏弱的人.反正从小读书就喜欢做笔记(可自己的字写得巨丑无比,尼玛不科学呀),抄书这事儿真的就常发生俺的身上. 因为那时经常要背诵课文之类,反正为了怕自己忘记, ...
Paypal支付小记
Paypal支付小记 *:first-child { margin-top: 0 !important; } body>*:last-child { margin-bottom: 0 !impo ...
linux 下cmake 编译 ,调用,调试 poco 1.6.0 小记
上篇文章小记了: 关于 Poco::TCPServer框架 (windows 下使用的是 select模型) 学习笔记. http://www.cnblogs.com/bleachli/p/4352 ...
mongodb入门学习小记
Mongodb 简单入门(个人学习小记) 1.安装并注册成服务:(示例) E:\DevTools\mongodb3.2.6\bin>mongod.exe --bind_ip 127.0.0.1 ...

随机推荐

APP如何发布到Google play 商店
APP如何发布到Google play 商店?以及有哪些需要注意的点 2015-05-13 10:07 19773人阅读评论(1) 收藏举报分类: iPhone游戏开发(330) 链接:ht ...
北京Uber优步司机奖励政策（3月29日
滴快车单单2.5倍,注册地址:http://www.udache.com/ 如何注册Uber司机(全国版最新最详细注册流程)/月入2万/不用抢单:http://www.cnblogs.com/mfry ...
在线大数据cdh迁移，从公有云迁移到私有云
1.添加新节点 2.迁移hdfs和hbase数据: 3.迁移源节点各个服务到新节点: 4.利用HA,包括hdfs,hbase master,resourcemanager的ha实现在线迁移: 5.数据 ...
DSP5509的定时器实验-第2篇
1. 导入Easy5509开发板的例程EX02_TIME,5509有2个16位的定时器,有点少啊 2. 直接编译,提示找不到CSL.h,其实我也好奇,CSL库是从哪里来的?RTS库从哪里来的?头文件在 ...
四、新时间日期API
一.使用 LocalDate .LocalTime .LocalDateTime LocalDate.LocalTime.LocalDateTime 类的实例是不可变的对象,分别表示使用 ISO-86 ...
Redis系列七主从复制(Master/Slave)
主从复制(Master/Slave) 1.是什么也就是我们所说的主从复制,主机数据更新后根据配置和策略,自动同步到备机的master/slaver机制,Master以写为主,Slave以读为主. 2 ...
Java String 字符串类细节探秘
一. 字符串基本知识要点字符串类型String是Java中最常用的引用类型.我们在使用Java字符串的时候,通常会采用两种初始化的方式:1. String str = "Hello Wor ...
dubbo入门（一）
1.简介 Dubbo由阿里巴巴开源,是一个分布式服务框架,致力于提供高性能和透明化的RPC(远程过程调用)远程服务调用方案,以及SOA服务治理方案.如果没有分布式的需求,Dbubbo是不需要的,其本质 ...
使用duplicateweedout
mysql> explain extended select * from cities where id in (select phonecode from countries group b ...
CentOS 使用PostFix搭建邮件服务器
搭建环境: 关于PostFix是什么以及邮件服务器接受发送邮件流程网上有很多文章,这里就不再写了,这里只记录如何搭建邮件服务器,使用PostFix接受发送邮件 CentOS6.8 32位,postfi ...