Spring Boot使用Thymeleaf模板引擎渲染web视图

不念不忘少年蓝@ 2021-09-15 04:18 459阅读 0赞

# Spring Boot开发Web应用 #

**原创**

[2018-04-][]03

宗野

[Spring Boot][]

> [Spring Boot快速入门][Spring Boot 1]中我们完成了一个简单的RESTful Service，体验了快速开发的特性。在留言中也有朋友提到如何把处理结果渲染到页面上。那么本篇就在上篇基础上介绍一下如何进行Web应用的开发。
> 
> ## 静态资源访问 ##
> 
> 在我们开发Web应用的时候，需要引用大量的js、css、图片等静态资源。
> 
> ### 默认配置 ###
> 
> Spring Boot默认提供静态资源目录位置需置于classpath下，目录名需符合如下规则：
> 
>  *  /static
>  *  /public
>  *  /resources
>  *  /META-INF/resources
> 
> 举例：我们可以在`src/main/resources/`目录下创建`static`，在该位置放置一个图片文件。启动程序后，尝试访问`http://localhost:8080/D.jpg`。如能显示图片，配置成功。
> 
> ## 渲染Web页面 ##
> 
> 在之前的示例中，我们都是通过@RestController来处理请求，所以返回的内容为json对象。那么如果需要渲染html页面的时候，要如何实现呢？
> 
> ### 模板引擎 ###
> 
> 在动态HTML实现上Spring Boot依然可以完美胜任，并且提供了多种模板引擎的默认配置支持，所以在推荐的模板引擎下，我们可以很快的上手开发动态网站。
> 
> Spring Boot提供了默认配置的模板引擎主要有以下几种：
> 
>  *  Thymeleaf
>  *  FreeMarker
>  *  Velocity
>  *  Groovy
>  *  Mustache
> 
> Spring Boot建议使用这些模板引擎，避免使用JSP，若一定要使用JSP将无法实现Spring Boot的多种特性，具体可见后文：支持JSP的配置
> 
> 当你使用上述模板引擎中的任何一个，它们默认的模板配置路径为：`src/main/resources/templates`。当然也可以修改这个路径，具体如何修改，可在后续各模板引擎的配置属性中查询并修改。
> 
> #### Thymeleaf ####
> 
> Thymeleaf是一个XML/XHTML/HTML5模板引擎，可用于Web与非Web环境中的应用开发。它是一个开源的Java库，基于Apache License 2.0许可，由Daniel Fernández创建，该作者还是Java加密库Jasypt的作者。
> 
> Thymeleaf提供了一个用于整合Spring MVC的可选模块，在应用开发中，你可以使用Thymeleaf来完全代替JSP或其他模板引擎，如Velocity、FreeMarker等。Thymeleaf的主要目标在于提供一种可被浏览器正确显示的、格式良好的模板创建方式，因此也可以用作静态建模。你可以使用它创建经过验证的XML与HTML模板。相对于编写逻辑或代码，开发者只需将标签属性添加到模板中即可。接下来，这些标签属性就会在DOM（文档对象模型）上执行预先制定好的逻辑。
> 
> 示例模板：  
> 
> 
> ![70][]  
> 
> 
> 可以看到Thymeleaf主要以属性的方式加入到html标签中，浏览器在解析html时，当检查到没有的属性时候会忽略，所以Thymeleaf的模板可以通过浏览器直接打开展现，这样非常有利于前后端的分离。
> 
> 在Spring Boot中使用Thymeleaf，只需要引入下面依赖，并在默认的模板路径`src/main/resources/templates`下编写模板文件即可完成。
> 
> ![70 1][]  
> 
> 
> 在完成配置之后，举一个简单的例子，在快速入门工程的基础上，举一个简单的示例来通过Thymeleaf渲染一个页面。  
> 
> 
> ![70 2][]  
> 
> 
> ![70 3][]  
> 
> 
> 如上页面，直接打开html页面展现Hello World，但是启动程序后，访问`http://localhost:8080/`，则是展示Controller中host的值：`http://blog.didispace.com`，做到了不破坏HTML自身内容的数据逻辑分离。
> 
> 更多Thymeleaf的页面语法，还请访问Thymeleaf的官方文档查询使用。
> 
> Thymeleaf的默认参数配置
> 
> 如有需要修改默认配置的时候，只需复制下面要修改的属性到`application.properties`中，并修改成需要的值，如修改模板文件的扩展名，修改默认的模板路径等。
> 
> ![70 4][]  
> 
> 
> ### 支持JSP的配置 ###
> 
> Spring Boot并不建议使用，但如果一定要使用，可以参考此工程作为脚手架：[JSP支持][JSP]
> 
> 测试demo:
> 
> ![70 5][]  
> 
> 
> ![70 6][]  
> 
> 
> ![70 7][]  
> 
> 
> ![70 8][]  
> 
> 
> ![70 9][]  
> 
> 
> ![70 10][]  
> 
> 
> ![70 11][]  
>

[2018-04-]: http://blog.didispace.com/springbootweb/
[Spring Boot]: http://blog.didispace.com/categories/Spring-Boot/
[Spring Boot 1]: http://blog.didispace.com/spring-boot-learning-1/
[70]: /images/20210813/f3b0c942b25f4773a805aec4de79ce57.png
[70 1]: /images/20210813/5964b909f23f47e181633abbd896991e.png
[70 2]: /images/20210813/1a1c852c6e9a4d919c29d24de95745a2.png
[70 3]: /images/20210813/f5e607775bf4436fba3cc81075596641.png
[70 4]: /images/20210813/b17c65a93a7944d99b4abed21bdc6e99.png
[JSP]: https://github.com/spring-projects/spring-boot/tree/v1.3.2.RELEASE/spring-boot-samples/spring-boot-sample-web-jsp
[70 5]: /images/20210813/59d8d7971aa34764a92a44b18611827c.png
[70 6]: /images/20210813/b7a6560cdb2b4423bec5184414d71423.png
[70 7]: /images/20210813/ec8d7e709f674e2a931445669be1b8a7.png
[70 8]: /images/20210813/be23a46b502e4e048573438b7b00d8ac.png
[70 9]: /images/20210813/ca1b6df58c9b42408fdd8c377394d6de.png
[70 10]: /images/20210813/b5c2a6013ad3416ba7026d884e186f3e.png
[70 11]: /images/20210813/28a46d9afa1d4033b30a39169bcb2936.png