Spring Boot(四):Spring Boot 集成 Thymeleaf

Thymeleaf是一款用于渲染XML/XHTML/HTML5内容的模板引擎。类似JSP,Velocity,FreeMaker等,它也可以轻易的与Spring MVC等Web框架进行集成作为Web应用的模板引擎。与其它模板引擎相比,Thymeleaf最大的特点是能够直接在浏览器中打开并正确显示模板页面,而不需要启动整个Web应用,这是由于它支持 html 原型,然后在html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释html 时会忽略未定义的标签属性,所以thymeleaf 的模板可以静态地运行;当有数据返回到页面时,Thymeleaf 标签会动态地替换掉静态内容,使页面动态显示。---摘自百度君。

要写出简洁优雅的前台代码,Spring Boot 君推荐使用Thymeleaf替代jsp。接下来咱们就看看如何利用Thymeleaf模板引擎写出优雅的html代码。

1.1 添加Maven依赖

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

可以查看依赖关系,发现spring-boot-starter-thymeleaf下面已经包括了spring-boot-starter-web,所以可以把spring-boot-starter-web的依赖去掉.

1.2 改造html代码

接下来我们以login登录界面来谈谈Thymeleaf模板引擎的使用方法,
还是以上一篇博客《Spring boot(三):@RequestMapping之Form表单参数传递及POJO绑定实例讲解》的工程项目代码为基础,改造一下我们的登录界面

<!DOCTYPE html>
<html lang="zh-cn">
<head>
    <meta charset="utf-8"/>
    
    <title>Login</title>
    
    <link rel="stylesheet" href="/SpringBootBase/css/bootstrap.min.css"/>
    <link rel="stylesheet" href="/SpringBootBase/css/customer/login.css"/>
</head>

<body>
    <div class="container">
        <form class="form-signin" action="./login" method="post">
            <h2 class="form-signin-heading">请 登 录</h2>
            <input type="text" class="form-control" placeholder="账号" name="username"/>
            <input type="password" class="form-control" placeholder="密码" name="password"/> 
            <button class="btn btn-lg btn-primary btn-block" type="submit">登录</button>
        </form>
    </div>
</body>
</html>

1.2.1 xmlns:th命名空间

使用Thymeleaf引擎需要在html标签添加Thymeleaf模板引擎的命名空间:xmlns:th="http://www.thymeleaf.org",这样的话才可以在其他标签里面使用th:*这样的语法.这是下面语法的前提。

1.2.2 th:href="@{...}"的使用

引用的绝对路径也可以用模板改造,“@{}”为引用静态资源文件,如:

<link rel="stylesheet" href="/SpringBootBase/css/bootstrap.min.css"/>
<link rel="stylesheet" href="/SpringBootBase/css/customer/login.css"/>

可以用thymeleaf模板改写为@{}的形式表示

<link rel="stylesheet" th:href="@{css/bootstrap.min.css}"/>
<link rel="stylesheet" th:href="@{css/customer/login.css}"/>

会引入/static目录下的/css/下的文件;

1.2.3 th:action="@{...}"的使用

表单POST的action url也可以用@{}表示:如

<form class="form-signin" action="./login" method="post">
    ...
</form>
<form class="form-signin" th:action="@{/login}" method="post">
    ...
</form>

于是改造完成后的代码就变成了这样:

<!DOCTYPE html>
<html lang="zh-cn" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="utf-8"/>
    
    <title>Login</title>
    
    <link rel="stylesheet" th:href="@{css/bootstrap.min.css}"/>
    <link rel="stylesheet" th:href="@{css/customer/login.css}"/>
</head>

<body>
    <div class="container">
        <form class="form-signin" th:action="@{/login}" method="post">
            <h2 class="form-signin-heading">请 登 录</h2>
            <input type="text" class="form-control" placeholder="账号" name="username"/>
            <input type="password" class="form-control" placeholder="密码" name="password"/> 
            <button class="btn btn-lg btn-primary btn-block" type="submit">登录</button>
        </form>
    </div>
