打开APP
userphoto
未登录

开通VIP,畅享免费电子书等14项超值服

开通VIP
Spring Boot 整合 Thymeleaf 完整 Web 案例

摘要: 原创出处:www.bysocket.com 泥瓦匠BYSocket 希望转载,保留摘要,谢谢!

Thymeleaf 是一种模板语言。那模板语言或模板引擎是什么?常见的模板语言都包含以下几个概念:数据(Data)、模板(Template)、模板引擎(Template Engine)和结果文档(Result Documents)。

  • 数据 数据是信息的表现形式和载体,可以是符号、文字、数字、语音、图像、视频等。数据和信息是不可分离的,数据是信息的表达,信息是数据的内涵。数据本身没有意义,数据只有对实体行为产生影响时才成为信息。

  • 模板 模板,是一个蓝图,即一个与类型无关的类。编译器在使用模板时,会根据模板实参对模板进行实例化,得到一个与类型相关的类。

  • 模板引擎 模板引擎(这里特指用于Web开发的模板引擎)是为了使用户界面与业务数据(内容)分离而产生的,它可以生成特定格式的文档,用于网站的模板引擎就会生成一个标准的HTML文档。

  • 结果文档 一种特定格式的文档,比如用于网站的模板引擎就会生成一个标准的HTML文档。

模板语言用途广泛,常见的用途如下:

  • 页面渲染

  • 文档生成

  • 代码生成

  • 所有 “数据+模板=文本” 的应用场景

这里案例用途自然是 页面渲染,下面在 Spring Boot 中整合 Thymeleaf 实现完整 Web 案例。

一、运行 chapter-2-spring-boot-quick-start

chapter-2-spring-boot-quick-start 工程用的是内存式数据库,不需要配置数据源。下载运行即可。

1. 下载工程

git clone 下载工程 springboot-learning-example ,项目地址见 GitHub:https://github.com/JeffLi1993/springboot-learning-example,即:

  1. git clone https://github.com/JeffLi1993/springboot-learning-example.git

2. 工程结构

用 IDEA 打开工程,可以看到子工程 chapter-2-spring-boot-quick-start ,其目录如下:

  1. ├── pom.xml

  2. └── src

  3.    ├── main

  4.       ├── java

  5.         └── spring

  6.             └── boot

  7.                 └── core

  8.                     ├── QuickStartApplication.java

  9.                     ├── domain

  10.                       ├── User.java

  11.                       └── UserRepository.java

  12.                     ├── service

  13.                       ├── UserService.java

  14.                       └── impl

  15.                           └── UserServiceImpl.java

  16.                     └── web

  17.                         └── UserController.java

  18.       └── resources

  19.           ├── application.properties

  20.           ├── static

  21.             ├── css

  22.               └── default.css

  23.             └── images

  24.                 └── favicon.ico

  25.           └── templates

  26.               ├── userForm.html

  27.               └── userList.html

  28.    └── test

  29.        └── java

  30.            └── spring

  31.                └── boot

  32.                    └── core

  33.                        ├── QuickStartApplicationTests.java

  34.                        └── domain

  35.                            └── UserRepositoryTests.java

对应目录:

  • org.spring.springboot.controller - Controller 层

  • org.spring.springboot.dao - 数据操作层 DAO

  • org.spring.springboot.domain - 实体类

  • org.spring.springboot.service - 业务逻辑层

  • Application - 应用启动类

  • application.properties - 应用配置文件

模板是会用到下面两个目录

  • static 目录是存放 CSS、JS 等资源文件

  • templates 目录是存放视图

3. 编译运行工程

在该工程根目录,运行 maven 指令进行编译:

  1. cd chapter-2-spring-boot-quick-start

  2. mvn clean install

编译工程成功后,右键运行名为 QuickStartApplication.java 应用启动类的 main 函数,然后浏览器访问 localhost:8080/users 即可: 用户列表页面: 

用户编辑页面: 

二、详解 chapter-2-spring-boot-quick-start

工程代码:

1. pom.xml Thymeleaf 依赖

使用模板引擎,就在 pom.xml 加入 Thymeleaf 组件依赖:

  1.    org.springframework.boot

  2.    spring-boot-starter-thymeleaf

Thymeleaf 是什么? Thymeleaf is a modern server-side Java template engine for both web and standalone environments.

Thymeleaf's main goal is to bring elegant natural templates to your development workflow — HTML that can be correctly displayed in browsers and also work as static prototypes, allowing for stronger collaboration in development teams.

Thymeleaf 是新一代 Java 模板引擎,在 Spring 4 后推荐使用。

