526互联

spring-web中的annotation注解之十：@ModelAttribute

发布时间 2023-03-27 14:19:42作者: #庄生晓梦

spring-web中的annotation注解之十：@ModelAttribute

1、@ModelAttribute注解在方法上：
*该方法在Controller每个方法执行前会被调用，没有返回值的 @ModelAttribute 方法使用 model.addAttribute(String key, Object value) 来向 Model 中增加参数，而有返回值的@ModelAttribute 方法则自动将该返回值加入到ModelMap中返回。
当被@ModelAttribute注解的方法的返回值类型不同时有区分
(1)、返回值类型为void：
方法参数一般需要一个（Model model），model的attributeName属性中可以手动放入任何属性值
(2)、返回值类型为具体类型：
返回的名字将自动作为model的key加入到model中。返回值是model的value。相当于model.addAttribute("返回名字", "返回值");

@Controller
public class ModelAttributeController {
    @ModelAttribute
    public User init(Model model) {
        User user = new User("小明", 18);
        return user;    
    @RequestMapping("/model-attribute")
    public String get() {
        return "model-attribute";
    }
}

上面的代码的作用是，向 Model 中增加了 key 为 "user" value 为 user 对象的键值对。这个 user 对象中有 username = "小明"，age = 18 的属性。

(3)、返回值类型为具体类型，@ModelAttribute(value="keyName"）：
指定的keyName将自动作为model的一个key加入到model中，model中keyName的value是方法返回值。相当于model.addAttribute("keyName", "返回值");
(4)、和@RequestMapping共通注解一个方法：
那么代表给这个请求单独设置 Model 参数，此时Model的一个key为message，返回的值HelloWorld是 Model 的value值，而不是跳转的地址，跳转的地址是根据请求的 url 自动转换而来的。比如下面的例子中跳转页面不是 HelloWorld.jsp 而是 model-attribute.jsp。并且参数只有在 model-attribute.jsp 中能够取得，而 demo.jsp 中不能取得

@Controller
public class ModelAttributeController {
	@ModelAttribute("message")
	@RequestMapping("/model-attribute")
	public String init(Model model) {
		return "HelloWorld";
	}
	@RequestMapping("/demo")
	public String get() {
		return "demo";
	}
}

　　

2、@ModelAttribute注解在方法的参数上，这种场景需要在方法上添加@RequestMapping注解。会将客户端传递过来的参数按名自动加入ModelMap中，便于View层使用
（1）、从model中获取
public String helloWorld(@ModelAttribute("user") User user) {}
user参数的值是来源于modol中被设定过的user，即User user=@ModelAttribute("user") 的意思。
此时如果方法体没有标注@SessionAttributes("user")，那么scope为request，如果标注了，那么scope为session
如下所示，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值缺省，从Form表单或URL参数中获取（实际上，不做此注释也能拿到user对象）

@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注解方法的返回值上，自动添加方法返回值到模型对象中，用于视图页面展示时使用。
@ModelAttribute("user2") 注解，此时会添加返回值到模型数据（ 名字为user2 ）中供视图展示

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