SpringBoot模板引擎簡單認知

Smootht發表於2020-11-29
Spring Boot

SpringBoot模板引擎簡單認知

thymeleaf模板

關於Thymeleaf的優點，我只說一條：它就是html頁面。下面直接上程式碼

新增pom.xml相關依賴

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

Spring Boot官方文件建議在開發時將快取關閉，那就在application.properties檔案中加入下面這行

spring.thymeleaf.cache=false

在這裡插入圖片描述
正式環境還是要將快取開啟的

後臺程式碼塊
實體類

package com.tanle.springboot01.entity;

import lombok.Data;

/**
 * @author tanle
 * @site www.tanle.com
 * @company xxx公司
 * @create  2020-11-27 16:14
 */
@Data
public class User {
    private Integer uid;
    private String uname;
    private String pwd;

    public User() {
    }

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

conroller層

package com.tanle.springboot01.controller;

import com.tanle.springboot01.entity.User;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import java.util.ArrayList;
import java.util.List;

/**
 * @author tanle
 * @site www.tanle.com
 * @company xxx公司
 * @create  2020-11-27 16:16
 */
@Controller
@RequestMapping("/thymeleaf")
public class UserController {
    @RequestMapping("/list")
    public String hello(HttpServletRequest request){
        /*
        * 1.獲取單個值
        * 2.能夠在html頁面進行遍歷展示
        * 3.如何在html頁面轉義html程式碼塊
        * */
        request.setAttribute("msg","傳輸單個資料");
        List<User> userList=new ArrayList<User>();
        userList.add(new User(1,"zs","123"));
        userList.add(new User(2,"ls","234"));
        userList.add(new User(3,"ww","345"));
        request.setAttribute("userList",userList);
        request.setAttribute("htmlStr","<span style='color:red'>轉義html程式碼塊</span>");
        return "list";
    }

}

前臺程式碼塊

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>thymeleaf模板介紹</title>
</head>
<body>
    <div th:text="${msg}"></div>

<table width="60%" border="1">
    <tr>
        <td>id</td>
        <td>使用者名稱</td>
        <td>密碼</td>
    </tr>
    <tr th:each="u : ${userList}">
        <td th:text="${u.uid}"></td>
        <td th:text="${u.uname}"></td>
        <td th:text="${u.pwd}"></td>
    </tr>
</table>
<div th:utext="${htmlStr}"></div>


</body>
</html>

瀏覽器執行結果
單個值的傳遞
表格資料的遍歷
轉義程式碼塊

在這裡插入圖片描述

Freemarker模板

新增pom.xml檔案

<!--可以不加，但是做專案的時候可能會用-->
 <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檔案的預設配置

spring:
  thymeleaf:
    cache: false
  freemarker:
    # 設定模板字尾名
    suffix: .ftl
    # 設定文件型別
    content-type: text/html
    # 設定頁面編碼格式
    charset: UTF-8
    # 設定頁面快取
    cache: false
    # 設定ftl檔案路徑，預設是/templates，為演示效果新增role
    template-loader-path: classpath:/templates/freemarker
  mvc:
    static-path-pattern: /static/**

在這裡插入圖片描述

實體類

package com.tanle.springboot01.entity;

import lombok.Data;

/**
 * @author tanle
 * @site www.tanle.com
 * @company xxx公司
 * @create  2020-11-27 16:49
 */
@Data
public class Role {
    private Integer rid;
    private String roleName;
    private String desc;


    public Role() {
    }

    public Role(Integer rid, String roleName, String desc) {
        this.rid = rid;
        this.roleName = roleName;
        this.desc = desc;
    }
}

Freemarker模板的字尾是ftl
可以提前設定

在這裡插入圖片描述
在這裡插入圖片描述

新建list.ftl頁面程式碼

<!DOCTYPE html>
<html lang="en">
<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.roleName}</td>
            <td>${role.desc}</td>
        </tr>
    </#list>
    </tbody>
</table>

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

<h2>區域性變數(assign)/全域性變數(global)</h2>
<#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$</title>
</head>
<body>
底部頁面
</body>
</html>

RoleController

package com.tanle.springboot01.controller;

import com.tanle.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 tanle
 * @site www.tanle.com
 * @company xxx公司
 * @create  2020-11-27 16:47
 */
@Controller
@RequestMapping("/freemarker")
public class RoleController {

    @RequestMapping("/role/list")
    public ModelAndView roleList(){
        ModelAndView mav = new ModelAndView();
        mav.setViewName("/list");

        mav.addObject("name",null);
        mav.addObject("sex","gay");
        List list = new ArrayList();
        list.add(new Role(1,"老師","教書育人"));
        list.add(new Role(2,"學生","知識改變命運"));
        mav.addObject("roles",list);

        return mav;
    }

    @RequestMapping("toLogin")
    public String toLogin(){
        return "login";
    }

}

瀏覽器執行結果

在這裡插入圖片描述

1、application.yml中可以配置模板存放位置的根路徑、以及靜態資原始檔存放位置的根路徑
2、${springMacroRequestContext.contextPath}：SpringBoot中獲取專案名
3、不推薦使用全域性變數。即便它們屬於不同的名稱空間， 全域性變數也被所有模板共享，因為它們是被 import進來的。
4、freemarker模板也可以像jsp那樣設定根路徑

thymeleaf中替代jsp:include的寫法

包含整個html頁面

在這裡插入圖片描述
在這裡插入圖片描述

在這裡插入圖片描述

引用其中一段

在這裡插入圖片描述

在這裡插入圖片描述
注意：
1、這裡的th:replace裡的路徑是相對於templetes資料夾的。
2、冒號冒號前後都有空格，我沒注意這一點踩了大坑

相關文章