【Spring MVC】处理模型数据

1. 浏览器发出请求，服务器servlet对这个请求做出响应，会有一个返回值，然后转发到一个页面，那么我们要把返回值在这个页面上显示出来。
2. 我们要做的就是把模型数据放到Request域对象中
3. Spring MVC 提供了以下几种途径输出模型数据

• ModelAndView:
  处理方法返回值类型为 ModelAndView
  时, 方法体即可通过该对象添加模型数据
• Map 及 Model:
  入参为
  org.springframework.ui.Model、org.springframework.ui.
  ModelMap 或 java.uti.Map 时，处理方法返回时，Map
  中的数据会自动添加到模型中。
• @SessionAttributes:
  将模型中的某个属性暂存到
  HttpSession 中，以便多个请求之间可以共享这个属性
• @ModelAttribute:
  方法入参标注该注解后, 入参的对象
  就会放到数据模型中

ModelAndView

ModelAndView可以作为控制器处理方法的返回值，它既包含视图信息，也包含模型数据信息。
比如如下代码中 new的ModelAndView 传入的viewName就是视图信息，然后addObject就是添加了模型数据信息，这一步其实是把这些放在了request域中，因此我们可以在页面上通过${RequestScope.time}输出 。

	@RequestMapping("/testModelAndView")
	public ModelAndView testModelAndView(){
		String viewName = SUCCESS;
		ModelAndView modelAndView = new ModelAndView(viewName);
		
		//添加模型数据到 ModelAndView 中.
		modelAndView.addObject("time", new Date());
		
		return modelAndView;
	}

添加模型数据

添加模型数据就是把数据放到Request域中，有如下两个方法

1. addObject

MoelAndView addObject(String attributeName, Object
attributeValue)

2. addAllObject

ModelAndView addAllObject(Map<String, ?> modelMap)

设置视图

void setView(View view)
void setViewName(String viewName

Map 及 Model

1. 控制器处理方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数

2. 我们给传入的Map put 的键值对，就会被保存在Request域中，也可以通过get方法得到Request域中保存的值

3. 示例

	@RequestMapping("/testMap")
	public String testMap(Map<String, Object> map){
		System.out.println(map.getClass().getName()); 
		map.put("names", Arrays.asList("Tom", "Jerry", "Mike"));
		return SUCCESS;
	}

我们在页面就可通过${requestScope.names}获取到信息

SessionAttributes

1.若希望在多个请求之间共用某个模型属性数据，则可以在
控制器类上标注一个 @SessionAttributes, Spring MVC
将在模型中对应的属性暂存到 HttpSession 中。
2. 通俗点来说要想把控制器处理方法入参的map的数据放到Session域中，可以在类上写一个@SessionAttributes 注解，注意只能写到类上
3. @SessionAttributes 除了可以通过属性名指定需要放到会
话中的属性外(实际上使用的是 value 属性值)，还可以通过模型属性的对象类型指定哪些
模型属性需要放到会话中

• @SessionAttributes(types=User.class) 会将隐含模型中所有类型(实际上使用的是 types 属性值)
  为 User.class 的属性添加到会话中。
• @SessionAttributes(value={“user1”, “user2”})
• @SessionAttributes(types={User.class, Dept.class})
• @SessionAttributes(value={“user1”, “user2”},
  types={Dept.class}

4. 示例

	@RequestMapping("/testSessionAttributes")
	public String testSessionAttributes(Map<String, Object> map){
		User user = new User("Tom", "123456", "tom@atguigu.com", 15);
		map.put("user", user);
		map.put("school", "atguigu");
		return SUCCESS;
	}

类上写的是

@SessionAttributes(value={"user"}, types={String.class})
@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {

@ModelAttribute

1. @ModelAttribute 标记方法：
   有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用!
   也就是Spring MVC
   在调用目标处理方法前，会先逐个调用在方法级上标注了
   @ModelAttribute 的方法。
2. @ModelAttribute 注解来修饰目标方法 POJO 类型的入参
   其 value 属性值有如下的作用:
   1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中.
   2). SpringMVC 会以 value 为 key, POJO 类型的对象为 value, 存入到 request 中.

@ModelAttribute的一个使用场景

当我们想更新表单的参数，但表单又有某些属性不能被修改的时候，如果我们按下图的步骤，那我们就只会得到 更新的参数值，而蓝色部分即不能被修改的属性值就会变成null。

我们可以按下图做法，先从数据库取出数据，而不是new 一个新的对象，然后对这个数据库取出来的数据进行更新，这样就得到正确的结果了。

@ModelAttribute运行流程

我们可以通过
@ModelAttribute 方法实现，代码如下。

	@ModelAttribute
	public void getUser(@RequestParam(value="id",required=false) Integer id, 
			Map<String, Object> map){
		System.out.println("modelAttribute method");
		if(id != null){
			//模拟从数据库中获取对象
			User user = new User(1, "Tom", "123456", "tom@atguigu.com", 12);
			System.out.println("从数据库中获取一个对象: " + user);
			
			map.put("user", user);
		}
	}

目标方法：

	@RequestMapping("/testModelAttribute")
	public String testModelAttribute(User user){
		System.out.println("修改: " + user);
		return SUCCESS;
	}

就是我们调用目标方法前，会先调用上面的@ModelAttribute实现的方法，运行流程：

1. 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: user
2. SpringMVC 从 Map 中取出 User 对象, 并把表单的请求参数赋给该 User 对象的对应属性.
3. SpringMVC 把上述对象传入目标方法的参数.

注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!

@ModelAttribute源码分析

1. 调用 @ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中.
2. 解析请求处理器的目标参数, 实际上该目标参数来自于 WebDataBinder 对象的 target 属性
   1). 创建 WebDataBinder 对象:
   ①. 确定 objectName 属性:
   若传入的 attrName 属性值为 “”, 则 objectName 为类名第一个字母小写.
   注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为 @ModelAttribute 的 value 属性值
   ②. 确定 target 属性:
   1)在 implicitModel 中查找 attrName 对应的属性值. 若存在, ok
   2)若不存在: 则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰, 若使用了, 则尝试从 Session 中 获取 attrName 所对应的属性值. 若 session 中没有对应的属性值, 则抛出了异常.
   3)若 Handler 没有使用 @SessionAttributes 进行修饰, 或 @SessionAttributes 中没有使用 value 值指定的 key和 attrName 相匹配, 则通过反射创建了 POJO 对象
   2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性. ’
   3). SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel.
   进而传到 request 域对象中.
   4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参.

SpringMVC 确定目标方法 POJO 类型入参的过程

1. 确定一个 key:
   1). 若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写
   2). 若使用了 @ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值.
2. 在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入
   1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和 1 确定的 key 一致, 则会获取到.
3. 若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰,
   若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从 HttpSession 中来获取 key 所
   对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常.
4. 若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则
   会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数
5. SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中.