spring mvc @ModelAttribute的使用以及可能出现的问题解决方案

程序员文章站 2024-03-26 12:20:23

...

转载于这里

@ModelAttribute可以使用在 controller的方法和方法参数上

@ModelAttribute是给Model添加属性(attribute)的意思

一、使用在controller的普通方法(一般指的是非@RequestMapping方法)

首先，要知道在同一个controller中，@ModelAttribute注解的方法会在@RequestMapping方法之前调用.

然后有两种方式可以往Model添加属性，然后绑定到@RequestMapping方法参数上：

1、

@ModelAttribute 
public void populateModel(@RequestParam String abc, Model model) { 
    model.addAttribute("xxx", abc); 
} 
 
@RequestMapping("/test")
@ResponseBody
public Object test(@ModelAttribute("xxx") String param){
    return param;
}

@ModelAttribute 方法参数有Model类型的参数，在ModelAttribute 方法中往Model添加属性，然后在@ReuestMapping方法中，可以再次使用@ModelAttribute获取model中xxx的值，然后绑定到参数上。

2、

@ModelAttribute 
public User populateModel(@RequestParam String abc) { 
     return new User(abc);
} 
 
@RequestMapping("/test")
@ResponseBody
public Object test(@ModelAttribute("user") User param){
    return param;
}

@ModelAttribute方法的返回值会被添加到Model中。并且该返回值在Model中对应的key是返回值类型的首字符小写字符串(如类User，则key为user)。。。这个key值也可以指定，在@ModelAttribute注解中传入参数就行

然后在@ReuestMapping方法中，可以再次使用@ModelAttribute获取model中user的值，然后绑定到参数上。

二、使用在@RequestMapping方法参数上

@RequestMapping(value="/owners/{ownerId}/pets/{petId}/edit", method = RequestMethod.POST)
public String processSubmit(@ModelAttribute Pet pet1) { }

如果@ModelAttribute不带参数，默认情况下会绑定的Pet pet1中的pet1作为key，然后从Model取出该key的value然后传入给pet，作为该@RequestMapping方法的参数。

如果@ModelAttribute指定了一个name，则使用指定的name作为key从Model中取出该对应的value然后传入给pet，作为该@RequestMapping方法的参数

三、@ModelAttribute和@RequestMapping同时注释一个方法

@Controller 
public class HelloWorldController { 
    @RequestMapping(value = "/helloWorld.do") 
    @ModelAttribute("attributeName") 
    public String helloWorld() { 
         return "hi"; 
      } 
  }

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

@ModelAttribute用在mapping方法参数上获取数据的流程

SpringMVC 确定目标方法 POJO 类型入参的过程

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

下面开始未经测试，只是在别人的文章看到…等有空再测试

可以从URI 模版变量和类型转换器获取

@RequestMapping(value="/accounts/{account}", method = RequestMethod.PUT)
public String save(@ModelAttribute("account") Account account) {
 
}

上面的例子，model attribute的name与URI模板变量的名字一致。如果你注册了一个Converter<String, Account>，那么就会把uri模板通过转换器转换为Account实例