SpringMVC系列（六）处理模型数据
Spring MVC 提供了以下几种途径输出模型数据：
ModelAndView: 处理方法返回值类型为 ModelAndView时, 方法体即可通过该对象添加模型数据
Map 及 Model: 入参为org.springframework.ui.Model、org.springframework.ui.ModelMap 或 java.uti.Map 时，处理方法返回时，Map 中的数据会自动添加到模型中。
@SessionAttributes: 将模型中的某个属性暂存到HttpSession 中，以便多个请求之间可以共享这个属性
@ModelAttribute: 方法入参标注该注解后, 入参的对象就会放到数据模型中
代码实战
一、ModelAndView
处理方法返回值类型为 ModelAndView时, 方法体即可通过该对象添加模型数据
1.在index.jsp编写请求链接
1 <p>目标方法的返回值是 ModelAndView 类型 begin</p> 2 <a href="handleModelDataTest/testModelAndView">Test ModelAndView</a> 3 <p>目标方法的返回值是 ModelAndView 类型 end</p>
2. 编写handle
HandleModelDataTest.java
1 package com.study.springmvc.handlers; 2 3 import java.util.Date; 4 5 import org.springframework.stereotype.Controller; 6 import org.springframework.web.bind.annotation.RequestMapping; 7 import org.springframework.web.servlet.ModelAndView; 8 9 /** 10 * 处理模型数据 11 * @author lgs 12 * 13 */ 14 @RequestMapping("/handleModelDataTest") 15 @Controller 16 public class HandleModelDataTest { 17 18 public static final String SUCCESS="success"; 19 20 /** 21 * 目标方法的返回值可以是 ModelAndView 类型。 22 * 其中可以包含视图和模型信息 23 * SpringMVC 会把 ModelAndView的model中数据放入到 request 域对象中. 24 * @return 25 */ 26 @RequestMapping("/testModelAndView") 27 public ModelAndView testModelAndView(){ 28 String viewName = SUCCESS; 29 ModelAndView modelAndView = new ModelAndView(viewName); 30 31 //添加模型数据到 ModelAndView 中. 32 modelAndView.addObject("time", new Date()); 33 34 return modelAndView; 35 } 36 }
3. 在success.jsp取出返回的数据模型显示
1 <p>目标方法的返回值是 ModelAndView 类型 begin</p> 2 time: ${requestScope.time } 3 <p>目标方法的返回值是 ModelAndView 类型 end</p>
4.访问的效果图如下
二、 Map 及 Model
入参为org.springframework.ui.Model、org.springframework.ui.ModelMap 或 java.uti.Map 时，处理方法返回时，Map 中的数据会自动添加到模型中
1.在index.jsp里面编写请求超链接
1 <p>目标方法可以添加 Map类型 begin</p> 2 <a href="handleModelDataTest/testMap">Test Map</a> 3 <p>目标方法可以添加 Map类型 end</p>
2. 编写handle类HandleModelDataTest.java
1 /** 2 * 目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数. 3 * 把map的键的类型作为目标方法的返回类型，在前台即可通过${requestScope.names } 4 * 获取值 5 * @param map 6 * @return 7 */ 8 @RequestMapping("/testMap") 9 public String testMap(Map<String, Object> map){ 10 System.out.println(map.getClass().getName()); 11 map.put("names", Arrays.asList("Tom", "Jerry", "Mike")); 12 return SUCCESS; 13 }
3. 在跳转成功页面取出handle返回的值显示
1 <!-- 目标方法的返回值是 Map类型 取出map的键即可拿到值 begin --> 2 names: ${requestScope.names } 3 <!-- 目标方法的返回值是 Map类型 取出map的键即可拿到值 end --> 4 <br><br>
4. 效果图
三、@SessionAttributes
多个请求之间共用某个模型属性数据
1.在index.jsp里面编写请求超链接
1 <p>@SessionAttributes目标方法把返回值放到session会话 begin</p> 2 <a href="handleModelDataTest/testSessionAttributes">Test SessionAttributes</a> 3 <p>@SessionAttributes目标方法把返回值放到session会话 end</p>
2. 编写handle类HandleModelDataTest.java
1 package com.study.springmvc.handlers; 2 3 import java.util.Arrays; 4 import java.util.Date; 5 import java.util.Map; 6 7 import org.springframework.stereotype.Controller; 8 import org.springframework.web.bind.annotation.RequestMapping; 9 import org.springframework.web.bind.annotation.SessionAttributes; 10 import org.springframework.web.servlet.ModelAndView; 11 12 import com.study.springmvc.model.User; 13 14 /** 15 * 处理模型数据 16 * @author lgs 17 * 18 */ 19 @SessionAttributes(value={"user"}, types={String.class}) 20 @RequestMapping("/handleModelDataTest") 21 @Controller 22 public class HandleModelDataTest { 23 24 public static final String SUCCESS="success"; 25 26 /** 27 * 目标方法的返回值可以是 ModelAndView 类型。 28 * 其中可以包含视图和模型信息 29 * SpringMVC 会把 ModelAndView的model中数据放入到 request 域对象中. 30 * @return 31 */ 32 @RequestMapping("/testModelAndView") 33 public ModelAndView testModelAndView(){ 34 String viewName = SUCCESS; 35 ModelAndView modelAndView = new ModelAndView(viewName); 36 37 //添加模型数据到 ModelAndView 中. 38 modelAndView.addObject("time", new Date()); 39 40 return modelAndView; 41 } 42 43 /** 44 * 目标方法可以添加 Map 类型(实际上也可以是 Model 类型或 ModelMap 类型)的参数. 45 * 把map的键的类型作为目标方法的返回类型，在前台即可通过${requestScope.names } 46 * 获取值 47 * @param map 48 * @return 49 */ 50 @RequestMapping("/testMap") 51 public String testMap(Map<String, Object> map){ 52 System.out.println(map.getClass().getName()); 53 map.put("names", Arrays.asList("Tom", "Jerry", "Mike")); 54 return SUCCESS; 55 } 56 57 /** 58 * @SessionAttributes 除了可以通过属性名指定需要放到会话中的 59 * 属性外(实际上使用的是 value 属性值), 60 * 还可以通过模型属性的对象类型指定哪些模型属性需要放到 61 * 会话中(实际上使用的是 types 属性值) 62 * 63 * 注意: 该注解只能放在类的上面. 而不能修饰放方法. 64 */ 65 @RequestMapping("/testSessionAttributes") 66 public String testSessionAttributes(Map<String, Object> map){ 67 User user = new User("Tom", "123456", "shenzhen", 15); 68 map.put("user", user); 69 map.put("school", "shenzhen"); 70 return SUCCESS; 71 } 72 }
3. 在跳转成功页面取出handle返回的值显示
1 <!--目标方法把返回值放到session会话 begin --> 2 request user: ${requestScope.user } 3 <br> 4 5 session user: ${sessionScope.user } 6 <br> 7 8 request school: ${requestScope.school } 9 <br> 10 11 session school: ${sessionScope.school } 12 <br> 13 <!-- 目标方法把返回值放到session会话 end -->
4. 效果图
四、@ModelAttribute
方法入参标注该注解后, 入参的对象就会放到数据模型中
1.在index.jsp里面编写请求表单
1 <p>@ModelAttribute begin</p> 2 <!-- 3 模拟修改操作 4 1. 原始数据为: 1, Tom, 123456,666qq.com,12 5 2. 密码不能被修改. 6 3. 表单回显, 模拟操作直接在表单填写对应的属性值 7 --> 8 <form action="handleModelDataTest/testModelAttribute" method="Post"> 9 <input type="hidden" name="id" value="1"/> 10 username: <input type="text" name="username" value="Tom"/> 11 <br> 12 email: <input type="text" name="email" value="tom@atguigu.com"/> 13 <br> 14 age: <input type="text" name="age" value="12"/> 15 <br> 16 <input type="submit" value="Submit"/> 17 </form> 18 <p>@ModelAttribute end</p>
2. 编写handle类HandleModelDataTest.java
1 /** 2 * 1. 有 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用! 3 * 2. @ModelAttribute 注解也可以来修饰目标方法 POJO 类型的入参, 其 value 属性值有如下的作用: 4 * 1). SpringMVC 会使用 value 属性值在 implicitModel 中查找对应的对象, 若存在则会直接传入到目标方法的入参中. 5 * 2). SpringMVC 会一 value 为 key, POJO 类型的对象为 value, 存入到 request 中. 6 */ 7 @ModelAttribute 8 public void getUser(@RequestParam(value="id",required=false) Integer id, 9 Map<String, Object> map){ 10 System.out.println("modelAttribute method"); 11 if(id != null){ 12 //模拟从数据库中获取对象 13 User user = new User(1, "Tom", "123456", "666qq.com", 12); 14 System.out.println("从数据库中获取一个对象: " + user); 15 16 map.put("user", user); 17 } 18 } 19 20 /** 21 * 运行流程: 22 * 1. 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: user 23 * 2. SpringMVC 从 Map 中取出 User 对象, 并把表单的请求参数赋给该 User 对象的对应属性. 24 * 3. SpringMVC 把上述对象传入目标方法的参数. 25 * 26 * 注意: 在 @ModelAttribute 修饰的方法中, 放入到 Map 时的键需要和目标方法入参类型的第一个字母小写的字符串一致! 27 * 28 * SpringMVC 确定目标方法 POJO 类型入参的过程 29 * 1. 确定一个 key: 30 * 1). 若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写 31 * 2). 若使用了 @ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值. 32 * 2. 在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入 33 * 1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和 1 确定的 key 一致, 则会获取到. 34 * 3. 若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes 注解修饰, 35 * 若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从 HttpSession 中来获取 key 所 36 * 对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常. 37 * 4. 若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则 38 * 会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数 39 * 5. SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中. 40 * 41 * 源代码分析的流程 42 * 1. 调用 @ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中. 43 * 2. 解析请求处理器的目标参数, 实际上该目标参数来自于 WebDataBinder 对象的 target 属性 44 * 1). 创建 WebDataBinder 对象: 45 * ①. 确定 objectName 属性: 若传入的 attrName 属性值为 "", 则 objectName 为类名第一个字母小写. 46 * *注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为 @ModelAttribute 47 * 的 value 属性值 48 * 49 * ②. 确定 target 属性: 50 * > 在 implicitModel 中查找 attrName 对应的属性值. 若存在, ok 51 * > *若不存在: 则验证当前 Handler 是否使用了 @SessionAttributes 进行修饰, 若使用了, 则尝试从 Session 中 52 * 获取 attrName 所对应的属性值. 若 session 中没有对应的属性值, 则抛出了异常. 53 * > 若 Handler 没有使用 @SessionAttributes 进行修饰, 或 @SessionAttributes 中没有使用 value 值指定的 key 54 * 和 attrName 相匹配, 则通过反射创建了 POJO 对象 55 * 56 * 2). SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性. 57 * 3). *SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel. 58 * 近而传到 request 域对象中. 59 * 4). 把 WebDataBinder 的 target 作为参数传递给目标方法的入参. 60 */ 61 @RequestMapping("/testModelAttribute") 62 public String testModelAttribute(User user){ 63 System.out.println("修改: " + user); 64 return SUCCESS; 65 }
3. 控制台输出
1 modelAttribute method 2 从数据库中获取一个对象: User [id=1, username=Tom, password=123456, email=666qq.com, age=12, address=null] 3 修改: User [id=1, username=lgs, password=123456, email=123456@qq.com, age=90, address=null]
