SpringMVC-ModelAttribute

SpringMVC

ModelAttribute注解之使用场景

• 

  • 此场景的代码示例

  • 新建一个testModelAttribute方法

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

  • 新建一个表单

    • <!--  
      		模拟修改操作
      		1. 原始数据为: 1, Xuefeng, 123456,lian@xuefeng.com,12
      		2. 密码不能被修改.
      		3. 表单回显, 模拟操作直接在表单填写对应的属性值
      	-->
      	<form action="springmvc/testModelAttribute" method="Post">
      		<input type="hidden" name="id" value="1"/>
      		username: <input type="text" name="username" value="Xuefeng"/>
      		<br>
      		email: <input type="text" name="email" value="lian@xuefeng.com"/>
      		<br>
      		age: <input type="text" name="age" value="12"/>
      		<br>
      		<input type="submit" value="Submit"/>
      	</form>
      	<br><br>
      

  • 点击超链接 控制台打印修改:User [id=1, username=Xuefeng, password=null, email=lian@xuefeng.com, age=12]

    明显 password为null 这是上面的图片所对应的情况

• 

  • 新建一个getUser方法

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

  • 更改表单的年龄为13

    • 

  • 提交表单

    控制台打印

    从数据库中获取一个对象:User [id=1, username=xuefeng, password=123456, email=lian@xuefeng.com, age=12]
修改： User [id=1, username=Xuefeng, password=123456, email=lian@xuefeng.com, age=13]

    首先 password的值赋值了 其次age的值也改变了

---

ModelAttribute注解之运行原理

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

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

• 比如此处的键user变成任意值aaa

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

• 控制台打印的password就没有赋值

  • 从数据库中获取一个对象:User [id=1, username=xuefeng, password=123456, email=lian@xuefeng.com, age=12]
  • 修改： User [id=1, username=Xuefeng, password=null, email=lian@xuefeng.com, age=12]

---

ModelAttribute注解之源码分析

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

---

如何确定目标方法POJO类型参数

 /* 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 中. 
 */

---

ModelAttribute注解修饰POJO类型的入参

此处改变user的键为abc

/**
	 * 1. 有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用! 
	 * 2. @ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参, 其 value 属性值有如下的作用:
	 * 1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中.
	 * 2). SpringMVC 会一 value 为 key, POJO 类型的对象为 value, 存入到 request 中. 
	 */
	@ModelAttribute
	public void getUser(@RequestParam(value="id",required = false) Integer id,
				Map<String,Object> map) {
		if(id!= null) {
			//模拟从数据库中获取一个对象
			User user=new User(1,"xuefeng","123456","lian@xuefeng.com",12);
			System.out.println("从数据库中获取一个对象:"+user);
			map.put("abc", user);
		}
	}

为了能正常出现password的值，我们在testModelAttribute加上了@ModelAttribute(“abc”)注解

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

控制台的值就赋值了

从数据库中获取一个对象:

User [id=1, username=xuefeng, password=123456, email=lian@xuefeng.com, age=12]
修改： User [id=1, username=Xuefeng, password=123456, email=lian@xuefeng.com, age=12]

---

SessionAttributes注解引发的异常

在public class SpringMVCTest {}上添加

@SessionAttributes(value={"user"}, types={String.class})注解时一定要加上一个@ModelAttribute标注的方法

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

然后在另一个方法testModelAttribute中调用@ModelAttribute就能成功

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

delAttribute中调用@ModelAttribute就能成功

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

否则就会出现异常