Spring Boot学习笔记7:使用Thymeleaf模板引擎渲染web视图

Spring Boot学习笔记7:使用Thymeleaf模板引擎渲染web视图

  • 静态资源访问
    • 默认配置
  • 渲染Web页面
    • 模板引擎
  • Thymeleaf
    • 简单的示例
    • Thymeleaf的默认参数配置
  • GitHub示例

静态资源访问

在我们开发Web应用的时候,需要引用大量的js、css、图片等静态资源。

默认配置

Spring Boot默认提供静态资源目录位置需置于classpath下,目录名需符合如下规则:

  • /static
  • /public
  • /resources
  • /META-INF/resources
    举例:我们可以在src/main/resourcesstatic/目录下放置一个图片文件test.jpg。启动程序后,尝试访问http://localhost:8080/test.jpg。如能显示图片,配置成功。

渲染Web页面

在之前的学习笔记中,我们都是通过@RestController来处理请求,所以返回的内容为JSON对象。那么如果需要渲染html页面的时候,要如何实现呢?

模板引擎

在动态HTML实现上Spring Boot依然可以完美胜任,并且提供了多种模板引擎的默认配置支持,所以在推荐的模板引擎下,我们可以很快的上手开发动态网站。

Spring Boot提供了默认配置的模板引擎主要有以下几种:

  • Thymeleaf
  • FreeMarker
  • Velocity
  • Groovy
  • Mustache

Spring Boot建议使用这些模板引擎,避免使用JSP,若一定要使用JSP将无法实现Spring Boot的多种特性。

当使用上述模板引擎中的任何一个,它们默认的模板配置路径为: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(文档对象模型)上执行预先制定好的逻辑。

前端示例模板:

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

可以看到Thymeleaf主要以属性的方式加入到html标签中,浏览器在解析html时,当检查到没有的属性时候会忽略,所以Thymeleaf的模板可以通过浏览器直接打开展现,这样非常有利于前后端的分离。

简单的示例

举一个简单的示例来通过Thymeleaf渲染一个页面:

  • 在Spring Boot中使用Thymeleaf,需要引入下面依赖:
<dependency>
	<groupId>org.springframework.bootgroupId>
	<artifactId>spring-boot-starter-thymeleafartifactId>
dependency>
  • 新建一个Controller:
@Controller
public class HelloController {

    @RequestMapping("/")
    public String index(ModelMap map) {
    
        // 加入一个属性,用来在模板中读取
        map.addAttribute("msg", "Thymeleaf示例消息");
        
        // return模板文件的名称,对应src/main/resources/templates/index.html
        return "index";  
    }
}

在默认的模板路径src/main/resources/templates下编写模板文件index.html。 注意如果使用IDEA开发${msg}这里可能会标红。因为虽然在后端的Model数据中添加了,但是对于前端文件无法感知,这是IDEA目前的一个Bug。这里有几种处理方法:
- 在下注释
- 在添加属性xmlns:th="http://www.w3.org/1999/xhtml"
- 在${msg}上面注释
- 菜单栏中选择File=>Settings,搜索Thymeleaf选择Editor=>Inspections=>ThymeleafExpression variables validation取消勾选,点击OK确认。


<html>
	<head xmlns:th="http://www.w3.org/1999/xhtml">
    	<meta charset="UTF-8" />
    	<title>title>
	head>
	<body>
		<h1 th:text="${msg}">Hello Worldh1>
	body>
html>

如上页面,直接打开html页面展现Hello World,但是启动程序后,访问http://localhost:8080/,则是展示Controller中msg的值:Thymeleaf示例消息,做到了不破坏HTML自身内容的数据逻辑分离。

Thymeleaf的默认参数配置

如有需要修改默认配置的时候,只需复制下面要修改的属性到application.properties文件中,并修改成需要的值,如修改模板文件的扩展名,修改默认的模板路径等。

# 开启模板缓存
spring.thymeleaf.cache=true 
# 在呈现之前检查模板是否存在
spring.thymeleaf.check-template=true  
# 检查模板位置是否存在
spring.thymeleaf.check-template-location=true 
# Content-Type的值
spring.thymeleaf.content-type=text/html 
# 开启MVC Thymeleaf视图解析
spring.thymeleaf.enabled=true 
# 模板编码
spring.thymeleaf.encoding=UTF-8 
# 要被排除在解析之外的视图名称列表,用逗号分隔  
spring.thymeleaf.excluded-view-names= 
# 要运用于模板之上的模板模式。另见StandardTemplate-ModeHandlers
spring.thymeleaf.mode=HTML5 
# 在构建URL时添加到视图名称前的前缀
spring.thymeleaf.prefix=classpath:/templates/ 
# 在构建URL时添加到视图名称后的后缀
spring.thymeleaf.suffix=.html
# Thymeleaf模板解析器在解析器链中的顺序。默认情况下,它排第一位。顺序从1开始,只有在定义了额外的TemplateResolver Bean时才需要设置这个属性
spring.thymeleaf.template-resolver-order= 
# 可解析的视图名称列表,用逗号分隔 
spring.thymeleaf.view-names= 

GitHub示例

Springboot Study.

你可能感兴趣的:(Spring,Boot学习)