@ModelAttribute用法总结

@ModelAttribute用法总结

@ModelAttribute

• @ModelAttribute主要的作用是将数据添加到模型对象中，用于视图页面显示。@ModelAttribute注释的位置不同,和其他注解一起使用时有很多种用法。

@ModelAttribute注解在方法上。@ModelAttribute注解的方法会在Controller每个方法执行前被调用。这个有点类似于Junit的@Before注解。

• 当被@ModelAttribute注解的方法的返回值类型不同时也有区分

• ①当注解void方法时，一般在方法的入参中使用Model参数,在方法体内用model.addAttribute(String name,Object object);将模型数据添加到模型对象中。
  @ModelAttribute 
  public void NoneReturn(@RequestParam String data, Model model) { 
           model.addAttribute("指定一个名称",data); 
    } 
  
  ②当注解返回具体类型的方法时，我们一般用@ModelAttribute的value属性指定model属性的名称。model属性对应的对象就是方法的返回值。
   @ModelAttribute("指定一个名称") 
   @ModelAttribute//如果这样使用，不指定名称，则model属性名就会默认是返回类型的首字母小写
   public String ReturnRealClass(@RequestParam String data) { 
           return data;     
    } 
    
  ③当@ModdelAttribute和@RequestMapping共同注解一个方法时。
  @RequestMapping(value = "指定一个访问路径") 
  @ModelAttribute("指定一个名称") 
  public String Fix() { 
           return "猛虎蔷薇"; 
    } 
    这时就比较特殊了，此时方法的返回值并不是表示一个视图名称，而是model属性的值，此时的视图名称就是@RequestMapping中指定的访问路径的最后一层去掉扩展名。
    这样说可能比较抽象，举个例子：
    	假设@RequestMapping("/MainPage.txt"),此时的视图名称就会被解析为MainPage，当然了具体处理的时候前后还会加上配置的suffix和prefix.
  
  

@ModelAttribute注解在方法的参数上。

• ①从model中获取
  @RequestMapping(value = "指定访问路径") 
   public String AtAttribute(@ModelAttribute("user") User user) { 
    	//SpringMVC首先会在 implicitModel（SpringMVC运行流程中的一个组件）中查找 key 对应的对象。
     		若存在, 则作为入参传入。
     		若不存在 key 对应的对象, 则检查当前的 Handler 是否使用 @SessionAttributes注解修饰, 
  	 		若使用了该注解, 且 @SessionAttributes 注解的 value 属性值中包含了 key, 则会从HttpSession 中来获取 key 所对应的 value 值,
  	 			若存在则直接传入到目标方法的入参中
  	 			若不存在则将抛出异常. 所以说使用@SessionAttributes注解一定要谨慎。在上一篇文章末尾，也提到了这点。
  	 		若 Handler 没有标识 @SessionAttributes 注解或 @SessionAttributes 注解的 value 值中不包含 key, 则会通过反射来创建 POJO 类型的参数, 传入为目标方法的参数
  		SpringMVC 会把 key 和 POJO 类型的对象保存到 implicitModel 中, 进而会保存到 request 中. （跟SpringMVC的运行流程有关）
   		  		
            return "轻嗅"; 
     }
      
  ②从Form表单或URL参数中获取（实际上，不加注解也可以拿到user对象）
  @RequestMapping(value = "指定一个路径")
  public String AtAttribute2(@ModelAttribute User user) {
            return "水击";
    }
  它的作用是将该绑定的命令对象以“user”为名称（类名首字母小写）添加到模型对象中供视图页面显示使用。
  

@ModelAttribute注解方法的返回值上，添加方法返回值到模型对象中，用于视图页面展示时使用。

• @RequestMapping(value = "指定路径") 
  public @ModelAttribute("user") User helloWorld(User user) { 
           return new User(); 
   } 
  此时会添加返回值到模型数据中供视图展示使用。