初识
直接上代码:
/**
* @ModelAttribute 标记的方法,会在每个目标方法执行之前被SpringMVC调用!
*/
@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", "[email protected]", 12);
System.out.println("从数据库中获取一个对象: " + user);
map.put("user", user);
}
}
/**
* 运行流程:
* 1. 执行 @ModelAttribute 注解修饰的方法:从数据库中取出对象,把对象放入到了 Map 中,键为: user
* 2. SpringMVC 从 Map 中取出 User 对象,并把表单的请求参数赋给该 User 对象的对应属性,
* 3. SPringMVC 把上述对象传入目标方法的参数
*
* 注意:在 @ModelAttribute 修饰的方法中,放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!
*/
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user1) {
System.out.println("修改:" + user1);
return SUCCESS;
}
其中,注意:在 @ModelAttribute 修饰的方法中,放入到 Map 时的键
需要和目标方法入参类型
的首字母小写的字符串一致!
如map.put(“user
“,user),key为user
,需要和User类型转成user
相同。
源码分析
运行流程
- 执行 @ModelAttribute 注解修饰的方法:从数据库中取出对象,把对象放入到了 Map 中,键为: user
- SpringMVC 从 Map 中取出 User 对象,并把表单的请求参数赋给该 User 对象的对应属性
- SpringMVC 把上述对象传入到目标方法的参数中去
注意:在 @ModelAttribute 修饰的方法中,放入到 Map 时的键
需要和目标方法入参类型的第一个字母小写的字符串
一致!
确定POJO类型入参
SpringMVC 确定目标方法 POJO 类型入参的过程:
确定一个key
1). 若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰 ,则 key 为 POJO 类型首字母小写的字符串。
2). 若使用了 @ModelAttribute 来修饰,则 key 为 @ModelAttribute 注解的 value 属性值。在implicitModel 查找 key 对应的对象,若存在,则作为入参传入。
1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过,且 key 和 1确定的 key 一致,则会获取到。若implicitModel 不存在 key 对应的对象,则检查当前的 Handler 是否使用 @SessionAttributes 修饰,若使用了该注解,且 @SessionAttributes 注解的 value 属性值中包含了 key ,则会从 HttpSession 中获取 key 所对应的 value 值,若存在则直接传入到目标方法的入参中,若不存在则将抛出异常。
若 Handler 没有标识 @SessionAttributes 或 @SessionAttributes 注解的 value 不包含 key ,则会通过反射来创建 POJO 类型的参数,传入为目标方法的参数。
SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中,进而会保存到 request 中。
源码流程
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 是否使用了@SessionAttribute 进行修饰,若使用了,则尝试从 Session 中获取 attrName 所对应的属性值,若 Session 中没有对应的属性值,则抛出了异常。
(3)若 Handler 没有使用 @SessionAttributes 进行修饰,或 @SessionAttributes 中没有使用 value 指定的key 和 atrrName 相匹配,则通过反射创建了 POJO 对象。
2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性。
3). *SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel,进而传到 request 域对象中。
4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参。
使用小结
- 若目标方法的参数
没有用
@ModelAttribute修饰,则默认为查找的key默认为入参类型的首字符小写的字符串①,在@ModelAttribute修饰的方法中,放到Map/Model/ModelMap中的Key值②,其中①和②要一致,才能进行同模型参数的修改。
示例代码:
@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", "[email protected]", 12);
System.out.println("从数据库中获取一个对象: " + user);
//字符串①
map.put("user", user);
}
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user) {//字符串②
System.out.println("修改:" + user);
return SUCCESS;
}
分析:字符串①和字符串②同为user
,则模型进行匹配,修改,最终放入到map中。
2. 若目标方法的参数用
@ModelAttribute修饰,则查找的key为@ModelAttribute(“keyName”)中的keyName①,在@ModelAttribute修饰的方法中,放到Map/Model/ModelMap中的Key值②,其中①和②要一致,才能进行同模型参数的修改。
示例代码:
@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", "[email protected]", 12);
System.out.println("从数据库中获取一个对象: " + user);
//字符串①
map.put("abc", user);
}
}
@RequestMapping("/testModelAttribute")
public String testModelAttribute(@ModelAttribute("abc") User user) {//字符串②
System.out.println("修改:" + user);
return SUCCESS;
}
分析:字符串①和字符串②同为abc
,则模型进行匹配,修改,最终放入到map中。
注意:若map.put的时候的key与目标方法的key不一样,其实两个对象都是存在于Request域对象中的,都可以访问的到,只是没有进行匹配和修改合成为一个对象,可以分别访问。
一种异常
情形:若没有配置@ModelAttribute的方法,又类定义上配置了@SessionAttributes方法,其中的value还包含了目标方法的入参类型的首字符小写的字符串,则根据上面的确定POJO类型入参的过程的3,会排除一个异常。
解决方法:
(1)@SessionAttributes方法的value的属性值与目标方法的入参不相同。
(2)配置一个用@ModelAttribute注释的方法,将目标方法的入参先放入到map中,先确定了POJO入参,而不经过SessionAttributes查找key。