SpringMVC中@ModelAttribute的不同使用场景

基本概念

@ModelAttribute注解用于将请求参数绑定到对象，且只支持一个属性value，类型为String，表示绑定到属性名称。注意被@ModelAttribute注释的方法会在Controller每个方法执行前被执行。因此在一个Controller被映射到多个URL时，要谨慎使用。

不同场景下的使用方法

1. @ModelAttribute(value="…")注解返回具体类的方法

//访问login这个url的时候，会先执行了userModel这个方法，该方法作用用一行代码表示即：model.addAttribute("username", username)，其中username为该请求的名为username变量的值。
//然后再执行login方法
@Controller
public class ModelAttributeController {
  //使用@ModelAttribute的value属性，来指定model属性的名称，model属性的值就是方法的返回值
    @ModelAttribute("username")
    public String userModel(
            @RequestParam("username") String username
    ){
        return username;
    }

    @RequestMapping("/login")
    public String login(){
      	...
    }

2. @ModelAttribute注解void返回值的方法

@Controller
public class ModelAttributeController {
//model属性名和值由model.addAttribute("username",username);来实现，在此加入@ModelAttribute注解只是为了在请求访问/login前执行userModel这个方法
    @ModelAttribute
    public void userModel(
            @RequestParam("username") String username,
            Model model
    ){
        model.addAttribute("username",username);
    }

    @RequestMapping("/login")
    public String login1(){
        ...
    }
}

3. @ModelAttribute注解返回具体类的方法

@Controller
public class ModelAttributeController {
/** 
model属性的名称没有被指定，它由返回类型隐含表示。如这个方法返回User类型，那么这个model属性值名称是user。该方法等价于model.addAttribute("user", new User(username, password)) 
**/
    @ModelAttribute
    public User userModel(
            @RequestParam("username") String username,
            @RequestParam("password") String password
    ){
      	User user = new User(username, password);
        return user;
    }

    @RequestMapping("/login")
    public String login1(){
        ...
    }
}

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

@Controller
public class ModelAttribute4Controller {
  /**
  当@ModelAttribute和@RequestMapping同时注释一个方法时，此时login方法的返回值不再是一个视图名称，而是model属性的值，视图名称是@RequestMapping的value值/login，故会访问该控制器后，会先执行model.addAttribute("username", "admin")，再跳转到login这个映射
  **/
    @ModelAttribute("username")
    @RequestMapping("/login")
    public String login(){
        return "admin";
    }
}

5. @ModelAttribute注释方法的参数

@Controller
public class ModelAttribute5Controller {
  /**
  在参数User使用了@ModelAttribute注释后，前台页面的控件的值会自动入参到@ModelAttribute注解修饰的同名属性中。假设请求中包含了两个属性username和password。而User的两个私有field也叫做username和password，则系统会自动把请求中的username和password封装到user变量中。
  **/
    @RequestMapping("/login")
    public String login(
            @ModelAttribute User user
    ){
        return "result";
    }
}