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

处理模型数据

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

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

ModelAndView

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

添加模型数据的方法

  • ModelAndView addObject(String attributeName,Object attributeValue);
  • ModelAndView addAllObject(Map 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;
    }
}

链接:testModelAndView

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

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    Title


    time:${requestScope.time}


Map或Model

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

其原理具体步骤:

  • SpringMVC在调用方法前会创建一个隐含的模型对象作为模型数据的存储容器。
  • 如果方法的入参为MapModel类型,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  map){
        map.put("names", Arrays.asList("Tom","Jerry","Mike"));
        System.out.println(map.get("names"));
        return SUCCESS;
    }
}

链接:testMap

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

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    Title


    names:${requestScope.names}


@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 map){
        User user = new User("Tom","123456","[email protected]",15);
        map.put("user",user);
        map.put("school","School");
        return SUCCESS;
    }
}

链接:testSessionAttributes

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

<%@ page contentType="text/html;charset=UTF-8" language="java" %>


    Title


    user:${requestScope.user}
    

sessionUser:${sessionScope.user} sessionString:${sessionScope.school}

@ModelAttribute

需求的解决

我们现在来做一个数据库的模拟操作,我们现在有一条现有的记录:
字段有id,username,password,email,age
值分别为1,"Tom","123456","[email protected]",12
其中我们想对该记录进行更新操作(模拟),但是其中的id和password不能被修改,我们现在有一个表单如下:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>

  
    $Title$
  
  
    
    
username:
email:
age:

其中的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 map){
        if (id != null){
            User user = new User(1,"tom","123456","[email protected]",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 map){
        if (id != null){
            User user = new User(1,"tom","123456","[email protected]",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就是入参类型的第一个字母小写。

你可能感兴趣的:(SpringMVC学习笔记 | SpringMVC中处理模型数据的几种方法(ModelAndView|@SessionAttributes|@ModelAttribute)以及运行原理)