摘要:模板引擎是为了使用户界面与业务数据分离而产生的,它具有丰富的功能,可以生成特定格式的页面,在Web开发中的模板引擎最后会生成一个标准的HTML文档。模板引擎的解析过程如图4.1所示,其把数据和静态模板相互匹配后,数据会替换其中的变量,最后形成HTML页面展示给
模板引擎是为了使用户界面与业务数据分离而产生的,它具有丰富的功能,可以生成特定格式的页面,在Web开发中的模板引擎最后会生成一个标准的HTML文档。模板引擎的解析过程如图4.1所示,其把数据和静态模板相互匹配后,数据会替换其中的变量,最后形成HTML页面展示给用户。
对于模板引擎来说,将数据渲染到模板上通常需要以下几步:
(1)利用正则表达式分解出普通字符串和模板标识符。
(2)将模板标识符转换成普通的语言表达形式。
(3)生成待执行语句。
(4)将数据填入执行,生成最终的字符串。
目前,在Java开发中常用的模板引擎有Freemaker、Thymeleaf、JSP、JSF和Velocity,它们各有优缺点,本节将介绍不使用JSP的原因,然后再介绍如何使用Thymeleaf。
JSP全称为Java Server Pages,是Sun公司在HTML技术出现之后发布的一种全新的Java动态网页开发技术。它可以直接使用HTML代码,也可以在页面中插入Java代码,能非常方便地把动态数据渲染到静态页面上并最终展示给用户。
在项目开发中使用JSP有以下优点:
JSP的动态部分用Java编写,因此功能更加强大、易用,并且具有跨平台性,方便移植。
同时兼具了HTML和Java的优点,静态部分是HTML代码,动态部分由Java编写,支持多种网页格式。
可以完成很复杂的功能。
官方标准,用户群庞大,JSP标签可扩充,有非常丰富的第三方JSP标签库。
JSP可编译成class文件来执行,性能优异。
虽然JSP有以上5个优点,但是目前的项目开发中很少再使用JSP了,因为它的缺点也非常明显,主要有3个:
使用JSP增加了产品的复杂性。HTML的代码和Java代码全部混合在一起,有的开发人员甚至不需要专门的Java文件,全部代码都在.JSP中,一个JSP文件中动辄几万行代码,从而使后期的开发和维护成本非常高,甚至难以维护。
JSP页面最后都编译成了.class文件,全部内容都在内存中,非常消耗资源。
JSP页面调试困难,JSP页面在执行时都被编译为字节码文件,如果在一个页面上报错了,则需要一处一处地去修改、验证,非常烦琐。
在使用Spring Boot进行开发时,如果模板引擎选择JSP,那么在Tomcat中JSP是不能在嵌套的Tomcat容器中被解析和显示的,即不能在打包成可执行的jar的情况下解析出来,完成页面的显示。Jetty嵌套的容器不支持JSP,Spring官方不建议在项目中使用JSP开发。
因此,在使用Spring Boot进行开发时,一般不会选择JSP作为模板引擎。
Thymeleaf是Spring开发的一个现代的服务端Java模板引擎,适用于开发Web和独立环境项目的服务器端的模板引擎,能够快速地处理HTML元素、JavaScript元素和CSS元素的显示。
Thymeleaf为用户提供了一种优雅且高度可维护的模板创建方式。它以HTML页面为基础,在运行时将动态数据注入模板中并展示给用户。这种运行方式不会影响模板被用作设计原型,而且还提高了沟通效率。
Thymeleaf是专门为Web标准设计的,特别是最新的Web标准——HTML 5。
它还可以创建完全验证的模板,具有非常丰富的功能。在项目开发中将Spring Boot框架、Thymeleaf与Spring MVC的视图技术及Spring Boot的自动化配置集成在一起非常简便,不需要额外的配置,在开发中只需要关注Thymeleaf的语法即可。
下面新建第4章的项目chapter-4,演示在实际项目中怎么使用Thymeleaf开发页面。
(1)添加Thymeleaf依赖到pom.xml中,代码如下:
org.springframework.boot
spring-boot-starter-thymeleaf
spring-boot-starter-web
org.projectlombok
lombok
true
spring-boot-starter-test
test
(2)在application.properties中添加Thymeleaf配置文件:
#排除静态文件夹
spring.devtools.restart.exclude=static/**,public/**
#关闭 Thymeleaf 缓存开发过程中无须重启
spring.thymeleaf.cache = false
#设置thymeleaf页面的编码
spring.thymeleaf.encoding=UTF-8
spring.thymeleaf.mode=HTML5
#设置thymeleaf页面的后缀为.html
spring.thymeleaf.suffix=.html
#设置thymeleaf页面的存储路径
spring.thymeleaf.prefix=classpath:/templates/
(3)新建Controller包,在其中新建UserController类,添加addUser方法:
package com.example.thymeleafdemo.controller;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;@Controller
public class UserController {
@GetMapping("/addUser")
public String addUser(Model model){
model.addAttribute("title","i miss CC very much");
return "user/addUser";
}
}
在上述代码中,请求URL为/addUser,其会跳转到user目录下的addUSer.html页面,同时设置数据title为i miss CC very much。
(4)在resource/templates下新建一个user目录,然后再新建一个addUser.html文件,内容如下:
Insert title here
标题是:
hello
从上述代码中可以看出,Thymeleaf获取一个值的语法是th:text=${title}。
注意:在HTML页面中使用Thymeleaf时需要引入名称空间。例如:
(5)启动项目,在浏览器中访问localhost:8080/addUser,页面效果如图4.2所示。
前面的页面只演示了Thymeleaf最基本的取值,在实际开发中还有很多其他的数据格式,如List、Map、对象等。除此之外还有判断、时间格式化和循环处理等操作。下面一起来学习Thymeleaf的基础语法。
1. th属性
常用的th属性如表4.1所示。
2. ~{…} 代码块表达式
~{…}代码块表达式支持两种语法结构:~
{templatename::fragmentname}格式和{templatename::#id}。推荐使用前一种。
templatename:模板名,Thymeleaf会根据模板名解析完整的路径/resources/templates/templatename.html,使用时需要注意文件是相对路径还是绝对路径。
fragmentname:片段名,Thymeleaf通过th:fragment声明来定义代码块,即th:fragment= "fragmentname"。
id:HTML的ID选择器,使用时要在前面加上#号,其不支持class选择器。
代码块表达式需要配合th属性(th:insert、th:replace、th:include)一起使用。
th:insert:将整个代码块片段插入使用了th:insert的HTML标签中。
th:replace:将整个代码块片段替换为使用了th:replace的HTML标签内容。
th:include:将代码块片段包含的内容插入使用了th:include的HTML标签中。
3. #{…}消息表达式
#{…}消息表达式一般用于国际化场景。
4. @{…}链接表达式
@{…}链接表达式结构有两种形式:
无参:@{/xxx};
有参:@{/xxx(k1=v1,k2=v2)},对应url结构:xxx?k1=v1&k2=v2。@{…}链接表达式的主要目的是引入本地资源(@{/项目本地的资源路径})和外部资源(@{/webjars/资源在jar包中的路径})。
5. ${…}变量表达式
${…}变量表达式有3个功能:
获取对象的属性和方法;
使用Servlet的ctx、vars、locale、request、response、session和servletContext内置对象,能够获取文件路径和请求信息,设置环境变量等;
使用Thymeleaf的dates、numbers、strings、objects、arrays、lists、sets和maps等内置方法可以将返回的页面数据进行格式化并展示给用户。
其中,Thymeleaf常用的内置对象参见表4.2所示。
Thymeleaf模板中常用的内置方法如表4.3所示。
表4.3 常用的内置方法
介绍完Thymeleaf的常见语法和内置对象后,就能把数据很好地渲染到Thymeleaf模板上,最终展示给用户了。如果前端给出的是静态的HTML页面,则需要对HTML中的引用和头部信息进行修改,将其转换为Thymeleaf页面。
来源:程序员高级码农II一点号