SpringMVC_5 处理响应数据（数据输出）

SpringMVC 输出模型数据

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

SpringMVC除过在方法上传入原生的request和session外还能怎么样把数据带给页面？

1）、可以在方法处传入Map、或者Model或者ModelMap。
给这些参数里面保存的所有数据都会放在请求域中。可以在页面获取
关系：
Map，Model，ModelMap：最终都是BindingAwareModelMap在工作；
相当于给BindingAwareModelMap中保存的东西都会被放在请求域中；

  Map(interface(jdk))      Model(interface(spring)) 
      ||                          //
      ||                         //
      \/                        //
  ModelMap(clas)               //
              \\              //
                \\           //
              ExtendedModelMap
                      ||
                      \/
              BindingAwareModelMap

2）、方法的返回值可以变为ModelAndView类型；
既包含视图信息（页面地址）也包含模型数据（给页面带的数据）；
而且数据是放在请求域中；
request、session、application；

1、处理模型数据之 ModelAndView

ModelAndView的介绍：
1）控制器处理方法的返回值如果为 ModelAndView, 则其既包含视图信息，也包含模型数据信息。
2）添加模型数据:
MoelAndView addObject(String attributeName, Object attributeValue) ModelAndView addAllObject(Map<String, ?> modelMap)
3）设置视图:
void setView(View view)
void setViewName(String viewName)

@RequestMapping("/testModelAndView") 
public ModelAndView testModelAndView(){
	System.out.println("testModelAndView"); 
	String viewName = "success";
	ModelAndView mv = new ModelAndView(viewName ); 
	mv.addObject("time",new Date().toString()); //实质上存放到 request 域中
	return mv;
}

//页面链接
<!--测试 ModelAndView 作为处理返回结果 -->
<a href="springmvc/testModelAndView">testModelAndView</a>

//成功页面
time: ${requestScope.time }

通过debug断点调试

断点调试

源码解析

2、处理模型数据之 Map

Map介绍（详细过程可见源码解析）
1）Spring MVC 在内部使用了一个 org.springframework.ui.Model 接口存储模型数据具体使用步骤
2）Spring MVC 在调用方法前会创建一个隐含的模型对象（ExtendedModelMap implicitModel = new BindingAwareModelMap();）作为模型数据的存储容器。
3）如果方法的入参为 Map 或 Model 类型，Spring MVC 会将隐含模型的引用传递给这些入参。
4）在方法体内，开发者可以通过这个入参对象访问到模型中的所有数据，也可以向模型中添加新的属性数据

目标方法的返回类型也可以是一个 Map 类型参数（也可以是 Model,或 ModelMap 类型）
@RequestMapping("/testMap")
public String testMap(Map<String,Object> map){ //【重点】
	System.out.println(map.getClass().getName());
	//org.springframework.validation.support.BindingAwareModelMap map.put("names", Arrays.asList("Tom","Jerry","Kite"));
	return "success";
}

//页面链接
<!-- 测试 Map 作为处理返回结果 -->
<a href="springmvc/testMap">testMap</a>

//成功页面，显示结果
names: ${requestScope.names }

5）注意问题：Map 集合的泛型，key 为 String,Value 为 Object,而不是 String
6）测试参数类型

@RequestMapping("/testMap2")
	public String testMap2(Map<String,Object> map,Model model,ModelMap modelMap){ System.out.println(map.getClass().getName());
	map.put("names", Arrays.asList("Tom","Jerry","Kite")); model.addAttribute("model", "org.springframework.ui.Model"); modelMap.put("modelMap", "org.springframework.ui.ModelMap");

	System.out.println(map == model); System.out.println(map == modelMap); System.out.println(model == modelMap);
	
	System.out.println(map.getClass().getName()); System.out.println(model.getClass().getName()); System.out.println(modelMap.getClass().getName());

/* true 
	true 
	true
org.springframework.validation.support.BindingAwareModelMap
org.springframework.validation.support.BindingAwareModelMap org.springframework.validation.support.BindingAwareModelMap
*/
return "success";
}

7）类层次结构

8)推荐使用Map，便于框架的移植

3、处理模型数据之 SessionAttributes注解【了解】

1）若希望在多个请求之间共用某个模型属性数据， 则可以在控制器类上标注一个
@SessionAttributes, Spring MVC 将在模型中对应的属性暂存到 HttpSession 中。
2）@SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外，还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中
例如：

1、@SessionAttributes(types=User.class) 会将隐含模型中所有类型为User.class 的属性添加到会话中。
2、@SessionAttributes(value={“user1”, “user2”})
3、@SessionAttributes(types={User.class, Dept.class})
4、@SessionAttributes(value={“user1”, “user2”}, types={Dept.class})

@SessionAttributes 源码

package org.springframework.web.bind.annotation;

import java.lang.annotation.Documented; import java.lang.annotation.ElementType; import java.lang.annotation.Inherited; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target;

@Target({ElementType.TYPE}) //说明这个注解只能应用在类型上面@Retention(RetentionPolicy.RUNTIME)
@Inherited @Documented
public @interface SessionAttributes {
	String[] value() default {};	//推荐使用
	Class<?>[] types() default {};		//范围太广
}

实验代码

