SpringMVC - 处理模型数据

最新推荐文章于 2021-12-10 11:25:02 发布

LuckyAzrael

最新推荐文章于 2021-12-10 11:25:02 发布

阅读量185

点赞数

分类专栏：笔记文章标签： java springmvc

本文链接：https://blog.csdn.net/LuckyAzreal/article/details/113062934

版权

笔记专栏收录该内容

48 篇文章 0 订阅

订阅专栏

SpringMVC - 处理模型数据

处理模型数据

处理模型数据

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

ModelAndView

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

/**
 * 目标方法的返回值可以是 ModelAndView 类型
 * 其中可以包含视图和模型信息
 * SpringMVC 会把 ModelAndView 的Model中的数据放到request域对象中。
 */
@RequestMapping("/testModelAndView")
public ModelAndView testModelAndView(){
    String viewName = SUCCESS;
    ModelAndView modelAndView = new ModelAndView(viewName);
    //添加模型数据到modelAndView中
    modelAndView.addObject("time",new Date());
    return modelAndView;
}

index.jsp(测试页面)

<a href="springMVCTest/testModelAndView">Test ModelAndView</a>

success.jsp(成功页面)

time:${requestScope.time}

Map及Model

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

/**
 * 目标方法可以添加Map类型(实际上也可以是Model类型或ModelMap类型)的参数。
 */
@RequestMapping("/testMap")
public String testMap(Map<String,Object> map){
    System.out.println(map.getClass().getName());
    map.put("names", Arrays.asList("Tom","Jerry","Mike"));
    return SUCCESS;
}

index.jsp

<a href="springMVCTest/testMap">Test Map</a>

success.jsp

names:${requestScope.names}

@SessionAttributes

若希望在多个请求之间公用某个模型属性数据，则可以在控制器类上标注一个@SessionAttributes，SpringMVC将在模型中对应的属性暂存到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})

@SessionAttributes({"user"})
@RequestMapping("/springMVCTest")
@Controller
public class SpringMVCTest {
    private static final String SUCCESS = "success";
    /**
     * @SessionAttributes 除了可以通过属性名指定需要放到会话中的属性外（实际上使用的是value属性值），
     * 还可以通过模型属性的**对象类型**指定哪些模型属性需要放到会话中（实际上使用的是types属性值）
     *
     * 注意：该注解只能修饰类，而不能修饰方法
     */
    @RequestMapping("/testSessionAttributes")
    public String testSessionAttributes(Map<String,Object> map){
        User user =new User("Tom","000000","Tom@qd.com",25));
        //当使用了@SessionAttributes后，map.put会将数据同时放入request域和session域中
        map.put("user",user);
        return SUCCESS;
    }
}

index.jsp

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

success.jsp

<!-- 当使用了@SessionAttributes后，map.put会将数据同时放入request域和session域中 -->
request user:${requestScope.user}
<br/>
session user:${sessionScope.user}

@ModelAttribute

使用@ModelAttribute修饰方法

/**
 * 有 @ModelAttribute 标记的方法，会在每个目标方法执行之前被 SpringMVC 调用！
 */
@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@qd.com",12);
        System.out.println("从数据库中获取一个对象：" + user);
        map.put("user",user);
    }
}
/**
 * 运行流程
 * 1. 执行@ModelAttribute注解修饰的方法：从数据库中取出对象，把对象放入到了Map中。键为：user
 * 2. SpringMVC 从Map中取出User对象，并把表单的请求参数赋给该User对象的对应属性。
 * 3. SpringMVC 把上述对象传入目标方法的参数
 *
 * 注意：在@ModelAttribute修饰的方法中，放入到Map时的键需要和目标方法入参类型的第一个字母小写的字符串一致！
 */
@RequestMapping("/testModelAttribute")
public String testModelAttribute(User user){
    System.out.println("修改：" + user);
    return SUCCESS;
}

index.jsp

<!-- 模拟修改操作
    1. 原始数据为：1，Tom，123456，tom@qd.com,12
    2. 密码不能被修改
    3. 表单回显，模拟操作直接在标点填写对应的值
 -->
<form action="springMVCTest/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@qd.com"/>
    <br/>
    age:<input type="text" name="age" value="12"/>
    <br/>
    <input type="submit" value="submit"/>
</form>

注意：在没有<使用@ModelAttribute修饰的方法>的时候进行测试时请将之前用于测试@SessionAttributes时添加在测试类上方的@SessionAttributes注解去掉或是注释掉，否则会抛出异常，具体原因见<SpringMVC确定目标方法 POJO 类型入参的类型>的第3点

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

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

源码分析的流程：

调用 @ModelAttribute 注解修饰的方法。实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中。
解析请求处理器的目标参数，实际上该目标参数来自于 webDataBinder 对象的 target 属性
1. 创建 WebDataBinder 对象：
  ① 确定 objectName 属性：若传入的 attrName 属性值为空串，则 objectName 为类名的第一个字母小写
  –> * 注意： attrName 若目标方法的 POJO 属性使用了 @ModelAttribute 来修饰，则attrName值即为 @ModelAttribute 的 value 值
  ② 确定 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 给到 ImplicModle 。进而传到 request 域对象中
4. 把 WebDataBinder 的 target 作为参数传递给目标方法的入参

使用@ModelAttribute修饰方法的入参

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

/**
 * 运行流程
 * 1. 执行@ModelAttribute注解修饰的方法：从数据库中取出对象，把对象放入到了Map中。键为：user
 * 2. SpringMVC 从Map中取出User对象，并把表单的请求参数赋给该User对象的对应属性。
 * 3. SpringMVC 把上述对象传入目标方法的参数
 *
 * 注意：在@ModelAttribute修饰的方法中，放入到Map时的键需要和目标方法入参类型的第一个字母小写的字符串一致！
 */
@RequestMapping("/testModelAttribute")
/* 正常情况下（非特殊需求时）一般都使用POJO类名首字母小写作为@ModelAttribute的value，此处仅仅是为了演示 */
public String testModelAttribute(@ModelAttribute("abc") User user){
    System.out.println("修改：" + user);
    return SUCCESS;
}