SpringBoot中的Thymeleaf用法

发布时间 - 2026-01-11 01:16:55    点击率:

Thymeleaf

Thymeleaf是最近SpringBoot推荐支持的模板框架,官网在thymeleaf.org这里。

我们为什么要用Thymeleaf来作为模板引擎呢?官网给了我们一个非常令人信服的解释:

Thymeleaf is a modern server-side Java template engine for both web and standalone environments.>

基本写法就像下面这样:

<table>
 <thead>
 <tr>
  <th th:text="#{msgs.headers.name}">Name</th>
  <th th:text="#{msgs.headers.price}">Price</th>
 </tr>
 </thead>
 <tbody>
 <tr th:each="prod: ${allProducts}">
  <td th:text="${prod.name}">Oranges</td>
  <td th:text="${#numbers.formatDecimal(prod.price, 1, 2)}">0.99</td>
 </tr>
 </tbody>
</table>

没错,由于这个模板是以xml的格式以属性的形式嵌入在html里,因此不仅适合后台人员使用,也能直接在没有后台程序的情况下直接由浏览器渲染,因为浏览器会自动忽视html未定义的属性。

这个属性还是非常吸引人的,毕竟我们做后台最麻烦的就是在乱七八糟的前台模板加代码,加完代码之后前台的也不知道加的代码对不对,非得先跑一遍才能知道。如果模板文件能够直接由前端人员编写那该多好,而且前端人员在编写的时候就能知道这个代码能不能跑,岂不是非常开心?

参考文档

Thymeleaf的文档链接在这里,细节可以直接去搜索,下面主要列举下我经常遇到的一些问题。

模板定义

由于我们很多的IDE都会提供很好的提示工作,因此我们有必要告诉IDE我们使用的模板规范以方便他给我们提供服务。Thymeleaf的一般规范是这样的:

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

把我们需要编写的DOM放在这个html标签里面就好了。
这句话做了什么事呢?其实就是定义了一个叫th的名空间,所有Thymeleaf的属性都是在这个名空间下面。

静态文件的加载

我们知道一个网页中加载的静态文件通常有一个十分尴尬的问题,比如对于bootstrap.css,就是如果我们能让IDE识别这个文件,那么我们得用相对路径来引入这个文件。这样我们的IDE才能加载到这个文件,并且给予我们相应的提示。但是如果我们想要在发布后服务器能够加载这个文件,我们就必须用相对于resources或者static的位置来引入静态文件。显然,一般情况下我们不能兼顾这两个问题,只能要么在编写的时候用相对自己的路径,然后在发布的时候用相对于项目资源文件夹的路径,要么就只能放弃IDE的提示,非常尴尬。

而在Thymeleaf中,我们可很好的处理这一点。在引入资源的时候,我们可以写类似下面的代码:

<link rel="stylesheet" type="text/css" media="all" 
   href="../../css/gtvg.css" rel="external nofollow" th:href="@{/css/gtvg.css}" rel="external nofollow" />

当我们在没有后台渲染的情况下,浏览器会认得href,但是不认得th:href,这样它就会选择以相对与本文件的相对路径去加载静态文件。而且我们的IDE也能识别这样的加载方式,从而给我们提示。

当我们在有后台渲染的情况下,后台会把这个标签渲染为这样:

<link rel="stylesheet" type="text/css" media="all" href="/css/gtvg.css" rel="external nofollow" />

原来的href标签会被替换成相对于项目的路径,因此服务器就能找到正确的资源,从而正确渲染。

非常的智能而且方便。

这里需要注意到所有的路径我们是用”@{}”来引用,而不是”${}”,因为后者是用来引用变量名的,而前者是引用路径的,因此我们在这里用的是前者。可是如果我们是把路径写在变量里,那么就要用后者来引用了。

常量的渲染以及文字国际化

很多情况下我们并不希望在代码里硬编码进文字,我们希望把文字提取成统一的代号,这样方便管理,也方便更改语言。
我们要做的首先是创建一个语言文件,比如message_chinese.properties:

title=这是标题
message1=这是消息2
message2=这是消息2
....

然后我们在application.properties里加上下面这行注册这个语言文件:

spring.messages.basename=message_chinese

这样,我们在模板里就可以通过#{消息名}来获取这个消息对应的真正的文字:

<title th:text="#{title}"></title>

变量的渲染

对于一个模板文件来说,最重要的事情莫过与传递变量了。

这件事情非常简单,主要分为两步,首先是在SpringBoot的Controller里给Model传进参数:

@Controller
public class IndexController {
 @RequestMapping(path = {"index", "/"}, method = {RequestMethod.GET})
 public String index(Model model) {
 
  model.addAttribute("var1", "value1");
  model.addAttribute("src1", "https://www.baidu.com");
  
  Map<String,Object> map=new HashMap<>();
  map.put("src1","/a.png");
  map.put("src2","/b.png");
  model.addAttribute("src", map);
  return "index";
 }
}

这样我们就可以在模板里通过th:属性名="${变量名}"这种方式来传值,比如:

<span th:text="${var1}"></span>
<a th:href="${src1}" rel="external nofollow" >baidu</a>
<img th:src="${src.src1}" />

定义十分清楚,也很容易类比,支持层次选择,不再细说。

循环语句

当我们需要动态加载一些帖子的时候,我们经常需要用循环语句,Thymeleaf中循环语句也很简单,主要是依靠th:each这玩意来实现。

首先我们当然是在Controller里创建可供循环的List对象并传递给model:

@Controller
public class IndexController {
 @RequestMapping(path = {"index", "/"}, method = {RequestMethod.GET})
 public String index(Model model) {
 
  List<String> list=new ArrayList<>();
  for(int i=0;i<10;i++){
   list.add(String.valueOf(i));
  }
  model.addAttribute("list", list);
  return "index";
 }
}

然后在需要循环的地方这样使用:

<div th:each="value:${list}" th:text="${value}"></div>

就能循环渲染这个list里的元素了。

激活语句

所谓的激活语句(自己起得名字),就是在某些情况下我们想根据变量的值来选择到底显示还是不显示这个标签。用法也很见简单,主要靠th:if跟th:unless:

<div th:if="${judge}" >if clause</div>
<div th:unless="${judge}" >unless clause</div>

通过判断judge这个变量是否不为空来控制这个标签是否显示。。。if跟unless互为反义词。。。不解释了。。。

选择语句

类似于switch-case语句,非常简单,见下例:

<div th:switch="${user.role}">
 <p th:case="'admin'">User is an administrator</p>
 <p th:case="#{roles.manager}">User is a manager</p>
</div>

这段代码顺便体现了一个小细节,如果想在th名空间里直接填入字符串,我们必须再用一对引号来引用。。。

代码分割引用

thymeleaf也提供了类似import的东西,可以将很多代码块抽象成模块,然后在需要的时候引用,非常方便。具体的说,引用方式有两种–replace和include。

比如有两个文件

<!--footer.html-->
<div th:fragment="copy">footer</div>
<!--index.html-->
<div th:include="footer :: copy">index</div>

通过这样,我们就可以在index里面引用footer里面的这个div,我们用的是include,因此渲染的结果就是这样:

<div>
 <div th:fragment="copy">footer</div>
</div>

如果是replace,那就是整个标签的替换,很好理解。

当然,除了用fragment来标识引用的部分,我们还可以用id来引用,具体可以参考文档。

有时候我们可能希望在引用的时候传递参数,我们可以在引用时加上这样的参数:

<!--index.html-->
<div th:include="footer :: copy" th:with="param=${value}" >index</div>

这样我们就可以把index页面的value变量传递到footer页面里。非常简单。

引用js的坑

有时候我们想用js变量来保存模板传递的参数,我们可以这样来引用:

<script th:inline="javascript">
/*<![CDATA[*/
 ...
 var username = /*[[${session.user.name}]]*/ 'Sebastian';
 ...
/*]]>*/
</script>

注意,这是官方推荐的写法,注意以下几点。

我们要用inline来指定这个script标签;

我们需要注释<![CDATA[,]]>对,否则就会无法在js中使用比较符号;

我们要用[[${value}]]来引用模板变量;

我们要在变量外面也套上注释\**\,并在后面添加上默认的值,这是为了前端开发人员能在没有后台的情况下正常渲染。

最后

当前我遇到的基本上靠上面的知识都足以解决了,更多高级用法可以直接读文档,到时候用到再来添加0.0。

