spring boot用ModelAndView向Thymeleaf模板传参数

    最近在调试一个Spring Boot向Thymeleaf模板传参数的例子，但踩了很多坑，这里就把详细过程记录下来，以供大家参考。

    首先创建一个名为ModelAndViewDemo的Maven项目里，而在下表里，给出了重要文件的说明。

重要文件	说明
pom.xml	引入了该项目所用到的依赖包，尤其地，引入了Thymeleaf的依赖包
SpringBootApp.java	启动类
Controller.java	控制器类，在其中通过ModelAndView对象和前端Thymeleaf交互
Application.properties	配置文件，其中包含了Thymeleaf的相关配置
hello.html	包含Thymeleaf模板的前端页面文件，请注意它是在resources目录的templates目录里，这个目录结构需要和配置文件里的配置保持一致

    第一步，在pom.xml里，包含本项目的依赖包，关键代码如下所示。其中，通过第6行到第9行的代码，引入了thymeleaf模板的依赖包。 

1  
2	        
3	            org.springframework.boot
4	            spring-boot-starter-web
5	        
6	        
7	            org.springframework.boot            
8	spring-boot-starter-thymeleaf
9	        
10	    

    第二步，编写启动类。    

1	package prj;
2	import org.springframework.boot.SpringApplication;
3	import org.springframework.boot.autoconfigure.SpringBootApplication;
4	@SpringBootApplication
5	public class SpringBootApp {
6	    public static void main(String[] args) {
7	        SpringApplication.run(SpringBootApp.class, args);
8	    }
9	}

    第三步，编写控制器类，代码如下所示。        

1	package prj.controller;
2	import org.springframework.web.bind.annotation.RequestMapping;
3	import org.springframework.web.bind.annotation.RestController;
4	import org.springframework.web.servlet.ModelAndView;
5	@RestController
6	public class Controller {
7	    @RequestMapping("/welcome")
8	    public ModelAndView welcome() {
9	        ModelAndView modelAndView = new ModelAndView("hello");
10	        modelAndView.getModel().put("name", "Tom");
11	        return modelAndView;
12	    }
13	}

    在第8行的welcome方法里，先是在第9行创建了ModelAndView类型的对象，并通过构造函数，指定该对象里的视图为“hello”，随后通过第10行的代码，在该对象的Model里，以键值对的形式，添加了键是name值是Tom的数据。结合起来看，welcome方法将向hello视图返回一个键值对数据。

    第四步，在application.properties里，编写thymeleaf模板的相关参数，具体代码如下。    

1	#启用thymeleaf视图
2	spring.thymeleaf.enabled=true
3	#设置Content-Type值
4	spring.thymeleaf.content-type=text/html
5	## 检查模板是否存在，然后再呈现
6	spring.thymeleaf.check-template-location=true
7	# 不启用缓存
8	spring.thymeleaf.cache=false
9	# 构建前缀
10	spring.thymeleaf.prefix=classpath:/templates/
11	# 构建后缀
12	spring.thymeleaf.suffix=.html

    在对应的参数项前都有注释，大家可以自行阅读，不过这里有如下两大注意点。

1. 为了要使用thymeleaf视图，必须要配置如第2行所示的参数。
2. 第10行和第12行定义的前缀和后缀，会和ModelAndView对象里的视图整合起来使用。比如在Controller.java里，ModelAndView里返回的视图是hello,所以会对应地加上前后缀，加号以后的值是classpath:/templates/hello.html，这样能指定最终跳转到的视图文件位置。

    第五步，需要编写包含thymeleaf模板的hello.html页面，代码如下所示。    

1	
2	
3	
4	    
5	    
6	
7	
8	    Welcome:
9	
10	

    其中在第2行，指定了第8行要用到的th标签的命名空间，这是来自于thymeleaf模板。

    而在第8行里，通过th:text="${name}"的形式，指定了存放${name}参数的占位符，而具体的name参数值，会来自于后端的返回。从这个页面里，大家能看到thymeleaf模板如下的样式特征。

1. 本范例中，thymeleaf模板是嵌入在HTML5代码里的，在使用时，需要如第2行所示，引入要用到该模板属性元素的命名空间。
2. 在诸如html5的前端页面里，可以像第8行那样，通过thymeleaf的语法，设置参数的占位符，这样当后端通过ModelAndView等形式传递来参数时，就能在占位符所在的位置，动态展示。

    完成开发后启动该项目，并如控制器里welcome方法之前的@RequestMapping注解所示，在浏览器里输入http://localhost:8080/welcome，就能看到输出“Welcome:Tom“的字样。而从发起请求到展示数据，主要经历了如下的流程。

1. 根据@RequestMapping注解所定义，http://localhost:8080/welcome请求被welcome方法所处理。
2. 在welcome方法里设置了返回视图为hello，并设置了name参数的值是Tom。
3. 根据application.properties里的配置，会根据配置好的前后缀，确定待返回的视图页面，这里是resources（由于该目录是在本项目的classpath里）目录下的templates目录里的hello.html。
4. 最终会展示hello.html，并在其中thymeleaf模板所定义，在name参数占位符所在的位置展示“Tom”字样。由此展示大家最终看到的结果。