springboot模版引擎

最新推荐文章于 2024-04-17 10:52:18 发布

Vicant 蒋勇

最新推荐文章于 2024-04-17 10:52:18 发布

阅读量319

点赞数

本文链接：https://blog.youkuaiyun.com/weixin_44557427/article/details/103289433

版权

简介：

thymeleaf模板
Freemarker模板

Thymeleaf模板

关于Thymeleaf的优点，我只说一条：它就是html页面。

1.1 导入pom依赖

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

1.2

Spring Boot官方文档建议在开发时将缓存关闭，那就在application.properties文件中加入下面这行

spring.thymeleaf.cache=false

正式环境还是要将缓存开启的

后台代码

1.3 User

package entity;

import lombok.Data;

/**
 * @author 蒋勇
 * @site www.jy.com
 * @company xxx集团
 * @create  2019-11-26 15:46
 */
@Data
public class User {
    private Integer uid;
    private String uname;
    private String pwd;

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

    public User() {

    }
}

1.4 UserController

package com.jy.springboot01.controller;

import 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 蒋勇
 * @site www.jy.com
 * @company xxx集团
 * @create  2019-11-26 15:47
 */
@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<>();
        userList.add(new User( 1 ,"zs" ,"123" ));
        userList.add(new User( 2 ,"ls" ,"234" ));
        userList.add(new User( 3 ,"ww" ,"456" ));
        request.setAttribute("userList",userList);
        request.setAttribute("htmlStr","<span style='color:red'>转义html代码块</span>");

        return "list";
    }

}

1.5 前台HTML页面

list.html

<!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模板

学习网站：http://freemarker.foofun.cn/

2.1 导入pom依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.jy</groupId>
    <artifactId>springboot01</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>springboot01</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

    <build>
        <!--可以不加，但是做项目的时候可能会用-->
        <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>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2.2 application.yml文件的默认配置

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

user:
  uname: zs
  pwd: 123456
  age: 20
  addr: hunan
  sex: nan


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/**

2.3 list.ftl

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</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>
sss
${ctx1}和${ctx2}
sss
</body>
</html>

2.4 foot.ftl

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
版权信息
</body>
</html>

2.5 common.ftl

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<#assign ctx>
    ${springMacroRequestContext.contextPath}
</#assign>
<base href="${ctx}/">
</body>
</html>

2.6 相关controler层的Java代码

package com.jy.springboot01.controller;

import 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.jy.com
 * @company xxx集团
 * @create  2019-11-28 9:57
 */
@Controller
@RequestMapping("/freemarker")
public class RoleController {
    @RequestMapping("/role/list")
    public ModelAndView roleList() {
        ModelAndView mav = new ModelAndView();
        mav.setViewName("/list");

        mav.addObject("name", "ww");
        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";
    }

}

2.7 Role

package entity;

import lombok.Data;

/**
 * @author 蒋勇
 * @site www.jy.com
 * @company xxx集团
 * @create  2019-11-28 9:59
 */
@Data
public class Role {
    private Integer rid;
    private String roleName;
    private String desc;

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

    public Role() {
    }
}

浏览器访问

Thymeleaf的另外一个知识点

3.1

首先修改application.yml文件、因为Thymeleaf和Freemarker会产生冲突

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

user:
  uname: zs
  pwd: 123456
  age: 20
  addr: hunan
  sex: nan


spring:
  thymeleaf:
    cache: false

3.2 common.html

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

3.3 list.html

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>thymeleaf模版介绍</title>
</head>
<body>
<div th:replace="common::h1"></div>
<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>

<!--<div th:include="common.html"></div>-->

<div th:replace="common::h3"></div>
</body>
</html>

浏览器访问

注意点：

1、application.yml中可以配置模板存放位置的根路径、以及静态资源文件存放位置的根路径

2、${springMacroRequestContext.contextPath}：SpringBoot中获取项目名

3、不推荐使用全局变量。即便它们属于不同的命名空间，全局变量也被所有模板共享，因为它们是被 import进来的。

4、freemarker模板也可以像jsp那样设置根路径

<#include 'common.ftl'>

    <script src="js/xxx.js" type="text/javascript"></script>

thymeleaf中替代jsp:include的写法

两种情况

一种是应用一段html代码

在需要应用的地方添加

<div th:replace="foreground/common/head :: navbar" ></div>

一种是包含整个html页面

<div th:include="freemarker/common/head"></div>

注意：

1、这里的th:replace里的路径是相对于templetes文件夹的。

2、冒号冒号前后都有空格，我没注意这一点踩了大坑