SpringBoot模板引擎

时间 2021-08-13

标签 html java web spring 浏览器缓存 springboot 性能优化 markdown mybatis 栏目 Spring 繁體版

原文原文链接

SpringBoot模板引擎

Thymeleaf模板

关于Thymeleaf的优势 : 若是只想替换掉jsp展示形式会选择Thymeleaf模板html

代码演示
相关pom依赖java

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

application.properties文件通常不采用默认后缀，改为application.yml
Spring Boot官方文档建议在开发时将缓存关闭，那就在application.properties文件中加入spring.thymeleaf.cache=false默认是true
application.ymlweb

server:
  port: 80
  servlet:
    context-path: /

spring:
  thymeleaf:
    cache: false

Userspring

package com.myy.springboot01.entity;

import lombok.Data;

/** * @author 熊贝贝 * @site www.myy.com * @company * @create 2019-12-27 20:29 */
@Data
public class User {
    private String uid;
    private String uname;
    private String pwd;

    public User(String uid, String uname, String pwd) {
        this.uid = uid;
        this.uname = uname;
        this.pwd = pwd;
    }

    public User() {
    }
}

UserController浏览器

package com.myy.springboot01.controller;

import com.myy.springboot01.entity.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.ArrayList;
import java.util.List;

/**
 * @author 熊贝贝
 * @site www.myy.com
 * @company
 * @create  2019-12-27 20:20
 *
 * 介绍Thymeleaf模板的应用
 */
@Controller
@RequestMapping("/thymeleaf")
public class UserController {

    @RequestMapping("/list")
    public ModelAndView list(){
        System.out.println("这是list");
        ModelAndView mv = new ModelAndView();
        mv.addObject("title","员工列表");
        List<User> list = new ArrayList<>();
        list.add(new User("1","张三","123"));
        list.add(new User("2","李四","12345"));
        list.add(new User("3","王五","123456"));
        mv.addObject("users",list);
//        为何须要讲解HTML转义？
        mv.addObject("msg","<span style='color:red'>优秀员工是张三</span>");
        mv.setViewName("list");
        return mv;
    }
}

list.html
HTML页面提示标签缓存

<html xmlns:th="http://www.thymeleaf.org">

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Thymeleaf知识点</title>
</head>
<body>
<table border="1" cellpadding="0" cellspacing="0" width="60%">
    <caption th:text="${title}"></caption>
    <tr>
        <th>ID</th>
        <th>名字</th>
        <th>密码</th>
    </tr>
    <tr th:each="u : ${users}">
        <td th:text="${u.uid}"></td>
        <td th:text="${u.uname}"></td>
        <td th:text="${u.pwd}"></td>
    </tr>
</table>
<p th:utext="${msg}"></p>
</body>
</html>

运行浏览器显示：
springboot

Freemarker模板

性能优化会选择Freemarker模板
学习网站：http://freemarker.foofun.cn/
导入pom依赖性能优化

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-freemarker</artifactId>
   </dependency>

<!--能够不加，可是作项目的时候可能会用-->
 <resources>
            <!--解决mybatis-generator-maven-plugin运行时没有将XxxMapper.xml文件放入target文件夹的问题-->
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
            </resource>
            <!--freemarker模板也读取须要注释标红地方-->
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <!--<include>*.properties</include>-->
                    <!--<include>*.xml</include>-->
                    <!--<include>*.yml</include>-->
                </includes>
            </resource>
        </resources>

application.yml文件的默认配置markdown

server:
  port: 80
  servlet:
    context-path: /

spring:
  thymeleaf:
    cache: false

  freemarker:
    # 设置模板后缀名
    suffix: .ftl
    # 设置文档类型
    content-type: text/html
    # 设置页面编码格式
    charset: UTF-8
    # 设置页面缓存
    cache: false
    # 设置ftl文件路径，默认是/templates，为演示效果添加role
    template-loader-path: classpath:/templates/role
  mvc:
    static-path-pattern: /static/**

注意层级关系mybatis

至关于：

springmvc.xml
     internalResouresviewResolver
         prefix  classpath:/templates/role
          subfix  .ftl

配置freemarker。也可不配置，则建立ftl文件时改后缀名

Role

package com.myy.springboot01.entity;

import lombok.Data;

/** * @author 熊贝贝 * @site www.myy.com * @company * @create 2019-12-27 20:29 */
@Data
public class Role {
    private String rid;
    private String rname;

    public Role(String rid, String rname) {
        this.rid = rid;
        this.rname = rname;
    }

    public Role() {
    }
}

RoleController

package com.myy.springboot01.controller;

import com.myy.springboot01.entity.Role;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;

import java.util.ArrayList;
import java.util.List;

/** * @author 熊贝贝 * @site www.myy.com * @company * @create 2019-12-27 20:20 * * 介绍Thymeleaf模板的应用 */
@Controller
@RequestMapping("/freemarker")
public class RoleController {

    @RequestMapping("/list")
    public ModelAndView list(){
        System.out.println("这是list");
        ModelAndView mv = new ModelAndView();
        mv.setViewName("list");
        mv.addObject("name","张三");
        mv.addObject("sex","gay");

        List<Role> list = new ArrayList<>();
        list.add(new Role("1","超级会员"));
        list.add(new Role("2","会员"));
        list.add(new Role("3","普通用户"));
        mv.addObject("roles",list);
        return mv;
    }
}

list.ftl

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Freemarker模板知识点</title>
</head>
<body>
<h2>取值</h2>
<h3>提供默认值</h3>
welcome 【${name!'未知'}】 to freemarker!

<h3>exists用在逻辑判断</h3>
<#if name?exists>
${name}
</#if>

<h2>条件</h2>
<#if sex=='girl'>
女
<#elseif sex=='boy'>
男
<#else>
保密
</#if>

<h2>循环</h2>
<table border="1px" width="600px">
    <thead>
    <tr>
        <td>ID</td>
        <td>角色名</td>
        <td>描述</td>
    </tr>
    </thead>
    <tbody>
    <#list roles as role>
    <tr>
        <td>${role.rid}</td>
        <td>${role.rname}</td>
    </tr>
    </#list>
    </tbody>
</table>

<h2>include</h2>
<#include 'foot.ftl'>

<h2>局部变量(assign)/全局变量(global)</h2>
<#--获取全路径名${pageContext.request.contextpath}-->
<#assign ctx1>
${springMacroRequestContext.contextPath}
</#assign>

<#global ctx2>
${springMacroRequestContext.contextPath}
</#global>

${ctx1}和${ctx2}
</body>
</html>

foot.ftl

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>底部版权信息</title>
</head>
<body>
xxxx
2019myy版权全部
</body>
</html>

浏览器运行结果显示：

若是页面没有效果，有多是pom依赖缺损坏。删掉该jar包的中央仓库，从新下载便可。

注意点：
一、application.yml中能够配置模板存放位置的根路径、以及静态资源文件存放位置的根路径
二、${springMacroRequestContext.contextPath}：SpringBoot中获取项目名
三、不推荐使用全局变量。即使它们属于不一样的命名空间，全局变量也被全部模板共享，由于它们是被 import进来的。
四、freemarker模板也能够像jsp那样设置根路径

common.html

<div th:fragment="h1">
    第一部份内容
</div>
<div th:fragment="h2">
第二部份内容
</div>
<div th:fragment="h3">
第三部份内容
</div>

list.html

<!--thymeleaf包含公共区域的方案-->
<!--<div th:include="common.html"></div>-->
<div th:include="common :: h1"></div>
<div th:include="common :: h3"></div>

浏览器运行