以上所述是小编给大家介绍的SpringBoot中的Thymeleaf用法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对网站的支持!


# spring  # boot  # thymeleaf  # springboot整合shiro之thymeleaf使用shiro标签的方法  # Spring Boot 整合 Shiro+Thymeleaf过程解析  # springboot+thymeleaf+shiro标签的实例  # 这是  # 加载  # 情况下  # 要用  # 很好  # 就能  # 我们可以  # 就可以  # 也很  # 的是  # 当我们  # 相对于  # 就会  # 文档  # 是在  # 也能  # 可以直接  # 小编  # 里加  # 官网 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel如何创建自定义Facades?(详细步骤)  高端企业智能建站程序:SEO优化与响应式模板定制开发  瓜子二手车官方网站在线入口 瓜子二手车网页版官网通道入口  如何在阿里云ECS服务器部署织梦CMS网站?  Laravel怎么实现模型属性转换Casting_Laravel自动将JSON字段转为数组【技巧】  如何用AWS免费套餐快速搭建高效网站?  laravel怎么实现图片的压缩和裁剪_laravel图片压缩与裁剪方法  如何快速查询域名建站关键信息?  微信小程序制作网站有哪些,微信小程序需要做网站吗?  Python自然语言搜索引擎项目教程_倒排索引查询优化案例  免费制作统计图的网站有哪些,如何看待现如今年轻人买房难的情况?  如何在阿里云通过域名搭建网站?  Laravel如何安装使用Debugbar工具栏_Laravel性能调试与SQL监控插件【步骤】  Laravel怎么配置不同环境的数据库_Laravel本地测试与生产环境动态切换【方法】  米侠浏览器网页背景异常怎么办 米侠显示修复  php读取心率传感器数据怎么弄_php获取max30100的心率值【指南】  详解jQuery中的事件  Laravel如何集成微信支付SDK_Laravel使用yansongda-pay实现扫码支付【实战】  焦点电影公司作品,电影焦点结局是什么?  猪八戒网站制作视频,开发一个猪八戒网站,大约需要多少?或者自己请程序员,需要什么程序员,多少程序员能完成?  香港代理服务器配置指南:高匿IP选择、跨境加速与SEO优化技巧  大连企业网站制作公司,大连2025企业社保缴费网上缴费流程?  详解jQuery停止动画——stop()方法的使用  Java类加载基本过程详细介绍  Laravel怎么实现支付功能_Laravel集成支付宝微信支付  Laravel项目结构怎么组织_大型Laravel应用的最佳目录结构实践  Laravel怎么实现搜索高亮功能_Laravel结合Scout与Algolia全文检索【实战】  如何在Tomcat中配置并部署网站项目?  HTML透明颜色代码怎么让图片透明_给img元素加透明色的技巧【方法】  Linux系统运维自动化项目教程_Ansible批量管理实战  关于BootStrap modal 在IOS9中不能弹出的解决方法(IOS 9 bootstrap modal ios 9 noticework)  INTERNET浏览器怎样恢复关闭标签页_INTERNET浏览器标签恢复快捷键与方法【指南】  Chrome浏览器标签页分组怎么用_谷歌浏览器整理标签页技巧【效率】  1688铺货到淘宝怎么操作 1688一键铺货到自己店铺详细步骤  如何正确选择百度移动适配建站域名?  微信小程序 require机制详解及实例代码  Laravel用户密码怎么加密_Laravel Hash门面使用教程  Laravel如何生成和使用数据填充?(Seeder和Factory示例)  公司门户网站制作公司有哪些,怎样使用wordpress制作一个企业网站?  Laravel如何使用Eloquent进行子查询  nginx修改上传文件大小限制的方法  Python文本处理实践_日志清洗解析【指导】  手机怎么制作网站教程步骤,手机怎么做自己的网页链接?  Laravel怎么多语言本地化设置_Laravel语言包翻译与Locale动态切换【手册】  制作公司内部网站有哪些,内网如何建网站?  如何彻底删除建站之星生成的Banner?  javascript日期怎么处理_如何格式化输出  如何用西部建站助手快速创建专业网站?  如何用手机制作网站和网页,手机移动端的网站能制作成中英双语的吗?  韩国服务器如何优化跨境访问实现高效连接?