springmvc基础知识（20）：@ModelAttribute 的使用

雨点打透心脏的1/2处 2022-05-24 11:58 155阅读 0赞

![这里写图片描述][70]

查看 @ModelAttribute注解定义可以看到这个注解可以用在方法和参数中。  
在 SpringMVC 的 Controller 中使用 @ModelAttribute 时，应用情况包括下面几种：  
1、应用在方法上。  
2、应用在方法的参数上。  
3、应用在方法上，并且方法也使用了@RequestMapping

首先说明一下，被 @ModelAttribute 注释的方法会在Controller每个方法执行之前都执行，因此对于一个Controller中包含多个URL的时候，要谨慎使用。

## 应用在方法上 ##

使用@ModelAttribute注解的方法和被@RequestMapping注解的处理方法由很多相似之处:

*  都可以通过入参接收前台提交的数据，而且对入参绑定的设置都是一样的。
 *  入参绑定的数据如果没有设置可为空，不能接收空数据,否则会报错。
 *  都可以将数据放入model中，而且对于一次请求,model是共享的,所以在处理方法中的model中存放了@ModelAttribute注解的方法中存放的数据。

**1) 使用 @ModelAttribute 注解无返回值的方法**

举例说明一下：

*  处理器

@ModelAttribute
    public void getUser(@RequestParam(value="userName",required=false) String userName,Model model){
    
        User user = new User(userName,"123456");
        model.addAttribute("user", user);
    }

@ModelAttribute注解getUser方法,getUser方法接收前台提交的userName数据,在model中放入user属性和数据。

@RequestMapping("/testModelAttribute")
    public String testModelAttribute(ModelMap model){
        System.out.println("testModelAttribute user:"+model.get("user"));
        return "success";
    }

处理方法的入参引入model，由于是同一个请求,所以这个model中存放了@ModelAttribute注解的方法存入的数据。

*  测试页面

<form action="testModelAttribute" method="post">
        用户名:<input type="text" name="userName" value="jack">
        <button type="submit">submit</button>
    </form>

![这里写图片描述][70 1]

*  点击提交

![这里写图片描述][70 2]

*  跳转到success.jsp页面

<h2>success 访问成功！</h2>
    
    ${user}

![这里写图片描述][70 3]

**2) 使用 @ModelAttribute 注解带有返回值的方法**

@ModelAttribute
    public User getUser(@RequestParam(value="userName",required=false) String userName){
    
        User user = new User(userName,"123456");
        return user;
    }

这种情况不用显示的向model中放数据，返回的数据会被隐含地放入到model中，在 model 中的 key 为 “返回类型首字母小写”，value 为返回的值。  
上面相当于`model.addAttribute("user", user);`  
但是这样会很有局限性，我们可以使用@ModelAttribute的value属性值设置存放在model中的属性key值:

@ModelAttribute("user1")
    public User getUser(@RequestParam(value="userName",required=false) String userName,Model model){
    
        User user = new User(userName,"123456");
        return user;
    }

上面将key值修改为user1,相当于`model.addAttribute("user1", user);`

--------------------

## 应用在方法的参数上 ##

看代码：

@ModelAttribute("user")
    public User getUser(Model model){
    
        User user = new User("Tom","123456");
        return user;
    }
    
    @RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("user")User user1,Model model){
        System.out.println("testModelAttribute User:"+user1);
        System.out.println("testModelAttribute model:"+model.toString());
        return "success";
    }

*  测试页面

<form action="testModelAttribute" method="post">
        用户名:<input type="text" name="userName" value="Jack">
        <button type="submit">submit</button>
    </form>

![这里写图片描述][70 4]

执行结果:  
![这里写图片描述][70 5]

在处理方法的入参中使用了`@ModelAttribute("user")User user1`  
执行流程  
1.springmvc 解析本次请求共享的model（BindingAwareModelMap），  
由于先被getUser方法处理过，model里面保存了  
`user=User[userName=Tom, password=123456]`的数据。  
2.从model中取出key为user的User对象，并把表单的请求参数赋给这个User对象的对应属性。因为这里前台只传递了 一个参数userName = Jack,所以经过处理这时候的model数据为`user=User[userName=Jack, password=123456]`userName被覆盖。  
3.SpringMVC 把上述对象传入目标的参数user1中。

**注意:也可以使用@ModelAttribute修饰,这样会默认使用入参类型第一个字母小写去model中匹配**

看下下面这种情况:

@ModelAttribute("user")
    public User getUser(Model model){
    
        User user = new User("Tom","123456");
        return user;
    }

首先getUser方法在model中放入key为user的User对象`user=User[userName=Tom, password=123456]`

@RequestMapping("/testModelAttribute")
    public String testModelAttribute(@ModelAttribute("newUser")User user,Model model){
        System.out.println("testModelAttribute User:"+user);
        System.out.println("testModelAttribute model:"+model.toString());
        return "success";
    }

然后处理方法中使用@ModelAttribute(“newUser”)User user  
执行流程：  
1.springmvc 解析本次请求共享的model（BindingAwareModelMap），  
由于先被getUser方法处理过，model里面保存了  
`user=User[userName=Tom, password=123456]`的数据。  
2.从model中去取key为newUser的User对象，**这时候发现没有,那么就去新建一个User对象，并把表单的请求参数赋给这个User对象的对应属性，然后将之绑定到入参中**。这时候Model中就存放了两个User对象。因为这里前台只传递了 一个参数userName = Jack,所以经过处理这时候的model数据为`user=User[userName=Tom,password=123456]`和  
`newUser=User[userName=Jack, password=null]`。  
3.SpringMVC 把上述新建的User对象newUser传入目标的参数user中。  
![这里写图片描述][70 6]

--------------------

## 应用在方法上，并且方法也使用了@RequestMapping ##

如下代码：

@RequestMapping(value = "/test1")
    @ModelAttribute("name1")
    public String test1(@RequestParam(required = false) String name) {
       return name;
    }

这种情况下，返回值 String （或者其他对象），就不再是视图了。还是我们上面讲到的放入 Model 中的值，对应的key为注解指定的name1，此时对应的页面就是 @RequestMapping 的值 test1，交给页面解析后就是test1.jsp

[70]: /images/20220524/54a08ee9b6c246bf849fd4119ae45c27.png
[70 1]: /images/20220524/293dfc36cb904ae69cfd671c01072373.png
[70 2]: /images/20220524/278a7fafa44446d2a64b58603575f4ca.png
[70 3]: /images/20220524/455dccd9ce9740b58961632e95e0792f.png
[70 4]: /images/20220524/bc19e70d95fc46058f76f7c87a2619d8.png
[70 5]: /images/20220524/8e77c8c8cb5c469f97e05857b1e6c117.png
[70 6]: /images/20220524/23199ff3a9c747f38038bd28960f4cda.png