SpringMVC学习笔记 | SpringMVC中处理模型数据的几种方法（ModelAndView|@SessionAttributes|@ModelAttribute）以及运行原理

处理模型数据

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

ModelAndView
处理方法返回值类型为ModelAndView时，方法体即可通过该对象添加模型数据
Map及Model
入参为org.springframeword.ui.Model、org.springframeword.ui.ModelMap或java.uitl.Map时，处理方法返回时，Map中的数据会自动添加到模型中。
@SessionAttributes
将模型中的某个属性暂存到HttpSession中，以便多个请求之间可以共享这个属性
@ModelAttribute
方法入参标注该注解后，入参的对象就会放到数据模型中。

ModelAndView

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

添加模型数据的方法

ModelAndView addObject(String attributeName,Object attributeValue);
ModelAndView addAllObject(Map <String,?> modelMap);

设置视图的方法

void setView(View view)
void setViewName(String viewName);

SpringMVC会把ModelAndView的model中的数据放入到request域对象中，因此可以直接使用request来获取数据

控制器类方法如下：

package com.cerr.springmvc.handlers;

import com.cerr.springmvc.entities.User;
import org.omg.PortableInterceptor.SYSTEM_EXCEPTION;
import org.springframework.stereotype.Controller;
import org.springframework.util.concurrent.SuccessCallback;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Date;

@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {
    private static final String SUCCESS = "success";

    @RequestMapping("/testModelAndView")
    public ModelAndView testModelAndView(){
        String viewName = SUCCESS;

        ModelAndView modelAndView = new ModelAndView(viewName);

        //添加模型数据到ModelAndView中
        modelAndView.addObject("time",new Date());

        return modelAndView;
    }
}

链接：<a href="springmvc/testModelAndView">testModelAndView</a>

可以直接在目标页面来通过request获取数据：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    time:${requestScope.time}
</body>
</html>

Map或Model

可以在方法中传入一个Map或Model型参数，在方法返回时，会将Map中的数据自动添加到模型中
SpringMVC在内部使用了一个org.springframeword.ui.Model接口存储模型数据。

其原理具体步骤：

SpringMVC在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器。
如果方法的入参为Map或Model类型，SpringMVC会将隐含模型的引用传递给这些入参。在方法体内，开发者可以通过这个入参对象访问到模型中的所有数据，也可以向模型中添加新的属性数据。

控制器类方法如下：

package com.cerr.springmvc.handlers;

import com.cerr.springmvc.entities.User;
import org.omg.PortableInterceptor.SYSTEM_EXCEPTION;
import org.springframework.stereotype.Controller;
import org.springframework.util.concurrent.SuccessCallback;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;

@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {
    private static final String SUCCESS = "success";

    @RequestMapping(value = "/testMap")
    public String testMap(Map <String,Object> map){
        map.put("names", Arrays.asList("Tom","Jerry","Mike"));
        System.out.println(map.get("names"));
        return SUCCESS;
    }
}

链接：<a href="springmvc/testMap">testMap</a>

可以直接在目标页面来通过request获取数据：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    names:${requestScope.names}
</body>
</html>

@SessionAtttibutes

若希望在多个请求之间共用某个模型属性数据，则可以在控制器类上标注一个@SessionAttributes，SpringMVC会将在模型中对应的属性暂存到HttpSession中。并且有一点需要注意的是，这个注解只能在类上面标注，而不能在方法上面标注。

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

@SessionAttributes(types=User.class)会将隐含模型中所有类型为User.class的属性添加到会话中
@SessionAttributes(value={"user1","user2"})会将隐含模型中key值为"user1"和"user2"的属性添加到会话中
@SessionAttributes(types={User.class,Dept.class})会将隐含模型中所有类型为User.class和Dept.class的属性添加到会话中
@SessionAttributes(value={"user1","user2"},types={Dept.class})会将隐含模型中所有类型为Dept.class和key值为"user1"和"user2"的属性添加到会话中

控制器类方法如下：

package com.cerr.springmvc.handlers;

import com.cerr.springmvc.entities.User;
import org.omg.PortableInterceptor.SYSTEM_EXCEPTION;
import org.springframework.stereotype.Controller;
import org.springframework.util.concurrent.SuccessCallback;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;