</body>
</html>

我们再来运行一下,得到如下图结果:


图1

发现与我们上一篇的博客运行的结果不一致了,css样式找不到了,为什么会这样呢?
因为Spring Boot默认扫描的Thymeleaf的模板路径为resources/templates/,而此时我们的index.html在webapp目录下。
接下来我们将index.html移到resources/templates/目录下,并再写个controller,将根目录的访问都重定向到resources/templates/index.html
LoginController代码:

@RequestMapping(value ="/", method = RequestMethod.GET)
String home() {
    return "index";
}

运行一下,结果正常
输入用户名及密码,后台也如期打印出

POJO: tech.onroad.springbootbase.bean.UserVO, hash code: 1537182416, userame: admin, password: 123456

1.3 th:object="${...}"与th:field="*{...}"的使用

${...}用于获取变量值,对于javaBean的话使用变量名.属性名,如${user.name}
举个例子,如若需要将后台的值回显到前台,那应该怎么做,此时th:object="${...}"与th:field="*{...}"就派上用场了。

<form class="form-signin" th:action="@{/login}" th:object="${user}" method="post">
    <h2 class="form-signin-heading">请 登 录</h2>
    <input type="text" class="form-control" placeholder="账号" th:field="*{username}"></input>
    <input type="password" class="form-control" placeholder="密码" th:field="*{password}"></input> 
    <button class="btn btn-lg btn-primary btn-block" type="submit">登录</button>
</form>

在表单代码中增加th:object属性,将name属性换成th:field属性,其中th:object定义表单数据提交对象user,用th:field定义表单数据属性,用*{}锁定上级定义的对象,{}内填写对象属性,提交表单时自动将属性值注入到对象中。
那前台如何知道th:object="${user}"与后台的哪个Java Bean对应呢?在controller代码里就可以看出端倪。

@RequestMapping(value ="/", method = RequestMethod.GET)
String home(Model model, UserVO user) {
    model.addAttribute("user", user);
    return "index";
}

@RequestMapping(value = "login", method = RequestMethod.POST)
public String login(Model model, UserVO user){
    System.out.println("POJO: " + user.getClass().getName() + 
            ", hash code: " + user.hashCode() + ", " + user.toString());
    model.addAttribute("user", user);
    return "index";
}

相比于前面的代码,我们多了model.addAttribute("user", user); 也就是说这个user对象是从后台通过Model传递过来的,当然也就能识别啦。
我们来运行一下,输入https://localhost:8443/SpringBootBase/得到如下界面:

图2

输入用户名admin及密码123456,点击登录,得到如下图结果


图3

发现浏览器地址栏的URL已经变为https://localhost:8443/SpringBootBase/login,且账户名admin还被显示着,说明我们的前台已能正确接收后台传递过来的变量值了。至于密码栏为什么被清空,那是因为密码框这个input的type="password"所致。

Thymeleaf模板引擎还有非常多的语法,如判断条件th:if, th:unless;th:inline,...... 以后若需要详细介绍及demo,再慢慢更新。

最后建议在application.properties配置关闭thymeleaf缓存,因为Spring Boot使用thymeleaf时默认是有缓存的,即你把一个页面代码改了不会刷新页面的效果,你必须重新运行spring-boot的main()方法才能看到页面更改的效果。

spring.thymeleaf.cache: false

完整代码可到我的github下载:
https://github.com/onroadtech/SpringbootBase/
tag: spring_boot_thymeleaf
commit-id: 35860470354212e14da0af993025b6555ff917ac


本博文已同步发表于我的个人博客网站,欢迎转载指正并注明出处。
个人博客: www.onroad.tech
指正邮箱: onroad_tech@163.com

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,392评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,258评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,417评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,992评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,930评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,199评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,652评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,327评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,463评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,382评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,432评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,118评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,704评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,787评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,999评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,476评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,057评论 2 341

推荐阅读更多精彩内容