springMvc sitemesh freemarker 整合总结



 

前言

• 由于个人喜欢springmvc对restful支持的完美，再加上配置简单和与spring的天然集成，故项目打算用springMvc;
• freemarker 尽管网上有众多评测，言之性能不挤，但对于我们项目的的环境而言是足够的，再加上其丰富的内建函数与指令，亦十分的方便;
• 至于sitemesh，简单的配置，对于中小型项目亦足够;

配置

  先说web.xml,配置如下：

<context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/spring/applicationContext.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <filter>
        <filter-name>encodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <async-supported>true</async-supported>
        <init-param>
            <param-name>encoding</param-name>
            <param-value>UTF-8</param-value>
        </init-param>
        <init-param>
            <param-name>forceEncoding</param-name>
            <param-value>true</param-value>
        </init-param>
    </filter>
    <filter>
        <filter-name>sitemesh</filter-name>
        <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
        <async-supported>true</async-supported>
    </filter>
    
    <!-- 编码-->    
    <filter-mapping>
        <filter-name>encodingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    <!—sitemesh--> 

    <filter-mapping>
        <filter-name>sitemesh</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>
    
    
    <!—springmvc -->    
    <servlet>
        <servlet-name>springServlet</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>classpath:/spring/springMvc/spring_mvc_base.xml</param-value>
        </init-param>
        <load-on-startup>1</load-on-startup>
    </servlet>
   <!—freemarker 配置--> 

    <servlet>
        <servlet-name>sitemesh-freemarker</servlet-name>
        <servlet-class>com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet</servlet-class>
        <init-param>
            <param-name>TemplatePath</param-name>
            <param-value>/</param-value>
        </init-param>
        <init-param>
            <param-name>default_encoding</param-name>
            <param-value>utf-8</param-value>
        </init-param>
        <load-on-startup>2</load-on-startup>
     </servlet>

    <servlet-mapping>
       <servlet-name>springServlet</servlet-name>
        <url-pattern>/</url-pattern>
    </servlet-mapping>
   <!—freemarker 页面配置 --> 

    <servlet-mapping>
        <servlet-name>sitemesh-freemarker</servlet-name>
        <url-pattern>*.htm</url-pattern>
    </servlet-mapping>

 

  spring mvc 以及spring配置无需多讲;

  在这里，有两个地方;

1.   sitemesh filter 的配置;
   由于sitemesh 的主要原理为对mvc或是servlet等web框架渲染后的结果进行再包装;即利用filter对request 和 response 先交给mvc框架处理，处理完后，再对处理完的结果，进行包装，比如加上html头，尾等信息。
   其官方流程图如下，也就是从1到2这个过程是mvc框架做了：
   
   而在处理加上html头和尾的时候，如果是第三方模板引挚如freemarker/velocity之类，还会交给相应servlet用于组装最后的页面。所以上面会出现针对于freemarker的配置，而jsp/jstl是不用的。
   sitemesh filter的代码如下：
   
   

   HttpServletRequest request = (HttpServletRequest) rq;
           HttpServletResponse response = (HttpServletResponse) rs;
           ServletContext servletContext = filterConfig.getServletContext();
   
           SiteMeshWebAppContext webAppContext = new SiteMeshWebAppContext(request, response, servletContext);
   
          // ....省略很多..
           try {
        
              // 得到由mvc框架等渲染完成的页面    
               Content content = obtainContent(contentProcessor, webAppContext, request, response, chain);
   
               if (content == null) {
                   request.setAttribute(ALREADY_APPLIED_KEY, null);
                   return;
               }
               // 进行装饰
               Decorator decorator = decoratorSelector.selectDecorator(content, webAppContext);
               decorator.render(content, webAppContext);

   
2.   freemarker配置
   在FreemarkerDecoratorServlet 配置中，很多参数其实就是freemarker的参数，翻看源码也容易发现sitemesh也是继承至freemarker本身的类FreemarkerServlet，比如编码路径，所以freemarker所有配置是都可以在
   这配置的; 这里的路径必须与springMvc配置视图解析的路径相结合。而servlet-mapping之中，的*.htm为装饰器的文件扩展名，并不是mvc框架返回视图的扩展名。这里的装饰器的扩展名是可以跟mvc视扩展名不一致的。
   用htm是因为myeclipse可以方便的有html代码提示。
   问题恰恰出现在这里，springmvc的一般配置如下：
   
   

   <bean id="freemarkerConfig"
           class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
           <property name="configLocation" value="/WEB-INF/freemarker.properties" /> <!-- 使用freemarker自动导入功能，主要包含一些基础的配置，如时间格工等 -->
           <property name="templateLoaderPath" value="/WEB-INF/" />
       </bean>
       <bean id="viewResolver"
           class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
           <property name="cache" value="false" />
           <property name="prefix" value="" />
           <property name="contentType" value="text/html;charset=UTF-8" />
           <property name="suffix" value=".htm" />
       </bean>

   
   在springmvc的配置中，freemarkerconfig的配置其实与上面FreemarkerDecoratorServlet 是类似的，但又有区别;
   springMvc配置中的freemarker是用于spring mvc页面渲染页面所有，而由于在sitemesh的filter中后期，这个渲染是结束了的。故在装饰器中，springmvc里面配置的freemarker不起做用。起作用是web.xml配置
   FreemarkerDecoratorServlet 。
   而且这个问题在struts 是不会出现的。
   
   

   <filter>
       <filter-name>struts-prepare</filter-name>
       <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsPrepareFilter</filter-class>
   </filter>
    
   <filter>
       <filter-name>sitemesh</filter-name>
       <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
   </filter>
    
   <filter>
       <filter-name>struts-execute</filter-name>
       <filter-class>org.apache.struts2.dispatcher.ng.filter.StrutsExecuteFilter</filter-class>
   </filter>

   
   我个人目前简单觉得，struts 基于filter，分离出prepare 和 execute两个场景，形分而意不分，使插件十分容易扩展且又充分的解藕。这点springmvc的确比不上。再加上struts官方有sitemesh插件支持，
   且sitemesh执行完之后，简单从filter来看，仍是处理struts的执行链中，却没有脱离。
   因为这一点，我在装饰器犯了非常多的错。主要便是一些宏没法使用，但又明明自动引入了。
3. 其它配置
   其它有如sitemesh的decorate.xml等配置就比较简单了，注意路径便好;
   在使用springmvc与spring时，应注意context:component-scan注解的黑白名单，否则最直接的影响就是由于父子容器的存在，事务失效、参考http://jinnianshilongnian.iteye.com/blog/1762632

 

总结

   最后，发现碰到问题，要多思考，多想，多debug，了解清楚，一步一个脚印。