@SessionAttributes(value = {"user"},types = {String.class})
@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {
    private static final String SUCCESS = "success";

   @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Map<String,Object> map){
        User user = new User("Tom","123456","tom@cerr.com",15);
        map.put("user",user);
        map.put("school","School");
        return SUCCESS;
    }
}

链接：<a href="springmvc/testSessionAttributes">testSessionAttributes</a>

可以直接在目标页面来通过requestScope或sessionScope获取数据：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
    user:${requestScope.user}
    <br><br>
    sessionUser:${sessionScope.user}

    sessionString:${sessionScope.school}
</body>
</html>

@ModelAttribute

需求的解决

我们现在来做一个数据库的模拟操作，我们现在有一条现有的记录：
字段有id,username,password,email,age
值分别为1,"Tom","123456","tom@cerr.com",12
其中我们想对该记录进行更新操作（模拟），但是其中的id和password不能被修改，我们现在有一个表单如下：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <body>
    <!--
      模型修改操作：
      1.原始数据为：1，Tom，123456，tom@cerr.com,12
      2.密码不能被修改
      3.表单回显，模拟操作直接在表单填写对应的属性值
    -->
    <form action="springmvc/testModelAttribute">
      <input type="hidden" name="id" value="1"/>
      username:<input type="text" name="username" value="Tom"/><br>
      email:<input type="text" name="email" value="tom@cerr.com"/><br>
      age:<input type="text" name="age" value="12"><br>
      <input type="submit" value="Submit">
    </form>
  </body>
</html>

其中的id有一个隐藏域。
如果按照平时的想法，我提交后在后端new一个对象出来，然后把表单提交的值都赋给它，这样去做更新操作的话，则password字段会被丢失（因为我们在表单处并没有password）。

所以这里要使用以下思路：
提交表单之后，后端先从数据库中获取该对象（此处是模拟，所以是直接new出来一个有原来数据的对象），然后再将表单的值赋值给该对象，直接使用该对象，这样的话password字段就不会丢失了。

在此处我们先使用到 @ModelAttribute注解，下面再给予解释：

package com.cerr.springmvc.handlers;
import com.cerr.springmvc.entities.User;
import org.omg.PortableInterceptor.SYSTEM_EXCEPTION;
import org.springframework.stereotype.Controller;
import org.springframework.util.concurrent.SuccessCallback;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Arrays;
import java.util.Date;
import java.util.Map;

@RequestMapping("/springmvc")
@Controller
public class SpringMVCTest {
    private static final String SUCCESS = "success";

    /**
     * 有@ModelAttribute标记的方法，会在每个目标方法执行之前被SpringMVC调用
     * @param id
     * @param map
     */
    @ModelAttribute
    public void getUser(@RequestParam(value = "id",required = false) Integer  id,
            Map<String,Object> map){
        if (id != null){
            User user = new User(1,"tom","123456","tom@cerr.com",12);
            System.out.println("从数据库中获取一个对象:"+user);
            map.put("user",user);
        }
    }

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

@ModelAttribute的运行原理

对于上述的控制器类中，运行流程如下：

执行@ModelAttribute注解修饰的方法，从数据库中取出对象，把对象放入到Map中，键为user
SpringMVC从Map中取出User对象，并把表单的请求参数赋给该User对象的对应属性。
SpringMVC把上述对象传入目标方法的参数。

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

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

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

确定一个key
若目标方法的POJO类型的参数没有使用@ModelAttribute作为修饰，则key为POJO类名第一个字母的小写；若使用了@ModelAttribute来修饰，则key为@ModelAttribute注解的value属性值。
在implicitModel中查找key对应的对象，若存在，则作为入参传入
若在ModelAttribute标记的方法中在Map中保存过，且该key与第一步中确定的key一直，则会获取到。
若implicitModel中不存在key对应的对象，则检查当前的Handler是否使用@SessionAttributes注解修饰。
若使用了该注解，且@SessionAttributes注解的value属性值中包含了key，则从HttpSession中来获取key所对应的value值，若存在则直接传入到目标方法的入参中，若不存在则抛出异常。
若Handler没有标识@SessionAttributes注解或@SessionAttributes注解的value值不包含key，则会通过反射来创建POJO类型的参数，传入为目标方法的参数。
SpringMVC会把key和value传入到implicitModel中，进而会保存到request中。

关于@ModelAttribute的两种用法

有@ModelAttribute标记的方法，会在每个目标方法执行之前被SpringMVC调用
@ModelAttribute注解也可以来修饰目标方法POJO类型的入参，其value属性值有如下的作用：
（1）SpringMVC会使用value属性值在implicitModel中查找对应的对象，若存在则会直接传入到目标方法的入参中
对于上面需求解决的控制器代码，在@ModelAttribute标注的方法中我们在添加模型数据的时候给user对象的key值为入参类型的第一个字母小写，而我们现在想将该名字取为任意名字，那么可以这样操作，第一步是将@ModelAttribute标注的方法代码中在模型中添加数据时的key名修改。

