在Grails3中使用Sitemesh

在Grails3中使用Sitemesh,grails,sitemesh,grails-3.1,Grails,Sitemesh,Grails 3.1,我正在将一组Grails2.0.4应用程序迁移到3.x版。它们都部署在同一台服务器上,并与许多java应用程序一起部署。使用sitemesh和freemarker模板,java和grails应用程序集都有一个共同的外观。 但是在Grails3.x中,我无法使公共装饰工作,应用程序坚持使用layouts/main.gsp来呈现我的gsp 到目前为止(Grails2.0.4),提供一个普通的装饰是相当直接的;每个grails应用程序的文件/WEB-INF/decorators.xml提供了对适用的f

我正在将一组Grails2.0.4应用程序迁移到3.x版。它们都部署在同一台服务器上,并与许多java应用程序一起部署。使用sitemesh和freemarker模板,java和grails应用程序集都有一个共同的外观。 但是在Grails3.x中,我无法使公共装饰工作,应用程序坚持使用layouts/main.gsp来呈现我的gsp

到目前为止(Grails2.0.4),提供一个普通的装饰是相当直接的;每个grails应用程序的文件/WEB-INF/decorators.xml提供了对适用的freemarker模板的引用。xml包括sitemesh过滤器和freemarker装饰器servlet声明和映射

decorators.xml:

<?xml version="1.0" encoding="UTF-8"?>
<decorators defaultdir="/">
    <excludes>
        <pattern>/ND/*</pattern>
        <pattern>/*/ND/*</pattern>
     </excludes>
     <decorator name="freemarker" page="myftl.ftl">
         <pattern>/*</pattern>
     </decorator>
</decorators>

然而,Grails3.x应用程序坚持使用layouts/main.gsp来呈现我的gsp页面。似乎没有处理decorators.xml。我遗漏了什么?

可能是一个丑陋的黑客,但您可以将您的sitemesh处理叠加到grails处理上:

  • 在应用程序类(或spring/resources.groovy)中注册自定义sitemesh筛选器:
  • sitemesh配置不能是默认配置,因为grails将继续 读它
  • 将freemarker servlet注册到进程ftl:
  • 添加自定义sitemesh过滤器:
  • 在这个过滤器中,您必须覆盖新sitemesh工厂中的装饰器选择器,因为默认的是singleton(sic),grails已经为其内部gsp进程注册了它
  • 不应该有来覆盖content proccesor(initContentProcessor方法),让grails使用默认的sitemesh工厂处理gsp
  • 如果您想获得更多功能(如排除的模式),则需要覆盖整个doFilter方法,以便在
    contentProcessor.handles(webAppContext)
  • 在src/main/webapp/WEB-INF中添加my.sitemesh.xml和decorators.xml
  • 我已经在过滤器初始化中将grailsApplication添加到servlet上下文中,以便您可以在ftl模板中使用它
  • 如果要跳过某些布局,请在内部grails布局中按环境添加条件

也许不是最好的解决方案,但它确实有效!谢谢!
<filter>
    <filter-name>sitemesh</filter-name>
    <filter-class>org.codehaus.groovy.grails.web.sitemesh.GrailsPageFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>sitemesh</filter-name>
    <url-pattern>/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
    <dispatcher>ERROR</dispatcher>
</filter-mapping>
<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>class://</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>sitemesh-freemarker</servlet-name>
    <url-pattern>*.ftl</url-pattern>
</servlet-mapping>
beans = {
    sitemeshFreemarkerServlet(ServletRegistrationBean) {
        servlet = bean(FreemarkerDecoratorServlet)
        urlMappings = ["*.ftl"]
        loadOnStartup = 2
    }
}

    @Bean
    FilterRegistrationBean sitemeshFilterRegistrationBean() {
        FilterRegistrationBean reg=new FilterRegistrationBean()
        reg.setFilter(new MySitemeshFilter());
        reg.setInitParameters(["configFile":"WEB-INF/my.sitemesh.xml"])
        reg.setUrlPatterns(["/*"])
        reg.setDispatcherTypes(DispatcherType.REQUEST,DispatcherType.ERROR);
        reg.setOrder(0);
        return reg;
    }

    @Bean
    ServletRegistrationBean freeMarkerServletRegistrationBean(){
        ServletRegistrationBean reg=new ServletRegistrationBean(new 
          FreemarkerDecoratorServlet(),"*.ftl");
        reg.addInitParameter("TemplatePath", "class://");
        reg.addInitParameter("default_encoding", "UTF-8");
        // etc
        return reg;
    }
 
import com.opensymphony.module.sitemesh.Config;
import com.opensymphony.module.sitemesh.Factory
import com.opensymphony.module.sitemesh.factory.DefaultFactory;
import com.opensymphony.sitemesh.ContentProcessor;
import com.opensymphony.sitemesh.DecoratorSelector;
import com.opensymphony.sitemesh.compatability.DecoratorMapper2DecoratorSelector;
import com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext;

import grails.util.Holders;
import javax.servlet.FilterConfig

class MySitemeshFilter extends com.opensymphony.sitemesh.webapp.SiteMeshFilter {

    private static final String MY_SITEMESH_FACTORY = "my.sitemesh.factory";
    private FilterConfig filterConfig;
    @Override   
    public void init(FilterConfig filterConfig) {
        super.init(filterConfig);
        filterConfig.getServletContext().setAttribute("grailsApplication", Holders.grailsApplication);
        this.filterConfig=filterConfig;
    }

    protected Factory getFactory(FilterConfig filterConfig) {
        Config config=new Config(filterConfig)
        Factory f=(Factory)config.getServletContext().getAttribute(MY_SITEMESH_FACTORY);
        if (f==null) {
            f=new DefaultFactory(config);
            config.getServletContext().setAttribute(MY_SITEMESH_FACTORY, f);
        }
        return f;
    }

    @Override
    protected DecoratorSelector initDecoratorSelector(SiteMeshWebAppContext webAppContext) {
        Factory factory = getFactory(filterConfig);
        factory.refresh();
        return new DecoratorMapper2DecoratorSelector(factory.getDecoratorMapper());
    }
}