Spring注解--@ModelAttribute

Spring注解–@ModelAttribute

@ModelAttribute使用详解

你好！ 这是你第一次使用 Markdown编辑器 所展示的欢迎页。如果你想学习如何使用Markdown编辑器, 可以仔细阅读这篇文章，了解一下Markdown的基本语法知识。

1.@ModelAttribute注释方法

被@ModelAttribute注释的方法会在此controller每个方法执行前被执行，前台访问后台通过将要访问的Controller先执行@ModelAttribute注释的方法，执行之后才进入到目标路径方法内

1. @ModelAttribute注释void返回值的方法

     @ModelAttribute
    public void populateModel(@RequestParam String abc, Model model) {
        model.addAttribute("attributeName", abc);
    }

    @ResponseBody
    @RequestMapping("/hello")
    public String sayHello() {
        System.out.println("我是处理请求的Conller");

        return "hello";

    }

这个例子，在获得请求/hello 后，populateModel方法在helloWorld方法之前先被调用，同时访问路径也发生改变由原来的“/hello”变成“/hello?abc=xxx”例如：“/hello?abc=text” 。它把请求参数abc=test加入到一个名为attributeName的model属性中，在它执行后 hello被调用，返回视图名hello和model已由@ModelAttribute方法生产好了。前台发送一次请求，后台有俩个方法处理。
　　这个例子中model属性名称和model属性对象有model.addAttribute()实现，不过前提是要在方法中加入一个Model类型的参数。
　　当URL或者post中不包含次参数（abc=test）时，会报错，其实不需要这个方法，完全可以把请求的方法写成，这样缺少此参数也不会出错

 @RequestMapping(value = "/hello") 
 public String hello(String abc) { 
    return "hello"; 
}

2. @ModelAttribute注释返回具体类的方法 ;

@ModelAttribute 
 public Person addPerson(@RequestParam String name) { 
     return persontManager.findPerson(name); 
} 

这种情况，标注@ModelAttribute同样也是创建了一个model，model属性的名称没有指定，它由返回类型隐含表示，如这个方法返回Person类型，那么这个model属性的名称是person。model属性名称由返回对象类型隐含表示，model属性对象就是方法的返回值。它无须要特定的参数。

3. @ModelAttribute(value="")注释返回具体类的方法

   @Controller 
 2 public class HelloController { 
 3     @ModelAttribute("attributeName") 
 4     public String addPerson(@RequestParam String abc) { 
 5         return abc; 
 6       } 
 7 
 8     @RequestMapping(value = "/hello") 
 9     public String hello() { 
10         return "hello"; 
11           } 
12    }

这个例子中使用@ModelAttribute注释的value属性，来指定model属性的名称。model属性对象就是方法的返回值,也就是attriteName=abc它无须要特定的参数。

4. @ModelAttribute和@RequestMapping同时注释一个方法

@Controller 
public class HelloController { 
    @RequestMapping(value = "/helloWorld") 
    @ModelAttribute("attributeName") 
    public String hello() { 
         return "hello"; 
      } 
  }

这时这个方法的返回值并不是表示一个视图名称，而是model属性的值，
也就是说attributeName=“hello"视图名称由RequestToViewNameTranslator根据请求”/helloWorld"转换为逻辑视图helloWorld
Model属性名称有@ModelAttribute(value=””)指定，相当于在request中封装了key=attributeName，value=hello。

2.@ModelAttribute注释方法参数

1.从model中获取值

@Controller 
public class HelloWorldController { 
    @ModelAttribute("user") 
    public User addperson() { 
        return new User("zhaoyu","123"); 
     } 

    @RequestMapping(value = "/helloWorld") 
    public String helloWorld(@ModelAttribute("user") User user) { 
           user.setUserName("X先生"); 
           return "helloWorld"; 
        } 
  }

2.从Form表单或URL参数中获取（不做此注释也能拿到user对象）
@ModelAttribute具有如下三个作用：
①绑定请求参数到命令对象：放在功能处理方法的入参上时，用于将多个请求参数绑定到一个命令对象，从而简化绑定流程，而且自动暴露为模型数据用于视图页面展示时使用。

@Controller 
public class HelloWorldController { 
    @RequestMapping(value = "/helloWorld") 
    public String helloWorld(@ModelAttribute User user) { 
        return "helloWorld"; 
     } 
}

此处多了一个注解@ModelAttribute(“user”)，它的作用是将该绑定的命令对象以“user”为名称添加到模型对象中供视图页面展示使用。我们此时可以在视图页面使用${user.username}来获取绑定的命令对象的属性。　
在这个例子里，@ModelAttribute(“user”) User user注释方法参数，参数user的值来源于addPerson()方法中的model属性。
此时如果方法体没有标注@SessionAttributes(“user”)，那么scope为request，如果标注了，那么scope为session
②暴露@RequestMapping 方法返回值为模型数据：放在功能处理方法的返回值上时，是暴露功能处理方法的返回值为模型数据，用于视图页面展示时使用。

public @ModelAttribute("user") UserModel test3(@ModelAttribute("user") UserModel user)  {
       return "hello";
}

大家可以看到返回值类型是命令对象类型，而且通过 @ModelAttribute(“user”) 注解，此时会暴露返回值到模型数据（ 名字为user ） 中供视图展示使用
@ModelAttribute 注解的返回值会覆盖 @RequestMapping 注解方法中的 @ModelAttribute 注解的同名命令对象,也就是ModelAttribute 同时注解方法和返回值参数时，返回值会覆盖@RequestMapping 注解方法中的同名对象
③暴露表单引用对象为模型数据：放在处理器的一般方法（非功能处理方法）上时，是为表单准备要展示的表单引用对象，如注册时需要选择的所在城市等，而且在执行功能处理方法（ @RequestMapping 注解的方法）之前，自动添加到模型对象中，用于视图页面展示时使用；