五、处理响应数据

一、SpringMVC 输出模型数据概述

　　Spring MVC 提供了以下几种途径输出模型数据：

• • ModelAndView: 处理方法返回值类型为 ModelAndView时, 方法体即可通过该对象添加模型数据

  • Map 及 Model: 入参为org.springframework.ui.Model、org.springframework.ui. ModelMap 或 java.uti.Map 时，处理方法返回时，Map 中的数据会自动添加到模型中。

  • @SessionAttributes: 将模型中的某个属性暂存到 HttpSession 中，以便多个请求之间可以共享这个属

  • @ModelAttribute: 方法入参标注该注解后, 入参的对象就会放到数据模型中

二、ModelAndView

2.1、ModelAndView介绍

• 控制器处理方法的返回值如果为 ModelAndView, 则其既包含视图信息，也包含模型 数据信息。

• 添加模型数据:

  • MoelAndView addObject(String attributeName, Object attributeValue)

  • ModelAndView addAllObject(Map<String, ?> modelMap)

• 设置视图:

  • void setView(View view)

  • void setViewName(String viewName)

2.2、实验代码

/**
 * 目标方法的返回类型可以是ModelAndView类型
 *                 其中包含视图信息和模型数据信息
 */
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
    System.out.println("testModelAndView");
    String viewName = "success";
    ModelAndView mv = new ModelAndView(viewName);
   //实质上存放到request域中 
    mv.addObject("time",new Date().toString());
    return mv;
}

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

time: ${requestScope.time }

2.3、源码解析

　　SpringMVC 会把 ModelAndView 的 model 中数据放入到 request 域对象中.

三、处理模型数据之Map/Model

3.1、Map介绍

1. Spring MVC 在内部使用了一个 org.springframework.ui.Model 接口存储模型数据具体使用步骤

2. Spring MVC 在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器。

3. 如果方法的入参为 Map 或 Model 类型，Spring MVC 会将隐含模型的引用传递给这些入参。

4. 在方法体内，开发者可以通过这个入参对象访问到模型中的所有数据，也可以向模型中添加新的属性数据

3.2、实验代码

//目标方法的返回类型也可以是一个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 }

　　注意问题：Map集合的泛型，key为String,Value为Object,而不是String

• 测试参数类型

// 目标方法的返回类型也可以是一个Map类型参数（也可以是Model,或ModelMap类型）
@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());
 
        return "success";
}

• 类层次结构

• 源码参考

public class BindingAwareModelMap extends ExtendedModelMap {

    @Override
    public Object put(String key, Object value) {
        removeBindingResultIfNecessary(key, value);
        return super.put(key, value);
    }

    @Override
    public void putAll(Map<? extends String, ?> map) {
        map.forEach(this::removeBindingResultIfNecessary);
        super.putAll(map);
    }

    private void removeBindingResultIfNecessary(Object key, Object value) {
        if (key instanceof String) {
            String attributeName = (String) key;
            if (!attributeName.startsWith(BindingResult.MODEL_KEY_PREFIX)) {
                String bindingResultKey = BindingResult.MODEL_KEY_PREFIX + attributeName;
                BindingResult bindingResult = (BindingResult) get(bindingResultKey);
                if (bindingResult != null && bindingResult.getTarget() != value) {
                    remove(bindingResultKey);
                }
            }
        }
    }
}

四、@SessionAttributes

4.1、介绍

• 若希望在多个请求之间共用某个模型属性数据（登录的用户信息），则可以在控制器类上标注一个 @SessionAttributes, Spring MVC 将在模型中对应的属性暂存到 HttpSession 中。

• @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外，还可以通过模型属性的对象类型指定哪些 模型属性需要放到会话中

  • @SessionAttributes(types=User.class) 会将隐含模型中所有类型为 User.class 的属性添加到会话中。

  • @SessionAttributes(value={“user1”, “user2”})

  • @SessionAttributes(types={User.class, Dept.class})

  • @SessionAttributes(value={“user1”, “user2”}, types={Dept.class})

4.2、实验代码

<a href="springmvc/testSessionAttributes">Test SessionAttributes</a>

@SessionAttributes(value={"user"}, types={String.class})
@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {    
/**
     * @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外(实际上使用的是 value 属性值),
     * 还可以通过模型属性的对象类型指定哪些模型属性需要放到会话中(实际上使用的是 types 属性值)
     * 
     * 注意: 该注解只能放在类的上面. 而不能修饰放方法. 
     */
    @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Map<String, Object> map){
        User user = new User("Tom", "123456", "tom@jdy.com", 15);
        map.put("user", user);
        map.put("school", "jdy");
        return SUCCESS;
    }
}    
    

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

注意: 该注解只能放在类的上面. 而不能修饰放方法. 

五、@ModelAttribute

5.1、介绍

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

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

• 可以从隐含对象中获取隐含的模型数据中获取对象，再将请求参数绑定到对象中，再传入入参

• 将方法入参对象添加到模型中

5.2、实验代码

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

/**
     * 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){
        System.out.println("modelAttribute method");
        if(id != null){
            //模拟从数据库中获取对象
            User user = new User(1, "Tom", "123456", "tom@jdy.com", 12);
            System.out.println("从数据库中获取一个对象: " + user);
            
            map.put("user", user);
        }
    }

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

　　运行流程:

1. 1. 执行 @ModelAttribute 注解修饰的方法: 从数据库中取出对象, 把对象放入到了 Map 中. 键为: user

   2. SpringMVC 从 Map 中取出 User 对象, 并把表单的请求参数赋给该 User 对象的对应属性.

   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 对象:

   1. 确定 objectName 属性: 若传入的 attrName 属性值为 "", 则 objectName 为类名第一个字母小写. 注意: attrName. 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰, 则 attrName 值即为@ModelAttribute 的 value 属性值

   2. 确定 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 作为参数传递给目标方法的入参.

六、由@SessionAttributes注解引发的异常

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

　　如何避免@SessionAttributes引发的异常。

@Controller
@RequestMapping("/user")
@SessionAttributes("user")
public class UserController {

    //该方法会往隐含模型中添加一个名为user的模型属性
    @ModelAttribute("user")
    public User getUser(){
        User user = new User();
        return user
    }
}