Spring MVC @ModelAttribute注解
在一个Controller内，被@ModelAttribute标注的方法会在此controller的每个handler方法执行前被执行。
被@ModelAttribute标注的方法的参数绑定规则和普通handler方法相同。
可以理解为：
- 请求到达Controller后，不论其他handler方法的RequestMapping值是多少，请求都会路由至被@ModelAttribute标注的方法；
- 由springMVC再对request执行一次forward，路由至真正的handler方法。
一 @ModelAttribute用于注解方法
1 方法返回类型为void
这种情况，@ModelAttribute只是单纯的作为请求路由的第一站，使用者可在方法内部操作Model和Request等参数实现功能。
对于如下请求：
http://localhost:8080/TestModelAttributeController/testHandler.action?reqParam=123
对应的Controller：
@Controller
@RequestMapping("/TestModelAttributeController")
public class TestModelAttributeController { @ModelAttribute
public void modelAttributeMethod(HttpServletRequest request, String reqParam, Model model){
model.addAttribute("reqParam",reqParam);
request.setAttribute("methodParam","Hello ModelAttribute");
} @RequestMapping("/testHandler")
public String testHandler(){
return "testModelAttribute";
}
}
testModelAttribute.jsp如下：
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
<title>Title</title>
</head>
<body>
<h1>${reqParam}</h1>
<h1>${methodParam}</h1>
</body>
</html>
最终可以在页面中看到：
123
Hello ModelAttribute
2 方法返回类型不为void
这种情况，@ModelAttribute会将返回值放到Model中，并将该类型名称的首字母小写作为model中的属性名。
请求地址和参数不变。
对应的Controller：
@ModelAttribute
public User userModelAttributeMethod2(){
User user = new User();
user.setAge(31);
user.setName("James");
user.setEmail("123456@qq.com");
return user; //相当于model.addAttribute("user",user);
} @RequestMapping("/testHandler")
public String testHandler(Model model){
System.out.println(model.containsAttribute("user")); //true
return "testModelAttribute";
}
对应的jsp页面
<h1>${user.age}</h1>
<h1>${user.email}</h1>
<h1>${user.name}</h1>
实际上，对于返回类型为void的方法，@ModelAttribute也会在model中添加一对键值对，“void”->"null"
3 方法返回类型不为void，且@ModelAttribute指定属性名称
这种情况下，@ModelAttribute会将返回值放到Medel中，且对应的key值为@ModelAttribute置顶的属性名
对应的Controller：
@ModelAttribute("myUser")
public User userModelAttributeMethod2(){
User user = new User();
user.setAge(31);
user.setName("James");
user.setEmail("123456@qq.com");
return user; //相当于model.addAttribute("user",user);
}
@RequestMapping("/testHandler")
public String testHandler(Model model){
System.out.println(model.containsAttribute("user")); //true
return "testModelAttribute";
}
对应的jsp页面:
<h1>${myUser.age}</h1>
<h1>${myUser.email}</h1>
<h1>${myUser.name}</h1>
4 @ModelAttribute和@RequestMapping注解同一个方法
这种情况下：
- 在controller处理其他请求时，不会再首先进入被@ModelAttribute和@RequestMapping同时注解的方法；
- 该方法的返回值不再是视图的逻辑名称，而是按照@ModelAttribute的规则被加入到Model中；
- @RequestMapping注解的value值具有两个作用
- 作为URI，实现请求的路由；
- 作为此次请求的逻辑视图名（严格来说此时视图的逻辑视图名是：controller的RequestMapping值+method的RequestMapping值）
@Controller
@RequestMapping("/TestModelAttributeController")
public class TestModelAttributeController { @RequestMapping("/testModelAttribute")
@ModelAttribute("result")
public String testModelAttribute(){
return "excellent";
}
<body>
<h1>${result}</h1>
</body>
如上Controller和jsp：
testModelAttribute方法的作用是：
- 处理路径为 /TestModelAttributeController/testModelAttribute*的请求
- 将键值对"result"->"excellent"放至model中，为视图渲染提供数据
- 返回逻辑视图名 /TestModelAttributeController/testModelAttribute
二 @ModelAttribute注解方法入参
@ModelAttribute("attrName")用在方法入参上时，作用为:
- 从当前的隐式model对象中取key值attrName所对应的attrValue值，并将attrValue赋给被注解的参数。
- 而且自动暴露为模型数据用于视图页面展示时使用
1 @ModelAttribute指定注解的value值attrName
如下所示，myUser和newParam两个model属性对应的attrValue值，将被赋值给方法入参。
@ModelAttribute("myUser")
public User userModelAttributeMethod2(Model model){
User user = new User();
user.setAge(31);
user.setName("James");
user.setEmail("123456@qq.com");
model.addAttribute("newParam","new parameter");
return user;
}
@RequestMapping("/testHandler")
public String testHandler(@ModelAttribute("myUser") User user,@ModelAttribute("newParam") String newParam){
System.out.println(user);
System.out.println(newParam);
return "testModelAttribute";
2 @ModelAttribute注解value值缺省
这时默认的attrName为类型名称的首字母小写。
如下例，user能够从model中获取，但是 newParam从model中获取的值为null
@ModelAttribute("user") //此处必须是 user
public User userModelAttributeMethod2(Model model){
User user = new User();
user.setAge(31);
user.setName("James");
user.setEmail("123456@qq.com");
model.addAttribute("newParam","new parameter");
return user;
}
@RequestMapping("/testHandler")
public String testHandler(@ModelAttribute User user,@ModelAttribute String newParam){
System.out.println(user);
System.out.println(newParam);
return "testModelAttribute";
}
3 入参不使用@ModelAttribute注解
这种情况下，简单类型参数不会从model中取值，简单类型定义由 org.springframework.beans.BeanUtils#isSimpleValueType指定，如下：
/**
* Check if the given type represents a "simple" value type:
* a primitive, an enum, a String or other CharSequence, a Number, a Date,
* a URI, a URL, a Locale or a Class.
* @param clazz the type to check
* @return whether the given type represents a "simple" value type
*/
public static boolean isSimpleValueType(Class<?> clazz) {
return (ClassUtils.isPrimitiveOrWrapper(clazz) ||
Enum.class.isAssignableFrom(clazz) ||
CharSequence.class.isAssignableFrom(clazz) ||
Number.class.isAssignableFrom(clazz) ||
Date.class.isAssignableFrom(clazz) ||
URI.class == clazz || URL.class == clazz ||
Locale.class == clazz || Class.class == clazz);
}
非简单类型会从model中取值，这时默认的attrName为类型名称的首字母小写。
如下例，user能够从model中获取，但是newParam是简单类型，所以不会从model中取值。
4 使用request参数和@ModelAttribute同时为同一个入参赋值
这种情况需要根据入参的类型区别对待
- 对于非简单类型，spring会先使用@ModelAttribute为参数赋值，然后使用request的参数对入参的属性值进行覆盖；
- 对于简单类型，spring会使用@ModelAttribute为参数赋值，忽略request参数；
如下例所示，URL为：
这时user的name和age属性最终会被设置为request对应的参数值（也就是实现了对象合并），而reqParam的值最终会采用@ModelAttribute得到的值。
@ModelAttribute("user") //此处必须是 user
public User userModelAttributeMethod2(Model model){
User user = new User();
user.setAge(31);
user.setName("James");
user.setEmail("123456@qq.com");
model.addAttribute("reqParam","from @ModelAttribute");
return user;
}
@RequestMapping("/testHandler")
public String testHandler( @ModelAttribute("user") User user, @ModelAttribute("reqParam") String reqParam){
System.out.println(user); //user 对象的属性会被request的参数覆盖
System.out.println(reqParam); //reqParam参数的值始终是@ModelAttribute中的值，不会被覆盖
return "testModelAttribute";
}
三 @ModelAttribute注解方法返回值
此时@ModelAttribute的作用是将返回值添加至model，而这时的逻辑视图名称为：controller的RequestMapping值+method的RequestMapping值。
其实，这种用法和 @ModelAttribute和@RequestMapping注解同一个方法相同。
Spring MVC @ModelAttribute注解的更多相关文章
- spring mvc 基于注解的使用总结
本文转自http://blog.csdn.net/lufeng20/article/details/7598801 概述 继 Spring 2.0 对 Spring MVC 进行重大升级后,Sprin ...
- Spring MVC学习总结（2）——Spring MVC常用注解说明
使用Spring MVC的注解及其用法和其它相关知识来实现控制器功能. 02 之前在使用Struts2实现MVC的注解时,是借助struts2-convention这个插件,如今我们使 ...
- 基于spring mvc的注解DEMO完整例子
弃用了struts,用spring mvc框架做了几个项目,感觉都不错,而且使用了注解方式,可以省掉一大堆配置文件.本文主要介绍使用注解方式配置的spring mvc,之前写的spring3.0 mv ...
- java spring mvc 全注解
本人苦逼学生一枚,马上就要毕业,面临找工作,实在是不想离开学校.在老师的教导下学习了spring mvc ,配置文件实在繁琐,因此网上百度学习了spring mvc 全注解方式完成spring的装配工 ...
- spring mvc 基于注解 配置默认 handlermapping
spring mvc 是类似于 Struts 的框架.他们都有一个最主要的功能就是URL路由.URL路由能将请求与响应请求处理逻辑的类(在Struts中即是action,在spring mvc 中即是 ...
- 全面解析Spring中@ModelAttribute注解的用法
本文不再更新,可能存在内容过时的情况,实时更新请移步我的新博客:全面解析Spring中@ModelAttribute注解的用法: @ModelAttribute注解用于将方法的参数或方法的返回值绑定到 ...
- [Spring MVC] - @ModelAttribute使用
在Spring MVC里,@ModelAttribute通常使用在Controller方法的参数注解中,用于解释model entity,但同时,也可以放在方法注解里. 如果把@ModelAttrib ...
- Spring MVC Framework 注解
ControllerAdvice Spring MVC Framework会把 @ControllerAdvice注解内部使用 @ExceptionHandler.@InitBinder.@Model ...
- Spring MVC 基本注解
1. Spring MVC 常用到的注解: @Controller @RequestMapping @RequestParam @RequestHeader @ModelAttribute @Path ...
随机推荐
- 关于Nginx
访问 www.a.com 自动跳到 www.b.com(301跳转设置) server { listen 80; server_name www.a.com; rewrite ^/(.*)$ htt ...
- AI 偏微分方程
1.微分dx: 高阶无穷小 偏微分方程
- （转）用graph-easy描绘kubenetes描绘k8s组件逻辑图
1.参考: https://xuxinkun.github.io/2018/09/03/graph-easy/ http://bloodgate.com/perl/graph/manual/faq.h ...
- BesLyric 全新版本下载 （ windows \ mac \ linux ）
导读 BesLyric , 一款专门制作 网易云音乐 LRC 滚动歌词的软件! 搜索.下载.制作 歌词更方便! 很荣幸地,自 beslyric 2017 年开发推出以来,得到了很多云村村民的肯定,现在 ...
- linux中断源码分析 - 初始化(二)
本文为原创,转载请注明:http://www.cnblogs.com/tolimit/ 本篇文章主要讲述源码中是如何对中断进行一系列的初始化的. 回顾 在上一篇概述中,介绍了几个对于中断来说非常重要的 ...
- SkylineGlobe 如何二次开发实现天际线分析功能
天际线效果: 示例代码: <!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <h ...
- 手机端@media的屏幕适配
@media only screen and (width: 320px) { html { font-size: 16px; }} @media only screen and (width: 36 ...
- MVC4程序运行报错
近期了解MVC4的时候弄了一个简单的小工程,使用Entity Framework作为Model,F5启动调试运行的时候没有问题,但是发布到IIS之后访问就报错 错误信息如下: The Entity F ...
- ngx_lua 模块
ngx_lua模块的原理: 1.每个worker(工作进程)创建一个Lua VM,worker内所有协程共享VM:2.将Nginx I/O原语封装后注入 Lua VM,允许Lua代码直接访问:3.每个 ...
- Openstack部署踩坑
第一周: 使用kola部署Openstack,vip_address有问题,双网上也不行,就是部署不了,但all-in-one却可以,可是节点不会加. 第二周: 使用Packstack部署Openst ...