`

Spring4MVC之处理模型数据之@ModelAttribute

 
阅读更多

 

@ModelAttribute使用情景

 

在用户修改数据的场景中,浏览器表单发送给服务器的数据并非全部数据,而只是一部分。如用户修改员工信息时,其工号和入职日期时不可以修改的。表单中不会有该字段对应的值。这样修改其他信息后,提交的数据中工号和入职日期为空。若直接以这个数据更新数据库,则会设置 工号和入职日期为空,发生信息丢失。

 

解决办法:

1. 在表单中使用隐藏字段,缺点是,当字段较多时,叫麻烦,代码不清晰。甚至不可行,如密码,不能暴露在页面中。

2. 在处理类中更新时,手动从数据库获取。

3. SpringMVC提供了更加优雅的解决方案,使用@ModelAttribute注解

 

@ModelAttribute注解之示例代码

 

1. JSP页面

 

<li><a href="emp/list">@ModelAttribute处理方式</a></li>

 

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Employee Management</title>
</head>
<body>
    <h1>Employee List</h1>
    
    <a href="/org.rabbitx.web.spring4mvc/pages/emp-add.jsp">添加</a>
    
    <table border="1" style="border-collapse: collapse;margin:10px 0px;width:800px;">
        <tr>
            <th>工号</th>
            <th>名称</th>
            <th>年龄</th>
            <th>工资</th>
            <th>入职日期</th>
            <th>描述</th>
            <th>操作列</th>
        </tr>
        <c:forEach items="${emps}" var="emp">
            <tr>
                <td>${emp.no}</td>
	            <td>${emp.name}</td>
	            <td>${emp.age}</td>
	            <td>${emp.salary}</td>
	            <td>${emp.hiredate}</td>
	            <td>${emp.description}</td>
	            <td>
	                <a href="/org.rabbitx.web.spring4mvc/emp/update?id=${emp.id}">修改</a>
	                <a href="/org.rabbitx.web.spring4mvc/emp/delete?id=${emp.id}">删除</a>
	            </td>
            </tr>        
        </c:forEach>
    </table>
    
    <hr/>
    <a href="/org.rabbitx.web.spring4mvc/index.jsp">返回首页</a>
</body>
</html>

 

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Employee Management</title>
</head>
<body>
    <h1>修改员工:${emp.no},其入职日期为:${emp.hiredate}</h1>
    
    <form action="/org.rabbitx.web.spring4mvc/emp/save" method="POST">
        <input type="hidden" name="id" value="${emp.id}">
        <table>
            <tr>
                <td>名称</td><td><input type="text" name="name" value="${emp.name}"></td>
            </tr>
            <tr>
                <td>年龄</td><td><input type="text" name="age" value="${emp.age}"></td>
            </tr>
            <tr>
                <td>工资</td><td><input type="text" name="salary" value="${emp.salary}"></td>
            </tr>
            <tr>
                <td>描述</td><td><input type="text" name="description" value="${emp.description}"></td>
            </tr>
            <tr align="right">
                <td colspan="2"><input type="submit"></td>
            </tr>
        </table>
    </form>
    
    <hr/>
    <a href="/org.rabbitx.web.spring4mvc/emp/list">返回</a>
</body>
</html>

 

2. 处理类

 

package org.rabbitx.web.spring4mvc.empmgr;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.List;
import java.util.Map;

import org.rabbitx.web.spring4mvc.dao.IEmployeeDao;
import org.rabbitx.web.spring4mvc.model.Employee;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.servlet.ModelAndView;

@Controller
@RequestMapping("/emp")
public class EmployeeController {

	private static final String VIEW_NAME_LIST = "emp-list";
	
	private static final String VIEW_NAME_UPDATE = "emp-update";
	
	@Autowired
	private IEmployeeDao employeeDao;
	
	@RequestMapping("/list")
	public ModelAndView list() throws Exception
	{
		ModelAndView modelAndView = new ModelAndView();
		
		List<Employee> emps = employeeDao.getAllEmployees();
		
		modelAndView.addObject("emps", emps);
		modelAndView.setViewName(VIEW_NAME_LIST);
		return modelAndView;
	}
	
	@RequestMapping("/update")
	public ModelAndView update(@RequestParam(value="id") Integer id) throws Exception
	{
		ModelAndView modelAndView = new ModelAndView();
		
		Employee emp = employeeDao.getById(id);
		
		modelAndView.addObject("emp", emp);
		modelAndView.setViewName(VIEW_NAME_UPDATE);
		return modelAndView;
	}
	
	/**
	 * 更新数据,实际上丢失表单中没有的数据:no,hiredate
	 * 
	 * 
	 * 运行流程:
	 * 1. 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: "employee"
	 * 2. SpringMVC 从 Map 中取出  Employee 对象, 并把表单的请求参数赋给该  Employee 对象的对应属性.
	 * 3. SpringMVC 把上述对象传入目标方法的参数. 
	 * 
	 * 注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致!
	 * 
	 * 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 中. 
	 * 
	 * 源代码分析的流程
	 * 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 作为参数传递给目标方法的入参. 
	 */
	@RequestMapping("/save")
	public ModelAndView save(Employee emp) throws Exception
	{
		
		System.out.println(emp);
    
		if(emp.getId() == null)
		{
			Date date = new Date();
			SimpleDateFormat format = new SimpleDateFormat("yyyy-mm-dd");
			emp.setHiredate(format.format(date));
			employeeDao.addEmployee(emp);
		}
		else
		{
			//更新数据,实际上丢失表单中没有的数据:no,hiredate
			employeeDao.updateEmployeeById(emp);
		}
		
		ModelAndView modelAndView = new ModelAndView();
		
		List<Employee> emps = employeeDao.getAllEmployees();
		
		modelAndView.addObject("emps", emps);
		modelAndView.setViewName(VIEW_NAME_LIST);
		return modelAndView;
	}	
	
	/**
	 * 对于丢失数据问题,SpringMVC提供了@ModelAttribute解决方案
	 * 
	 * 1. 有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用! 
	 * 2. @ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参, 其 value 属性值有如下的作用:
	 * 1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中.
	 * 2). SpringMVC 会以 value 为 key, POJO 类型的对象为 value, 存入到 request 中. 
	 */
	@ModelAttribute
	public void getEmployee(@RequestParam(value="id",required=false) Integer id,Map<String,Object> map) throws Exception
	{
		System.out.println("从数据库中获取一个对象: " + id);
		System.out.println("-----------getEmployee-------------");
		//从数据库中获取对象
		if(id != null)
		{
			Employee emp = employeeDao.getById(id);
			map.put("employee", emp);
		}
	}
	
	/**
	 * 删除操作
	 * @param id
	 */
	@RequestMapping("/delete")
	public ModelAndView delete(@RequestParam(value="id") Integer id) throws Exception
	{
		employeeDao.deleteEmployeeById(id);
		
		ModelAndView modelAndView = new ModelAndView();
		
        List<Employee> emps = employeeDao.getAllEmployees();
		modelAndView.addObject("emps", emps);
		modelAndView.setViewName(VIEW_NAME_LIST);
		return modelAndView;
	}
}

 

@ModelAttribute

 

在方法定义上使用 @ModelAttribute 注解:Spring MVC在调用目标处理方法前,会先逐个调用在方法级上标注了@ModelAttribute 的方法。

在方法的入参前使用@ModelAttribute 注解:

 

可以从隐含对象中获取隐含的模型数据中获取对象,再将请求参数绑定到对象中,再传入入参将方法入参对象添加到模型中

 

@ModelAttribute注解之运行原理

 

 

@ModelAttribute注解之源码分析

 

 

 

分享到:
评论

相关推荐

Global site tag (gtag.js) - Google Analytics