Spring MVC之@ModelAttribute详解

用法

在 SpringMVC 的 Controller 中使用 @ModelAttribute 时，应用位置包括下面几种：

应用在方法上。
应用在方法的参数上。
应用在方法上，并且方法也使用了@RequestMapping

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

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

@Controller
@RequestMapping("/modelattributeTest")
public class ModelAttributeTestController1 {

    @ModelAttribute
    public void myModel(@RequestParam(required = false) String abc, Model model) {
        model.addAttribute("attributeName", abc);
    }

    @RequestMapping(value = "/test1")
    public String test1() {
        return "modelattributetest/test1";
    }
}

这个例子，在请求/modelattributeTest/test1?abc=aaa后，会先执行 myModel方法，然后接着执行test1方法，参数abc的值被放入Model中后，接着被带到 test方法中。

当返回视图 modelattributetest/test1时，Model 会被带到页面上，当然你在使用 @RequestParam的时候可以使用required来指定参数是否是必须的。

如果把 myModel和 test1 合二为一后的方法可以为，这也是我们最常用的方法：

@RequestMapping(value = "/test2")
public String test1(@RequestParam(required = false) String abc, Model model) {
    model.addAttribute("attributeName", abc);
    return "modelattributetest/test1";
}

在第二个方法的入参前面加入@ModelAttribute注解，SpringMVC会去请求域中找名为xx的User对象。
2）使用 @ModelAttribute 注解带有返回值的方法

@ModelAttribute
public String myModel(@RequestParam(required = false) String abc) {
    return abc;
}

或者

@ModelAttribute
public Student myModel(@RequestParam(required = false) String abc) {
    Student stu = new Student(abc);
     return stu;
}

或者

@ModelAttribute
public int myModel(@RequestParam(required = false) int number) {
     return number;
}

对于这种情况，返回值对象会被默认放到隐含的 Model中，在 Model中的 key为 “返回值首字母小写”，value 为返回的值。

上面3种情况等同于：

model.addAttribute(“string”, abc);
model.addAttribute(“int”, number);
model.addAttribute(“student”, stu);

如果只能这样，未免太局限了，我们很难接受key 为 string、int、float 等等这样的。

想自定义其实很简单，只需要给@ModelAttribute添加value属性即可，如下：

@ModelAttribute(value = "num")
 public int myModel(@RequestParam(required = false) int number) {
    return number;
}

这样就相当于model.addAttribute(“num”, number);

2. 使用@ModelAttribute注解方法的参数

@Controller
@RequestMapping("/modelattributeTest3")
public class ModelAttributeTestController3 {

    @ModelAttribute(value = "attributeName")
    public String myModel(@RequestParam(required = false) String abc) {
        return abc;
    }

    @ModelAttribute
    public void myModel3(Model model) {
        model.addAttribute("name", "SHANHY");
        model.addAttribute("age", "28");
    }

    @RequestMapping(value = "/test1")
    public String test1(@ModelAttribute("attributeName") String str, 
            @ModelAttribute("name") String str2,
            @ModelAttribute("age") String str3) {
        return "modelattributetest/test1";
    }

}

从代码中可以看出，使用 @ModelAttribute注解的参数，意思是从前面的 Model中提取对应名称的属性。

3. 应用在方法上，且方法也使用了@RequestMapping

@Controller
@RequestMapping("/modelattributeTest4")
public class ModelAttributeTestController4 {

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

}

这种情况下，返回值 String （或者其他对象），就不再是视图了。而是我们上面将到的放入 Model 中的值，此时对应的页面就是 @RequestMapping的值 test1。

原理

想要知道这货的原理当然得去阅读源代码，考虑到过程有点复杂这里就直接将楼主的理解和心得贴出来分享给大家吧。

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

注意

最后还要多嘴一句，如果你是将这个注解跟@SessionAttributes注解一起使用的话，一不小心就会抛出这样的异常

发生这样错误的代码我也贴出来吧

@SessionAttributes(value={"user"})
@Controller
public class HelloWorld {
	
	public static final String SUCCESS="success";
	
	@RequestMapping("testModelAttribute")
	public String testModelAttribute(@ModelAttribute("user")User user){
		System.out.println("修改："+user);
		return SUCCESS;
	}
}

原因其实在上面的原理中写的很明白了，这里就不再多说了，大家都是聪明人。