3.10、在方法参数上使用@ModelAttribute注解

2024年4月29日 154次阅读 来源: 行一

  这一部分实例见这个项目的 mvc 分支下的 ModelAttrArgsController.java

  上节说过，@ModelAttribute可以用在方法或方法参数上。本节解释它用在参数上的情形。

  一个用在方法参数上的@ModelAttribute注解指示了参数应该从模型（这里所说的“模型”指 Model）中获取。如果模型中不存在，参数会首先被实例化，然后添加到模型中。一旦模型中存在，这个参数的字段会被所有的名字匹配的请求参数所填充。这在 Spring MVC 中叫做数据绑定，它能够把你从要对每一个字段进行类型转换的繁重体力劳动中解救出来，是非常有用的机制。

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute Pet pet) 
{ 
    // ...
}

  上面给出的例子的 Pet 实例来自哪里？这里有一个可选项：

  • 它可能已经存在与模型中了，因为使用了@SessionAttributes — 见“使用@SessionAttributes存储模型属性到 HTTP 会话中”一节.

  • 它可能已经存在于模型中了，因为同一个控制器中的@ModelAttribute方法，就像上一节中解释的那样。

  • 它可能是从URI模板变量和类型转换器中获取的（下面会详细解释）。

  • 它可能是使用默认构造器初始化的。

@ModelAttribute方法是一种常用的从数据库中获取属性的方式，可以通过使用@SessionAttributes注解把这种属性在各个请求之间共享。在一些情况下，可以很方便的通过使用URI模板变量和类型转换器来获取这些属性。下面是一个例子：

@PutMapping("/accounts/{account}")
public String save(@ModelAttribute("account") Account account) 
{
    // ...
}

  在这个例子中，模型属性名（“account”）匹配URI模板变量名。如果你注册的一个Converter<String, Account>可以把字符串 account 值转换为一个 Account，那么上面的例子即使不需要@ModelAttribute也可以正常工作。

  下一步是数据绑定。WebDataBinder类匹配请求参数名称——包括请求字符串参数和表单字段——到属性字段名。在必须的类型转换（从字符串到目标类型字段）之后，匹配的字段收集好了。数据绑定和校验见官方文档第五章-检验、数据绑定和类型转换。为控制器自定义数据绑定过程见 “自定义WebDataBinder初始化”一节。

  在数据绑定之后，可能会出现一些错误，比如缺少必须字段或者类型转换错误。为了检查这些错误，你可以紧跟在@ModelAttribute参数后面添加一个BindingResult参数：

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result) 
{
    if (result.hasErrors()) { return "petForm"; }
    // ...
}

  有了BindingResult之后，你就可以检查在提交同一个表单时有没有发现错误，这些错误可以通过 Spring 的<errors>表单标签来显示。

  注意到在一些情况下，在 model 中不使用数据绑定来访问一个属性是很有用的。这种情况下，你可以把Model注入到控制器中，或者在注解上使用绑定标记：

@ModelAttribute
public AccountForm setUpForm() { return new AccountForm(); }

@ModelAttribute
public Account findAccount(@PathVariable String accountId) 
{ 
    return accountRepository.findOne(accountId); 
}

@PostMapping("update")
public String update(
        @Valid AccountUpdateForm form, BindingResult result,
        @ModelAttribute(binding=false) Account account) 
{ /* omitted */ }

  除了数据绑定，你也可以使用你自己定义的、用来传递BindingResult（用于记录数据绑定错误）的校验器调用校验这允许数据绑定和验证的错误积累在一个地方，随后报告给用户：

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@ModelAttribute("pet") Pet pet, BindingResult result) 
{
    new PetValidator().validate(pet, result);
    if (result.hasErrors()) return "petForm";

    // ...
}

  或者你可以自动调用校验，通过添加 JSR-303 的 @Valid 注解:

@PostMapping("/owners/{ownerId}/pets/{petId}/edit")
public String processSubmit(@Valid @ModelAttribute("pet") Pet pet, BindingResult result) 
{
    if (result.hasErrors()) return "petForm";

    // ...
}

  关于如何配置和使用校验器，详见官方文档的5.8节“Spring校验”和第五章 校验、数据绑定和类型转换。

    原文作者：行一
    原文地址: https://segmentfault.com/a/1190000006995458
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