@Controller
//@SessionAttributes("user") 
@SessionAttributes(value={"user"},types={String.class}) 
public class SpringMVCController {
/**
*@SessionAttributes
*除了可以通过属性名指定需要放到会话中的属性外(实际上是通过 value 指定 key 值)，
*还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上是通过 types 指定类型)
*注意：只能放在类的上面，不能修饰方法
*/
@RequestMapping("/testSessionAttributes")
public String testSessionAttributes(Map<String,Object> map){ 
	User user = new User("Tom","123","tom@atguigu.com",22); 
	map.put("user", user);
	map.put("school", "atguigu");
//默认是被存放到request 域，如果设置了@SessionAttribute 注解，就同时存放到 session 域中
	return "success";
}
}
<!--测试 @SessionAttribute 将数据存放到 session 域中 -->
<a href="testSessionAttributes">testSessionAttributes</a>


request user : ${requestScope.user } <br><br> 
session user : ${sessionScope.user } <br><br> 
request school : ${requestScope.school } <br><br> 
session school : ${sessionScope.school } <br><br>

4、处理模型数据之@ModelAttribute【了解】

使用场景


@ModelAttribute 注解之示例代码
1） 在方法定义上使用 @ModelAttribute 注解：Spring MVC 在调用目标处理方法前， 会先逐个调用在方法级上标注了 @ModelAttribute 的方法。 2） 在方法的入参前使用 @ModelAttribute 注解：可以从隐含对象中获取隐含的模型 数据中获取对象，再将请求参数绑定到对象中，再传入入参
3） 将方法入参对象添加到模型中

<!--测试 @ModelAttribute 类似 Struts2 框架的模型驱动 -->
<!--
模拟修改操作：
1.原始数据为：1,Tom,123456,tom@atguigu.com,12
2.密码不需要修改
3.表单回显，模拟操作直接在表单 value 属性上赋值
-->
<form action="springmvc/testModelAttribute" method="POST">
	<input type="hidden" name="id" value="1"><br>
		username: <input type="text" name="username" value="Tom"/><br> 
		email: <input type="text" name="email" value="tom@atguigu.com"/><br> 
		age: <input type="text" name="age" value="12"/><br>
	<input type="submit" value="Submit"/>
</form>


//1. 由 @ModelAttribute 标记的方法, 会在每个目标方法执行之前被 SpringMVC 调用! 
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user){
	 System.out.println("user="+user); 
	 return "success";
}

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

异常
//org.springframework.web.HttpSessionRequiredException: Session attribute ‘user’ required - not found in session
//出现这个异常，是@SessionAttributes(value={“user”},types={String.class})导致的，去掉类上的这个注解即可

@ModelAttribute 源码参考

@Target({ElementType.PARAMETER, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ModelAttribute {
/**
*The name of the model attribute to bind to.
*<p>The default model attribute name is inferred from the declared
*attribute type (i.e. the method parameter type or method return type),
*based on the non-qualified class name:
*e.g. "orderAddress" for class "mypackage.OrderAddress",
*or "orderAddressList" for "List&lt;mypackage.OrderAddress&gt;".
*/
String value() default "";
}

@ModelAttribute 注解之运行原理

1、执行@ModelAttribute 注解所修饰的方法，将从数据库中获取的对象存放到 Map 集合中，key 为 user
2、SpringMVC从Map 集合中获取 user 对象，将表单数据封装到与参数名称对应的user对象属性上
3、SpringMVC 将 user 对象作为参数，传递给目标方法。
4、注意：@ModelAttribute 注解修饰的方法中，放入到 Map 集合中的 key 值，应该和目标方法参数类型的类名称首字母小写一致。（如目标方法参数类型为Book，则key值应该为book）

@ModelAttribute 注解之源码分析

1）调用 @ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map中的数据放在了 implicitModel（隐含的模型对象） 中.
2）解析请求处理器的目标参数, 实际上该目标参数来自于 WebDataBinder 对象的target 属性

1、创建 WebDataBinder 对象
2、确定 objectName 属性: 若传入的 attrName 属性值为 "", 则 objectName  为类名第一个字母小写.
注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为 @ModelAttribute的value 属性值
3、确定 target 属性:
	在 implicitModel 中查找 attrName 对应的属性值.
	若存在, ok
	若不存在: 则验证当前 Handler 是否使用了@SessionAttributes 进行修饰,
	若使用了, 则尝试从 Session 中获取 attrName 所对应的属性值.
	若 session 中没有对应的属性值, 则抛出了异常.
	若 Handler 没 有 使 用 @SessionAttributes 进 行 修 饰 , 或@SessionAttributes 中没有使用 value 值指定的 key 和 attrName 相匹配, 则通过反射创建了 POJO 对象

3）SpringMVC 把表单的请求参数赋给了 WebDataBinder 的 target 对应的属性.
4） SpringMVC 会把 WebDataBinder 的 attrName 和 target 给到 implicitModel. 进而传到 request 域对象中.
5） 把 WebDataBinder 的 target 作为参数传递给目标方法的入参

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

1）确定一个 key:

若目标方法的 POJO 类型的参数木有使用 @ModelAttribute 作为修饰,则 key 为 POJO 类名第一个字母的小写
若使用了@ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的value 属性值.

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

@ModelAttribute 注解修饰POJO 类型的入参

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

/**
* @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 user = new User(1,"Tom","123456","tom@atguigu.com",12);
		System.out.println("从数据库中查询的对象：user="+user );
		//map.put("user", user); //BindingAwareModelMap
		
		//map.put("abc", user); //BindingAwareModelMap
	}
}



user user: ${requestScope.user }<br><br>
abc user: ${requestScope.abc }<br><br>

@sessionAttributes 注解引发的异常
1）由@SessionAttributes 引发的异常

2）如果在处理类定义处标注了@SessionAttributes(“xxx”)，则尝试从会话中获取该属 性，并将其赋给该入参，然后再用请求消息填充该入参对象。如果在会话中找不到对应的属性，则抛出 HttpSessionRequiredException 异常