    @ModelAttribute
    public void getUser(@RequestParam(value = "id",required = false) Integer  id,
            Map<String,Object> map){
        if (id != null){
            User user = new User(1,"tom","123456","tom@cerr.com",12);
            System.out.println("从数据库中获取一个对象:"+user);
            //不再使用入参类型的第一个字母的小写作为key值
            map.put("abc",user);
        }
    }

第二步是在我们需要使用到该数据的方法的入参中添加@ModelAttribute注解标注POJO类型入参的名字，例如此处的入参应写为@ModelAttribute(value = "abc") User user：

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

（2）SpringMVC会以value为key，POJO类型的对象为value，存入到request中。
对于value，如果使用了（1），则value就是@ModelAttribute的value；如果没有使用该注解，则value就是入参类型的第一个字母小写。

人面猴
序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
沈念sama阅读 214,029评论 6赞 493
死咒
序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
沈念sama阅读 91,238评论 3赞 388
救了他两次的神仙让他今天三更去死
文/潘晓璐我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
开封第一讲书人阅读 159,576评论 0赞 349
道士缉凶录：失踪的卖姜人
文/不坏的土叔我叫张陵，是天一观的道长。经常有香客问我，道长，这世上最难降的妖魔是什么？我笑而不...
开封第一讲书人阅读 57,214评论 1赞 287
港岛之恋（遗憾婚礼）
正文为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
茶点故事阅读 66,324评论 6赞 386
恶毒庶女顶嫁案：这布局不是一般人想出来的
文/花漫我一把揭开白布。她就那样静静地躺着，像睡着了一般。火红的嫁衣衬着肌肤如雪。梳的纹丝不乱的头发上，一...
开封第一讲书人阅读 50,392评论 1赞 292
城市分裂传说
那天，我揣着相机与录音，去河边找鬼。笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。我是一名探鬼主播，决...
沈念sama阅读 39,416评论 3赞 412
双鸳鸯连环套：你想象不到人心有多黑
文/苍兰香墨我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
开封第一讲书人阅读 38,196评论 0赞 269
万荣杀人案实录
序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
沈念sama阅读 44,631评论 1赞 306
护林员之死
正文独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋以下内容为张勋视角年9月15日...
茶点故事阅读 36,919评论 2赞 328
白月光启示录
正文我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
茶点故事阅读 39,090评论 1赞 342
活死人
序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
沈念sama阅读 34,767评论 4赞 337
日本核电站爆炸内幕
正文年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
茶点故事阅读 40,410评论 3赞 322
男人毒药：我在死后第九天来索命
文/蒙蒙一、第九天我趴在偏房一处隐蔽的房顶上张望。院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
开封第一讲书人阅读 31,090评论 0赞 21
一桩弑父案，背后竟有这般阴谋
文/苍兰香墨我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。一阵脚步声响...
开封第一讲书人阅读 32,328评论 1赞 267
情欲美人皮
我被黑心中介骗来泰国打工，没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。一个月前我还...
沈念sama阅读 46,952评论 2赞 365
代替公主和亲
正文我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
茶点故事阅读 43,979评论 2赞 351

SpringMVC学习笔记 | SpringMVC中处理模型数据的几种方法（ModelAndView|@SessionAttributes|@ModelAttribute）以及运行原理

处理模型数据

ModelAndView

Map或Model

@SessionAtttibutes

@ModelAttribute

需求的解决

@ModelAttribute的运行原理

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

关于@ModelAttribute的两种用法

推荐阅读更多精彩内容