3-3. 使用Thymeleaf与Spring Boot

问题

你希望使用Thymeleaf来渲染你应用程序的页面。

解决方案

添加Thymeleaf的依赖，并创建一个@Controller来确定视图并填充模型。

它是如何工作的

要开始，你首先需要将spring-boot-starter-thymeleaf作为依赖项添加到你的项目中，以获取所需的Thymeleaf依赖项。

通过添加这个依赖项，您将同时获得Thymeleaf库以及Thymeleaf Spring方言，以便两者能够很好地集成。由于这两个库的存在，Spring Boot将自动配置ThymeleafViewResolver。ThymeleafViewResolver需要一个Thymeleaf ITemplateEngine才能解析和渲染视图。一个特殊的SpringTemplateEngine将预先配置有SpringDialect，这样您就可以在Thymeleaf页面中使用SpEL。

要添加其他Thymeleaf方言，您只需要创建一个@Bean方法，Spring Boot将自动检测并将其与Thymeleaf连接。有些甚至在与Spring Security集成时会自动配置（参见第5章）。

要配置Thymeleaf，Spring Boot在spring.thymeleaf命名空间中公开了几个属性（参见表3-2）。

添加一个索引页面

首先，在我们的应用程序中添加一个索引页面。在src/main/resources/templates目录（默认位置）内创建一个index.html文件。参见列表3-13。

这只是一个带有Thymeleaf一些小改动的基础HTML5页面。首先，有xmlns:th="http://www.thymeleaf.org"来启用Thymeleaf的命名空间。命名空间在链接中通过th:href使用。@{/books.html}部分将被Thymeleaf扩展成一个适当的链接，并放置在链接的实际href属性中。

现在，当运行应用程序时，你应该会看到一个带有指向书籍概览链接的页面（见图3-5）。

添加一个控制器和视图

当点击索引页面提供的链接时，我们希望看到一个页面，该页面显示图书馆中可用的书籍列表（见图3-6）。为此，需要添加两样东西：首先是一个可以处理请求并准备模型的控制器，其次是一个用于渲染书籍列表的视图。

让我们添加一个控制器，它将用书籍列表填充模型，并选择要渲染的视图名称。控制器是一个带有@Controller注解的类，其中包含处理请求的方法（带有@RequestMapping注解的方法，或者像本例中的@GetMapping，这是一个专门的@RequestMapping注解）。参见列表3-14。

BookController 需要 BookService 来获取书籍列表以展示。all 方法有一个参数是 org.springframework.ui.Model，这样我们就可以将书籍列表放入模型中。请求处理方法可以有不同的参数；其中一个就是 Model 类。在方法中，我们使用 BookService 从数据存储中检索所有书籍，并使用 model.addAttribute 将其添加到模型中。现在，书籍列表在模型中以键 books 可用。

最后，我们返回视图名称以渲染books/list。

现在控制器以及请求处理方法已经添加，

我们需要创建视图。在src/main/templates/books目录下创建一个list.html文件。参见列表3-15。

这又是一个使用Thymeleaf语法的HTML5页面。页面将使用th:each表达式渲染书籍列表。它将从模型中的books属性获取所有书籍，并为每本书创建一行。行中的每一列将使用th:text表达式包含一些文本；它将打印书籍的标题、作者和ISBN。表格的最后一列包含指向书籍详情的链接。它使用th:href表达式构建URL。注意括号之间的表达式；这将添加isbn请求参数。

当启动应用程序并点击索引页面上的链接时，您应该会看到一个显示图书馆内容的页面，如前面的图3-6所示。

添加详情页面

最后，当点击表格中的ISBN号码时，您希望显示一个包含详情的页面。链接包含一个名为isbn的请求参数，我们可以在控制器中检索并使用它来查找书籍。通过带有@RequestParam注解的方法参数可以检索请求参数。

以下方法将处理GET请求，将请求参数映射到方法参数，并包括模型，以便我们可以将书籍添加到模型中。

控制器将渲染书籍/详情页面。将details.html文件添加到src/main/resources/templates/books目录中。参见列表3-16。

这个HTML5 Thymeleaf模板将在页面上渲染两个可用块中的一个。如果找到了书籍，它将显示详细信息；如果没有找到，它将显示一个“未找到”的消息。这是通过使用th:if表达式实现的。"未找到"消息的isbn是从请求参数中检索的，使用param作为前缀；${param.isbn}将获取isbn请求参数。

测试一个@Controller

由于你希望确保控制器能够执行其应有的功能，编写一个测试来验证控制器的正确行为。参见列表3-17。

测试使用 @WebMvcTest 创建基于 MockMvc 的集成测试。它将创建一个最小的 Spring Boot 应用程序以便能够运行控制器。控制器需要一个 BookService 的实例，因此我们让框架使用 @MockBean 注解来创建一个模拟对象。在不同的测试方法中，我们模拟预期的行为（比如返回书籍列表，返回一个空的 Optional 等）。

Spring Boot 使用 Mockito 通过 @MockBean 创建模拟对象。

通过 Spring 测试框架的 MockMvc 支持，我们可以检查控制器是否返回了我们所期望的。我们可以检查 HTTP 状态，视图的名称，以及 Model 是否包含了正确的条目。