SpringMVC-- @ModelAttribute注解

标签: SpringMVC的ModelAttribute注解 SpringMVC知识点 @ModelAttribute注解
17人阅读 评论(0) 收藏 举报
分类:

 @ModelAttribute注解

1.   @ModelAttribute注解之使用场景


2.   @ModelAttribute注解之示例代码

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

l  在方法的入参前使用@ModelAttribute 注解:可以从隐含对象中获取隐含的模型数据中获取对象,再将请求参数绑定到对象中,再传入入参

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

①    页面表单

<!--测试 @ModelAttribute 类似Struts2框架的模型驱动 -->

<!--

模拟修改操作:

1.原始数据为:1,Tom,123456,tom@xypuxing.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@xypuxing.com"/><br>

age: <input type="text" name="age" value="12"/><br>

<input type="submit" value="Submit"/>                

</form>

②    增加@ModelAttribute注解

//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@xypuxing.com",12);

System.out.println("从数据库中查询的对象:user="+user );

map.put("user", user);

}

}

③    测试

④    异常

//org.springframework.web.HttpSessionRequiredException: Sessionattribute 'user' required - not found in session

//出现这个异常,是@SessionAttributes(value={"user"},types={String.class})导致的,去掉类上的这个注解

3.   @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 ""; 

}

4.   @ModelAttribute注解之运行原理★

l  运行原理:

①    执行@ModelAttribute注解所修饰的方法,将从数据库中获取的对象存放到Map集合中,keyuser

②    SpringMVC从Map集合中获取 user对象,将表单数据封装到与参数名称对应的user对象属性上

③    SpringMVC将user对象作为参数,传递给目标方法。

④    注意:@ModelAttribute 注解修饰的方法中,放入到Map集合中的key值,应该和目标方法参数类型的类名称首字母小写一致。

5.   @ModelAttribute注解之源码分析★

l  源代码分析的流程

①    调用@ModelAttribute 注解修饰的方法. 实际上把 @ModelAttribute 方法中 Map 中的数据放在了 implicitModel 中.

②    解析请求处理器的目标参数, 实际上该目标参数来自于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 作为参数传递给目标方法的入参.

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

①    确定一个 key:

      1). 若目标方法的 POJO 类型的参数木有使用@ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写

      2). 若使用了@ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值.

②    在 implicitModel 中查找 key 对应的对象, 若存在, 则作为入参传入

      1). 若在 @ModelAttribute 标记的方法中在 Map 中保存过, 且 key 和① 确定的 key 一致, 则会获取到.

③    若 implicitModel 中不存在 key 对应的对象, 则检查当前的 Handler 是否使用@SessionAttributes 注解修饰,

④    若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从 HttpSession 中来获取 key 所对应的 value 值, 若存在则直接传入到目标方法的入参中. 若不存在则将抛出异常.

⑤    若 Handler 没有标识 @SessionAttributes 注解或@SessionAttributes 注解的 value 值中不包含 key, 则会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数

⑥    SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中.

7.   @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@xypuxing.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>      

 

8.   @sessionAttributes注解引发的异常

①     由@SessionAttributes引发的异常

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

 

查看评论

springmvc的ModelAttribute注解

参考资料:spring-framework-reference的Using @ModelAttribute on a method和Using @ModelAttribute on a method ...
  • xiejx618
  • xiejx618
  • 2015-02-08 16:59:32
  • 53966

Spring MVC @ModelAttribute注解总结

Spring MVC @ModelAttribute注解使用总结
  • mytt_10566
  • mytt_10566
  • 2017-04-14 15:36:36
  • 878

@ModelAttribute注解的作用

1.@ModelAttribute注释void返回值的方法 [java] view plain copy print? @Controller  pu...
  • Sky786905664
  • Sky786905664
  • 2016-08-23 14:51:54
  • 11153

深入理解@ModelAttribute注解的工作过程

在SpringMVC中,我们可以通过使用@ModelAttribute注解标记方法,实现类似于Struts2中Preparable拦截器的效果,其使用方法我们已经在《SpringMVC中如何处理模型数...
  • xiangwanpeng
  • xiangwanpeng
  • 2016-11-07 19:46:50
  • 469

Spring @ModelAttribute注解用法

之前项目中并自己并没有怎么使用到过@ModelAttribute这个注解,接手一个老项目的时候发现项目中大量使用@ModelAttribute这个注解,在这里就整理下这个注解常用的方式,也为自己做个记...
  • Harry_ZH_Wang
  • Harry_ZH_Wang
  • 2017-02-26 02:38:50
  • 16981

SpringMVC重要注解(四)@ModelAttribute

在 SpringMVC 的 Controller 中使用 @ModelAttribute 时,应用位置包括下面几种: 1、应用在方法上。  2、应用在方法的参数上。  3、应用在方法上,并且方法也...
  • dreamsunday
  • dreamsunday
  • 2017-12-22 14:39:52
  • 4822

Spring中@ModelAttribute注解用法小结

该注解的具体用法,在编程人生的博客中已经写得较为详细和到位了,附上链接http://blog.csdn.net/li_xiao_ming/article/details/8349115, 在此向编程人...
  • iamihanfei
  • iamihanfei
  • 2016-10-07 09:20:58
  • 1745

SpringMVC中@ModelAttribute注解的作用

1.@ModelAttribute注释void返回值的方法 [java] view plain copy   print? @C...
  • ak57193856
  • ak57193856
  • 2017-09-07 11:04:15
  • 335

@ModelAttribute注解的使用

先看一下,spring官方给的解释: @ModelAttribute has two usage scenarios in controllers. When you place it on a m...
  • u010408365
  • u010408365
  • 2016-01-06 16:20:25
  • 4563
    个人资料
    持之以恒
    等级:
    访问量: 8510
    积分: 1000
    排名: 5万+
    文章存档
    最新评论