一起来学SpringBoot | 第四篇：整合Thymeleaf模板

迈不过友情╰ 2022-05-23 03:56 169阅读 0赞

>  *  \*\*本文作者：\*\*唐亚峰

*  **本文链接：**[http://blog.battcn.com/2018/04/28/springboot/v2-web-thymeleaf/][http_blog.battcn.com_2018_04_28_springboot_v2-web-thymeleaf]
 *  \*\*版权声明：\*\*本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

--------------------

## 强烈推荐 ##

分享一个大神的人工智能教程。零基础！通俗易懂！风趣幽默！还带黄段子！希望你也加入到人工智能的队伍中来！[http://www.captainbed.net][http_www.captainbed.net]

> `SpringBoot`是为了简化`Spring`应用的创建、运行、调试、部署等一系列问题而诞生的产物，**`自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程`**

\#\#更多干货：  
[SpringBoot系列博客目录，含1.5.X版本和2.X版本][SpringBoot_1.5.X_2.X]

在前面几章中已经介绍了如何创建一个`SpringBoot`项目，同时简单的描述了`SpringBoot REST Web服务`。除此之外它也是支持如`JSP`、`Thymeleaf`、`FreeMarker`、`Mustache`、`Velocity`等各种模板引擎，同时还为开发者提供了自定义模板扩展的支持。

> 使用嵌入式Servlet容器时，请避免使用JSP，因为使用JSP打包后会存在一些限制。

在`SpringBoot`使用上述模板，默认从\*\*`src/main/resources/templates`\*\*下加载。

## thymeleaf介绍 ##

`Thymeleaf`是现代化服务器端的Java模板引擎，不同与其它几种模板的是`Thymeleaf`的语法更加接近HTML，并且具有很高的扩展性。详细资料可以浏览[官网][Link 1]。

> 特点

*  支持无网络环境下运行，由于它支持 html 原型，然后在 html 标签里增加额外的属性来达到模板+数据的展示方式。浏览器解释 html 时会忽略未定义的标签属性，所以 thymeleaf 的模板可以静态地运行；当有数据返回到页面时，Thymeleaf 标签会动态地替换掉静态内容，使页面动态显示。所以它可以让前端小姐姐在浏览器中查看页面的静态效果，又可以让程序员小哥哥在服务端查看带数据的动态页面效果。
 *  开箱即用，为`Spring`提供方言，可直接套用模板实现`JSTL、 OGNL`表达式效果，避免每天因套用模板而修改`JSTL、 OGNL`标签的困扰。同时开发人员可以扩展自定义的方言。
 *  `SpringBoot`官方推荐模板，提供了可选集成模块(`spring-boot-starter-thymeleaf`)，可以快速的实现表单绑定、属性编辑器、国际化等功能。

## 使用 ##

首先要在`pom.xml`中添加对`thymeleaf`模板依赖

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

然后创建一个`ThymeleafController`用来映射HTTP请求与页面的跳转，下面写了两种方式，第一种比较直观和优雅，第二种相对普遍且代码较少，且迎合从`struts2`跳坑的朋友们…

*  **Spring4.3以后为简化@RequestMapping(method = [RequestMethod.XXX][])的写法，故而将其做了一层包装，也就是现在的`GetMapping`、`PostMapping`、`PutMapping`、`DeleteMapping`、`PatchMapping`**

package com.battcn.controller;
    
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.servlet.ModelAndView;
    import javax.servlet.http.HttpServletRequest;
    
    /** * @author Levin * @since 2018/4/23 0023 */
    @Controller
    @RequestMapping
    public class ThymeleafController { 
    
        @GetMapping("/index")
        public ModelAndView index() { 
            ModelAndView view = new ModelAndView();
            // 设置跳转的视图 默认映射到 src/main/resources/templates/{viewName}.html
            view.setViewName("index");
            // 设置属性
            view.addObject("title", "我的第一个WEB页面");
            view.addObject("desc", "欢迎进入Luis-web 系统");
            Author author = new Author();
            author.setAge(24);
            author.setEmail("1085143002@qq.com");
            author.setName("Luis");
            view.addObject("author", author);
            return view;
        }
    
        @GetMapping("/index1")
        public String index1(HttpServletRequest request) { 
            // TODO 与上面的写法不同，但是结果一致。
            // 设置属性
            request.setAttribute("title", "我的第一个WEB页面");
            request.setAttribute("desc", "欢迎进入Luis-web 系统");
            Author author = new Author();
            author.setAge(24);
            author.setEmail("1085143002@qq.com");
            author.setName("Luis");
            request.setAttribute("author", author);
            // 返回的 index 默认映射到 src/main/resources/templates/xxxx.html
            return "index";
        }
    
        class Author { 
            private int age;
            private String name;
            private String email;
            // 省略 get set
        }
    }

最后在`src/main/resources/templates`目录下创建一个名`index.html`的模板文件，可以看到`thymeleaf`是通过在标签中添加额外属性动态绑定数据的

<!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="http://www.thymeleaf.org">
    <head>
        <meta charset="UTF-8">
        
        <title th:text="${title}">Title</title>
        
        <script type="text/javascript" th:src="@{/js/hello.js}"></script>
    </head>
    <body>
        <h1 th:text="${desc}">Hello World</h1>
        <h2>=====作者信息=====</h2>
            <p th:text="${author?.name}"></p>
            <p th:text="${author?.age}"></p>
            <p th:text="${author?.email}"></p>
    </body>
    </html>

> 静态效果

双击打开`index.html`既可以看到如下的静态效果，并未和其它模板一样显示一堆标签的内容，而是正常渲染静态页面

![静态效果][WX20180601-130644_2x.png]

> 动态效果

在浏览器输入：[http://localhost:8080/index][http_localhost_8080_index]可以看到渲染后的效果，真正意义上的动静分离了

![动态效果][WX20180601-130427_2x.png]

> 模板热部署

在`IntelliJ IDEA`中使用`thymeleaf`模板的时候，发现每次修改静态页面都需要重启才生效，这点是很不友好的，百度了下发现原来是默认配置搞的鬼，为了提高响应速度，默认情况下会缓存模板。如果是在开发中请**将`spring.thymeleaf.cache 属性设置成 false`**。在每次修改静态内容时\*\*按`Ctrl+Shift+F9`\*\*即可重新加载了…

> 修改默认`favicon.ico`图标

默认情况下使用`springboot`总能看到一片叶子，这是因为我们没配置自己的ico导致的，解决方法也很简单，只需要在`src/main/static/`目录下放置一张名为`favicon.ico`就可以了

## 默认配置 ##

`SpringBoot`默认情况下为我们做了如下的默认配置工作，熟悉默认配置在开发过程中可以更好的解决问题

![SpringBoot为thymeleaf模板提供的默认配置项][SpringBoot_thymeleaf]

## 总结 ##

Thymeleaf参考手册：[https://blog.csdn.net/zrk1000/article/details/72667478][https_blog.csdn.net_zrk1000_article_details_72667478]

WEB MVC详细的内容请参考官方文档：[https://docs.spring.io/spring/docs/5.0.5.RELEASE/spring-framework-reference/web.html\#mvc][https_docs.spring.io_spring_docs_5.0.5.RELEASE_spring-framework-reference_web.html_mvc]

目前很多大佬都写过关于\*\*`SpringBoot`\*\*的教程了，如有雷同，请多多包涵，本教程基于最新的`spring-boot-starter-parent：2.0.1.RELEASE`编写，包括新版本的特性都会一起介绍…

## 说点什么 ##

springboot技术交流群：681513531

个人博客：[https://winterchen.com][https_winterchen.com]

全文代码：[https://github.com/WinterChenS/springboot-learning-experience][https_github.com_WinterChenS_springboot-learning-experience]

*  \*\*本文作者：\*\*唐亚峰
 *  **本文链接：**[http://blog.battcn.com/2018/04/28/springboot/v2-web-thymeleaf/][http_blog.battcn.com_2018_04_28_springboot_v2-web-thymeleaf]
 *  \*\*版权声明：\*\*本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

[http_blog.battcn.com_2018_04_28_springboot_v2-web-thymeleaf]: http://blog.battcn.com/2018/04/28/springboot/v2-web-thymeleaf/
[CC BY-NC-SA 3.0]: https://creativecommons.org/licenses/by-nc-sa/3.0/
[http_www.captainbed.net]: http://www.captainbed.net/luischen
[SpringBoot_1.5.X_2.X]: https://blog.csdn.net/Winter_chen001/article/details/80537829
[Link 1]: https://www.thymeleaf.org/
[RequestMethod.XXX]: http://RequestMethod.XXX
[WX20180601-130644_2x.png]: /images/20220523/913118df67e849598625a71a77ebb8be.png
[http_localhost_8080_index]: http://localhost:8080/index
[WX20180601-130427_2x.png]: /images/20220523/cc117168594b41038afb22cd95f90728.png
[SpringBoot_thymeleaf]: /images/20220523/08355a5a7b3a441d9a448faa6f54da44.png
[https_blog.csdn.net_zrk1000_article_details_72667478]: https://blog.csdn.net/zrk1000/article/details/72667478
[https_docs.spring.io_spring_docs_5.0.5.RELEASE_spring-framework-reference_web.html_mvc]: https://docs.spring.io/spring/docs/5.0.5.RELEASE/spring-framework-reference/web.html#mvc
[https_winterchen.com]: https://winterchen.com
[https_github.com_WinterChenS_springboot-learning-experience]: https://github.com/WinterChenS/springboot-learning-experience