整体个 pom.xml 配置如下:

  1. <>xml version='1.0' encoding='UTF-8'?>

  2. <> xmlns='http://maven.apache.org/POM/4.0.0' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'

  3.         xsi:schemaLocation='http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd'>

  4.    4.0.0

  5.    spring.boot.core

  6.    chapter-2-spring-boot-quick-start

  7.    0.0.1-SNAPSHOT

  8.    jar

  9.    chapter-2-spring-boot-quick-start

  10.    第二章快速入门案例

  11.    

  12.        org.springframework.boot

  13.        spring-boot-starter-parent

  14.        1.5.7.RELEASE

  15.    

  16.    

  17.        UTF-8

  18.        UTF-8

  19.        1.8

  20.    

  21.    

  22.        

  23.        

  24.            org.springframework.boot

  25.            spring-boot-starter-web

  26.        

  27.        

  28.        

  29.            org.springframework.boot

  30.            spring-boot-starter-test

  31.            test

  32.        

  33.        

  34.        

  35.            org.springframework.boot

  36.            spring-boot-starter-data-jpa

  37.        

  38.        

  39.        

  40.            com.h2database

  41.            h2

  42.            runtime

  43.        

  44.        

  45.        

  46.            org.springframework.boot

  47.            spring-boot-starter-thymeleaf

  48.        

  49.    

  50.    

  51.        

  52.            

  53.            

  54.                org.springframework.boot

  55.                spring-boot-maven-plugin

  56.            

  57.        

  58.    

2. Thymeleaf 依赖配置

在 Spring Boot 项目中加入 Thymeleaf 依赖,即可启动其默认配置。如果想要自定义配置,可以在 application.properties 配置如下:

  1. spring.thymeleaf.cache=true # Enable template caching.

  2. spring.thymeleaf.check-template=true # Check that the template exists before rendering it.

  3. spring.thymeleaf.check-template-location=true # Check that the templates location exists.

  4. spring.thymeleaf.enabled=true # Enable Thymeleaf view resolution for Web frameworks.

  5. spring.thymeleaf.encoding=UTF-8 # Template files encoding.

  6. spring.thymeleaf.excluded-view-names= # Comma-separated list of view names that should be excluded from resolution.

  7. spring.thymeleaf.mode=HTML5 # Template mode to be applied to templates. See also StandardTemplateModeHandlers.

  8. spring.thymeleaf.prefix=classpath:/templates/ # Prefix that gets prepended to view names when building a URL.

  9. spring.thymeleaf.reactive.max-chunk-size= # Maximum size of data buffers used for writing to the response, in bytes.

  10. spring.thymeleaf.reactive.media-types= # Media types supported by the view technology.

  11. spring.thymeleaf.servlet.content-type=text/html # Content-Type value written to HTTP responses.

  12. spring.thymeleaf.suffix=.html # Suffix that gets appended to view names when building a URL.

  13. spring.thymeleaf.template-resolver-order= # Order of the template resolver in the chain.

  14. spring.thymeleaf.view-names= # Comma-separated list of view names that can be resolved.

3. Thymeleaf 使用

Controller 如何将 View 指向 Thymeleaf

用户控制层代码如下:

  1. @Controller

  2. @RequestMapping(value = '/users')     // 通过这里配置使下面的映射都在 /users

  3. public class UserController {

  4.    @Autowired

  5.    UserService userService;          // 用户服务层

  6.    /**

  7.     *  获取用户列表

  8.     *    处理 '/users' 的 GET 请求,用来获取用户列表

  9.     *    通过 @RequestParam 传递参数,进一步实现条件查询或者分页查询

  10.     */

  11.    @RequestMapping(method = RequestMethod.GET)

  12.    public String getUserList(ModelMap map) {

  13.        map.addAttribute('userList', userService.findAll());

  14.        return 'userList';

  15.    }

  16.    /**

  17.     * 显示创建用户表单

  18.     *

  19.     */

  20.    @RequestMapping(value = '/create', method = RequestMethod.GET)

  21.    public String createUserForm(ModelMap map) {

  22.        map.addAttribute('user', new User());

  23.        map.addAttribute('action', 'create');

  24.        return 'userForm';

  25.    }

  26.    /**

  27.     *  创建用户

  28.     *    处理 '/users' 的 POST 请求,用来获取用户列表

  29.     *    通过 @ModelAttribute 绑定参数,也通过 @RequestParam 从页面中传递参数

  30.     */

  31.    @RequestMapping(value = '/create', method = RequestMethod.POST)

  32.    public String postUser(@ModelAttribute User user) {

  33.        userService.insertByUser(user);

  34.        return 'redirect:/users/';

  35.    }

  36.    /**

  37.     * 显示需要更新用户表单

  38.     *    处理 '/users/{id}' 的 GET 请求,通过 URL 中的 id 值获取 User 信息

  39.     *    URL 中的 id ,通过 @PathVariable 绑定参数

  40.     */

  41.    @RequestMapping(value = '/update/{id}', method = RequestMethod.GET)

  42.    public String getUser(@PathVariable Long id, ModelMap map) {

  43.        map.addAttribute('user', userService.findById(id));

  44.        map.addAttribute('action', 'update');

  45.        return 'userForm';

  46.    }

  47.    /**

  48.     * 处理 '/users/{id}' 的 PUT 请求,用来更新 User 信息

  49.     *

  50.     */

  51.    @RequestMapping(value = '/update', method = RequestMethod.POST)

  52.    public String putUser(@ModelAttribute User user) {

  53.        userService.update(user);

  54.        return 'redirect:/users/';

  55.    }

  56.    /**

  57.     * 处理 '/users/{id}' 的 GET 请求,用来删除 User 信息

  58.     */

  59.    @RequestMapping(value = '/delete/{id}', method = RequestMethod.GET)

  60.    public String deleteUser(@PathVariable Long id) {

  61.        userService.delete(id);

  62.        return 'redirect:/users/';

  63.    }

  64. }

