Model

您可以使用 @ModelAttribute 注解：

  • 在 @RequestMapping 方法中的 方法参数 上， 用于创建或访问模型中的 Object 并通过 WebDataBinder 将其绑定到请求。

  • 作为 @Controller 或 @ControllerAdvice 类中的方法级注解，帮助在任何 @RequestMapping 方法调用之前初始化模型。

  • 在 @RequestMapping 方法上，标记其返回值是模型属性。

本节讨论 @ModelAttribute 方法——上述列表中的第二项。控制器可以有任意数量的 @ModelAttribute 方法。 所有这些方法在同一个控制器中的 @RequestMapping 方法之前被调用。@ModelAttribute 方法也可以通过 @ControllerAdvice 在控制器之间共享。更多详细信息请参阅 控制器建议 部分。

@ModelAttribute 方法具有灵活的方法签名。它们支持许多与 @RequestMapping 方法相同的参数，除了 @ModelAttribute 本身或与请求体相关的任何内容。

以下示例展示了一个 @ModelAttribute 方法：

@ModelAttribute
public void populateModel(@RequestParam String number, Model model) {
  model.addAttribute(accountRepository.findAccount(number));
  // 添加更多 ...
}

以下示例仅添加一个属性：

@ModelAttribute
public Account addAccount(@RequestParam String number) {
  return accountRepository.findAccount(number);
}

注意：当没有明确指定名称时，将根据 Object 类型选择默认名称，如 Conventions 的 javadoc 中所解释的。 您可以通过使用重载的 addAttribute 方法或通过 @ModelAttribute 上的 name 属性（对于返回值）始终分配显式名称。

您也可以在 @RequestMapping 方法上使用 @ModelAttribute 作为方法级注解，在这种情况下，@RequestMapping 方法的返回值被解释为模型属性。这通常不是必需的，因为它是 HTML 控制器中的默认行为，除非返回值是 String，否则将被解释为视图名称。 @ModelAttribute 还可以自定义模型属性名称，如下例所示：

@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
public Account handle() {
  // ...
  return account;
}