Sitemesh 初探

引入：

最近在review别的团队的代码，看到他们团队使用了sitemesh,以前对这个不是很了解，刚好借助他们源代码，这里简单研究了下：

简单介绍：

其实sitemesh使用了页面装饰技术，它主要就是用一个或者多个装饰器应用于某些给定页面，最终产生被装饰器装饰后的页面。

具体过程是：

(1)sitemesh通过Filter来拦截页面访问 (可以猜想：肯定会有个url-pattern，表明此url被适用于某装饰器，等会具体讲 )

(2)一旦拦截到，则根据被访问的url来找到合适的装饰模板(可以猜想：肯定有一个模板定义文件，在其中定义了模板和模板使用的url之间的映射关系)

(3)提取被访问的页面的内容，放到装饰模板中给定的位置（这几乎是废话，因为这是组合页面技术，肯定输入有2个，一个是模板，一个是被访问页面，模板肯定会给出一些可配置的点，然后用placeholder表示，然后这些placeholder中放入的内容肯定由真实页面提供，放真实页面的内容肯定有个标记，这个标记符合模板上的标记从而不会找错，等会可以验证）

(4)把装饰后的页面发送给客户端。

以上是我对于这个框架的开始的猜想，接下来就是去验证这些猜想。

实践：

(1)首先，如何做到sitemesh通过filter来拦截页面访问呢？根据常识，一般web应用过滤器都是定义在web.xml中的，所以我们去找：

    
        sitemesh
        com.opensymphony.module.sitemesh.filter.PageFilter 
    
    
        sitemesh
        /*
    

从这里可以很清楚的看到，我们配置了 sitemesh过滤器，然后要对所有的页面都适用这个过滤器，当然了，要过滤器生效，还必须有相应的jar包，并且放在WEB-INF/lib下，这个是常识，因为他们项目中使用了maven,所以我们肯定会在pom.xml中找到对应的depenency:

        
            opensymphony
            sitemesh
            2.4.2
        

(2)现在我们来看第二步，肯定有个模板定义文件，定义了模板文件和其适用的文件之间的关系。这里就有2个概念了，一个是一般文件（可以说比较素的文件）， 一种是模板文件（它定义了比较花哨的结构和外观），素文件我们不讲了，就是一般页面（比如jsp),然后模板文件，肯定是带有placeholder的页面文件，所以我们找到了这些文件：

显然，在他们的项目中，这些模板文件是放在WEB-INF/decorators中的，并且从这里可以看出他们定义了2个模板文件，一个叫blog_main.jsp,另一个叫main.jsp,然后他们的一般文件都是放在WEB-INF/jsp中的来加强安全性。我们随便打开一个模板文件，比如blog_main.jsp:

<%@ taglib uri="http://www.opensymphony.com/sitemesh/decorator" prefix="decorator"%>
<%@ page language="java" contentType="text/html; charset=utf-8"  pageEncoding="utf-8"%>

    
                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                     
        
        
        
        
        
        
        
        
        
        
    
    
        
        
        

             
        
                                                                                                                                                                                                                                                                                                                                                                                     
    
                                                                                                                                                                                                                                                                                                                                                                                 
    

果然和我们猜想一样，这个页面是一个有占位符的文件，所以是模板文件，并且模板文件用的标签前缀都是 ，所以这个模板文件中有3个可插入内容的点，一个是,一个是,一个是, 并且查询相关文章可以知道，整合素文件的过程是从素文件中分别提取出