ModelMap 对象来进行数据绑定到视图。return 字符串,该字符串对应的目录在 resources/templates 下的模板名字。 @ModelAttribute 注解是用来获取页面 Form 表单提交的数据,并绑定到 User 数据对象。

Form 表单页面

核心代码:

  1. <> th:action='@{/users/{action}(action=${action})}' method='post' class='form-horizontal'>

  2.                <> type='hidden' name='id' th:value='${user.id}'/>

  3.                <> class='form-group'>

  4.                    <> for='user_name' class='col-sm-2 control-label'>名称

  5.                    <> class='col-xs-4'>

  6.                        <> type='text' class='form-control' id='user_name' name='name' th:value='${user.name}' />

  7.                    

  •                

  •                <> class='form-group'>

  •                    <> for='user_age' class='col-sm-2 control-label'>年龄:

  •                    <> class='col-xs-4'>

  •                        <> type='text' class='form-control' id='user_age' name='age' th:value='${user.age}'/>

  •                    

  •                

  •                <> class='form-group'>

  •                    <> for='user_birthday' class='col-sm-2 control-label'>出生日期:

  •                    <> class='col-xs-4'>

  •                        <> type='date' class='form-control' id='user_birthday' name='birthday' th:value='${user.birthday}'/>

  •                    

  •                

  •                <> class='form-group'>

  •                    <> class='col-sm-offset-2 col-sm-10'>

  •                        <> class='btn btn-primary' type='submit' value='提交'/>  

  •                        <> class='btn' type='button' value='返回' onclick='history.back()'/>

  •                    

  •                

  •            

  • 这里定义了一个 Form 表单用于新增或者更新用户。

    列表页面

    代码如下:

    1. <> class='table table-hover table-condensed'>

    2.                

    3.                    用户列表

    4.                

    5.                

    6.                    

    7.                        用户编号

    8.                        名称

    9.                        年龄

    10.                        出生时间

    11.                        管理

    12.                    

    13.                

    14.                

    15.                    <> th:each='user : ${userList}'>

    16.                        <> scope='row' th:text='${user.id}'>

    17.                        <> th:href='@{/users/update/{userId}(userId=${user.id})}' th:text='${user.name}'>

    18.                        <> th:text='${user.age}'>

    19.                        <> th:text='${user.birthday}'>

    20.                        <> class='btn btn-danger' th:href='@{/users/delete/{userId}(userId=${user.id})}'>删除

    21.                    

    22.                

    23.            

    这里循环了用户列表。

    Tymeleaf 的语法糖

    我这边也就不详细展开了,大家看看人家写的 http://www.cnblogs.com/nuoyiamy/p/5591559.html 或者看看官方文档 http://www.thymeleaf.org/documentation.html

    三、本文小结

    该文,利用 Thymeleaf 做了个 Web 的 CRUD 案例。大家多指教~

    如以上文章或链接对你有帮助的话,别忘了在文章结尾处评论哈~ 你也可以点击页面右边“分享”悬浮按钮哦,让更多的人阅读这篇文章。


    还有,扫扫一起交流学习:


    本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请点击举报
    打开APP,阅读全文并永久保存 查看更多类似文章
    猜你喜欢
    类似文章
    【热】打开小程序,算一算2024你的财运
    Thymeleaf系列一 Spring boot 集成Thymeleaf
    Spring Boot中使用Redis数据库
    SpringBoot2.0 监听器ApplicationListener的使用
    Spring4新特性:
    Spring Boot使用Spring Security实现权限控制
    利用 Spring Boot 设计风格良好的Restful API及错误响应
    更多类似文章 >>
    生活服务
    热点新闻
    分享 收藏 导长图 关注 下载文章
    绑定账号成功
    后续可登录账号畅享VIP特权!
    如果VIP功能使用有故障,
    可点击这里联系客服!

    联系客服