@ModelAttribute用法详解
在学习SpringMVC的过程中,关于@ModelAttribute的使用方法一度遇到一些奇怪的问题,在深入研究源码之后,基本上弄清楚了其内部实现的原理。对于自己的理解有误区的地方进行了纠正,现进行总结如下:@ModelAttribute主要有如下两个功能:
1绑定请求参数到实体对象(表单的命令对象):一是将请求参数的输入封装到POJO对象中;二是创建具体实例,以value为键值存储在Model对象中
2.注解一个非请求处理方法
1.实际感知
案例场景:用户首先注册之后实现登录跳转。(忽略设计缺陷,不是重点)注册过程:验证@ModelAttribute
1.未使用ModelAttribute 结果:
2. 使用ModelAttribute注解
结果:
前台页面结果:
结论:在使用ModelAttribute注解和不使用注解的情况下,二者等价,在不使用注解的情况下,其实底层已经默认在其前面加上了注解,无需显示添加,二者均可实现具体的数据绑定以及传递数据。
登陆过程:验证@ModelAttribute特殊用法和注意事项
1.不使用注解方式,注意POJO类的对象名与之前的不同
2.使用注解方式,注意POJO类的对象名与之前的不同
3.使用注解方式并赋予value属性,注意POJO类的对象名与之前的不同
结果:
1)前两种情况结果:
2)第三种情况结果
结论:
在使用ModelAttribute注解和不使用注解的情况下,二者等价,前端页面获取具体数据时,使用的方式是POJO类名首字母小写得到的对象名.属性名;
当使用value赋值后,此时获取具体数据时,使用的方式是value值.属性名;
最终结论:使用ModelAttribute注解进行数据绑定时,该参数可以省略不写,前台页面获取数据时使用的是POJO类名首字母小写得到的对象名.属性名;当使用ModelAttribute注解并添加value属性值时,此时前台页面获取数据时使用的是value值.属性名。
2.ModelAttribute源码以及规则
@Target({ElementType.PARAMETER, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Documented public @interface ModelAttribute {/**
* Alias for {@link #name}.
*/
@AliasFor("name")
String value() default "";
/**
* 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<mypackage.OrderAddress>".
* @since 4.3
*/
@AliasFor("value")
String name() default "";
/**
* Allows declaring data binding disabled directly on an {@code @ModelAttribute}
* method parameter or on the attribute returned from an {@code @ModelAttribute}
* method, both of which would prevent data binding for that attribute.
* <p>By default this is set to {@code true} in which case data binding applies.
* Set this to {@code false} to disable data binding.
* @since 4.3
*/
boolean binding() default true;
}
通过源码中,可以看出name()和value()方法二者等价,二者相互使用@AliasFor(“”)进行标记,通过注释中,可以看出:其在进行数据绑定时的规则,总共有两个规则:
规则一:若目标方法的 POJO 类型的参数没有使用 @ModelAttribute 作为修饰, 则 key 为 POJO 类名第一个字母的小写;
规则二:若目标方法的 POJO 类型的参数使用了@ModelAttribute 来修饰, 则 key 为 @ModelAttribute 注解的 value 属性值。
3.ModelAttribute执行流程
第1步: 执行 @ModelAttribute 注解修饰的方法,实际上把 @ModelAttribute 方法中 Map 中的数据user放在一个BindingAwareModelMap类型的对象中。
第2步:
第一:确定查找键值对所需要的键(key):遵循上述两条规则
第二:在 BindingAwareModelMap类型的对象中查找 key 对应的对象:
第三:,用表单中传递过来的参数值去更新确定的value值(或通过反射建立的对象)。
第3步:SpringMVC 把上述对象作为参数传入目标方法。
在进行页面读取数据时,要根据上述规则,采用相应的方式获取数据:
若目标方法的 POJO 类型的参数没有使用 @ModelAttribute 或使用了该注解但没有给定value值作为修饰, 则获取数据时应为 POJO 类名第一个字母的小写.属性名;
若目标方法的 POJO 类型的参数使用了@ModelAttribute 来修饰, 则获取数据时应为 @ModelAttribute 注解的 value 属性值.属性名。
4.说明
以上内容是个人的观点和理解,如果有什么不对或者不理解的地方,敬请指正。