spring boot整合freemarker+sitemesh

简述：
项目中可能会遇到多个html，其中顶部头部或者资源文件引用都相同的情况等,为了简洁项目结构，净化页面，采用了本方案来解决，如下：

1. pom文件添加相关依赖

       

    4.0.0

    general-manager
    general-manager-web
    1.0-SNAPSHOT
    
    
        org.springframework.boot
        spring-boot-starter-parent
        1.5.7.RELEASE
    
    
    
        
            org.springframework.boot
            spring-boot-starter-thymeleaf
        
        
        
            org.springframework.boot
            spring-boot-starter-freemarker
        
        
        
            org.sitemesh
            sitemesh
            3.0.1
        
        
        
            org.springframework
            springloaded
            1.2.6.RELEASE
        
        
            org.springframework.boot
            spring-boot-devtools
            true 
        

    

    
        general-manager-web
        
            
                org.springframework.boot
                spring-boot-maven-plugin
            
            
                org.codehaus.mojo
                exec-maven-plugin
                
                    java
                    
                        com.py.general.App
                    
                
            
        
    

2. 创建sitemesh目录存放sitemesh相关配置

image.png

DecoratorController

package com.py.general.web.sitemesh;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.List;

/**
 * Created by py
 */
@Controller
@RequestMapping(value = "/decorator")
public class DecoratorController  {

    private static final Logger logger = LoggerFactory.getLogger(DecoratorController.class);

    @RequestMapping(value = "/index")
    public ModelAndView index(ModelMap modelMap) {
        return new ModelAndView("decorators/index");
    }
}

WebConfig

package com.py.general.web.sitemesh;


import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;

/**
 * Created by py
 */
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Bean
    public FilterRegistrationBean siteMeshFilter() {
        FilterRegistrationBean fitler = new FilterRegistrationBean();
        WebSiteMeshFilter siteMeshFilter = new WebSiteMeshFilter();
        fitler.setFilter(siteMeshFilter);
        return fitler;
    }
}

WebSiteMeshFilter

package com.py.general.web.sitemesh;

import org.sitemesh.builder.SiteMeshFilterBuilder;
import org.sitemesh.config.ConfigurableSiteMeshFilter;

/**
 * Created by py
 */
public class WebSiteMeshFilter extends ConfigurableSiteMeshFilter {

    public static final String DECORATOR_URL="/decorator/index";

    /**
     * decoratorPath 第一个参数配置被模板装饰的页面  第二个参数为模板页
     * @param builder
     */
    @Override
    protected void applyCustomConfiguration(SiteMeshFilterBuilder builder) {
        builder.addDecoratorPath("/", DECORATOR_URL)
                .addDecoratorPath("/test", DECORATOR_URL)
                .addExcludedPath("/test1")//不需要装饰的路径
                .addExcludedPath(DECORATOR_URL);
    }
}

3. application.yml

server:
  port: 8001

spring:
  freemarker:
    cache: false
    settings:
      template_update_delay: 0

4.页面文件处理,templates下创建修饰目录

image.png

footer.ftl

footer.............................................

header.ftl

    
    
    
    
    
    <#--根据自己模板所需要的木块添加 css  只需包含在head标签即可-->
    

index.ftl

    <#include "header.ftl">

    
    修饰页面主题内容
    

    

    <#include "footer.ftl">

    

test.ftl

        



    被修饰页面主体内容

testController.java

package com.py.general.web.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
/**
 * Created by py on 2017/11/29.
 */
@Controller
public class TestController {
    @RequestMapping(value = "/test")
    public String  test(){
        return  "test1";
    }

}

运行结果：

image.png

image.png