美文网首页程序员
spring-boot与模板引擎:修改模板路径和后缀名

spring-boot与模板引擎:修改模板路径和后缀名

作者: Alisallon | 来源:发表于2017-12-12 15:55 被阅读0次

    系列传送门

    spring-boot与模板引擎:静态资源文件路径
    spring-boot与模板引擎:修改模板路径和后缀名
    spring-boot与模板引擎:使用metisMenu实现动态多级菜单

    spring-boot与模板引擎:使用metisMenu实现动态多级菜单一文中,我们使用了spring-boot和beetl模板引擎。
    在使用时,产生了下面2个疑问:
    1、创建模板文件夹为什么一定要用“templates”,可以换成其他的文件名吗?
    2、创建的模板,一定要用“btl”做后缀名吗?能不能使用“html”或者其他的后缀名?
    下面让我们一起探讨下以上的问题。

    先看看FreeMarker,Groovy,Thymeleaf,Mustache这四种模板引擎

    spring-boot docs 中有下面句话:

    Spring Boot includes auto-configuration support for the following templating engines:

    When you’re using one of these templating engines with the default configuration, your templates will be picked up automatically from:

    src/main/resources/templates.

    查看包名org.springframework.boot.autoconfigure.thymeleaf下的ThymeleafProperties源码:

    @ConfigurationProperties(
        prefix = "spring.thymeleaf"
    )
    public class ThymeleafProperties {
        private static final Charset DEFAULT_ENCODING = Charset.forName("UTF-8");
        private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
        public static final String DEFAULT_PREFIX = "classpath:/templates/";
        public static final String DEFAULT_SUFFIX = ".html";
        private boolean checkTemplate = true;
        private boolean checkTemplateLocation = true;
        private String prefix = "classpath:/templates/";
        private String suffix = ".html";
        private String mode = "HTML5";
        ......
        ......
    }
    

    查看包名org.springframework.boot.autoconfigure.groovy.template下的GroovyTemplateProperties源码:

    @ConfigurationProperties(
        prefix = "spring.groovy.template",
        ignoreUnknownFields = true
    )
    public class GroovyTemplateProperties extends AbstractTemplateViewResolverProperties {
        public static final String DEFAULT_RESOURCE_LOADER_PATH = "classpath:/templates/";
        public static final String DEFAULT_PREFIX = "";
        public static final String DEFAULT_SUFFIX = ".tpl";
        public static final String DEFAULT_REQUEST_CONTEXT_ATTRIBUTE = "spring";
        private String resourceLoaderPath = "classpath:/templates/";
        ......
        ......
    }
    

    查看包名org.springframework.boot.autoconfigure.freemarker下的FreeMarkerProperties源码:

    @ConfigurationProperties(
        prefix = "spring.freemarker"
    )
    public class FreeMarkerProperties extends AbstractTemplateViewResolverProperties {
        public static final String DEFAULT_TEMPLATE_LOADER_PATH = "classpath:/templates/";
        public static final String DEFAULT_PREFIX = "";
        public static final String DEFAULT_SUFFIX = ".ftl";
        private Map<String, String> settings = new HashMap();
        private String[] templateLoaderPath = new String[]{"classpath:/templates/"};
        private boolean preferFileSystemAccess = true;
        ......
        ......
    }
    

    查看包名org.springframework.boot.autoconfigure.mustache下的MustacheProperties源码:

    @ConfigurationProperties(
        prefix = "spring.mustache"
    )
    public class MustacheProperties extends AbstractTemplateViewResolverProperties {
        public static final String DEFAULT_PREFIX = "classpath:/templates/";
        public static final String DEFAULT_SUFFIX = ".html";
        private String prefix = "classpath:/templates/";
        private String suffix = ".html";
    
        public MustacheProperties() {
            super("classpath:/templates/", ".html");
        }
        ......
        ......
    }
    

    从上面可以看出,对于spring-boot项目,如果使用以上任一模板,而且不做任何设置,spring-boot是默认把classpath路径下的templates作为模板文件的根目录,模板的后缀名也默认为对应模板的默认后缀名。

    如果想要更改模板文件的根目录和模板后缀名,就需要新建一个Application.properties文件,在该文件里进行配置。

    配置其实很简单。继续翻看上面4个模板的配置源码,我们注意到,在class定义之前,有一个@ConfigurationProperties注解:

    @ConfigurationProperties(
        prefix = "spring.XXXXXX"
    )
    

    从该注解可以看出,不同的模板引擎,spring-boo从Application.properties中读取的配置的名字的前缀是不同的。
    而且,在spring-boot启动时,会通过该注解,自动把Application.properties中配置的spring.XXXXXX.abc赋值给对应模板Properties的abc属性。
    所以,在Application.properties中只需要添加spring.XXXXXX.abc对应的配置即可。
    下面是配置示例:

    ......
    ......
    #THYMELEAF (ThymeleafAutoConfiguration)
    spring.thymeleaf.prefix=classpath:/templates/
    spring.thymeleaf.suffix=.html
    spring.thymeleaf.mode=HTML5
    spring.thymeleaf.encoding=UTF-8
    spring.thymeleaf.content-type=text/html # ;charset=<encoding> is added
    spring.thymeleaf.cache=true # set to false for hot refresh
    
    #FREEMARKER (FreeMarkerAutoConfiguration)
    spring.freemarker.allowRequestOverride=false
    spring.freemarker.allowSessionOverride=false
    spring.freemarker.cache=true
    spring.freemarker.checkTemplateLocation=true
    spring.freemarker.contentType=text/html
    spring.freemarker.exposeRequestAttributes=false
    spring.freemarker.exposeSessionAttributes=false
    spring.freemarker.exposeSpringMacroHelpers=false
    spring.freemarker.prefix=
    spring.freemarker.requestContextAttribute=
    spring.freemarker.settings.*=
    spring.freemarker.suffix=.ftl
    spring.freemarker.templateEncoding=UTF-8
    spring.freemarker.templateLoaderPath=classpath:/templates/
    spring.freemarker.viewNames= # whitelist of view names that can be resolved
    
    
    #GROOVY TEMPLATES (GroovyTemplateAutoConfiguration)
    spring.groovy.template.allowRequestOverride=false
    spring.groovy.template.allowSessionOverride=false
    spring.groovy.template.cache=true
    spring.groovy.template.configuration.*= # See Groovy's TemplateConfiguration
    spring.groovy.template.contentType=text/html
    spring.groovy.template.prefix=classpath:/templates/
    spring.groovy.template.suffix=.tpl
    spring.groovy.template.templateEncoding=UTF-8
    spring.groovy.template.viewNames= # whitelist of view names that can be resolved
    ......
    ......
    

    下面让我们来看看beetl模板引擎

    对于spring-boot,如果使用beetl模板引擎,不能添加beetl的lib包,需要添加下面的lib包:

    <!-- beetl -->
    <dependency>
        <groupId>com.ibeetl</groupId>
        <artifactId>beetl-framework-starter</artifactId>
        <version>1.1.22.RELEASE</version>
    </dependency>
    

    添加好之后,让我们像上面一样,分析下beetl模板引擎的默认配置,和怎么修改默认配置。

    查看包名com.ibeetl.starter下的BeetlTemplateConfig源码:

    ......
    ......
    public class BeetlTemplateConfig {
        @Value("${beetl.templatesPath:templates}")
        String templatesPath;
        @Value("${beetl.suffix:btl}")
        String suffix;
        @Value("${beetl-beetlsq.dev:true}")
        boolean dev;
        ......
        ......
    }
    

    一目了然,修改Application.properties如下:

    beetl.templatesPath=templates/other/
    beetl.suffix=html
    

    OR

    beetl.templatesPath=other/
    beetl.suffix=html
    

    此时,你可以自由的在templates目录下新建其他文件夹或者直接在resource下新建其他文件夹,并把以html为后缀的模板文件放进去了。

    相关文章

      网友评论

        本文标题:spring-boot与模板引擎:修改模板路径和后缀名

        本文链接:https://www.haomeiwen.com/subject/jdagixtx.html