模型

你可以使用 @ModelAttribute 注解：

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

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

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

本节讨论 @ModelAttribute 方法——前述列表中的第二项。一个控制器可以有任意数量的 @ModelAttribute 方法。所有此类方法都在同一控制器中的 @RequestMapping 方法之前被调用。@ModelAttribute 方法也可以通过 @ControllerAdvice 在控制器之间共享。有关更多详细信息，请参阅 Controller Advice 一节。

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

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

  • Java

  • Kotlin

@ModelAttribute
public void populateModel(@RequestParam String number, Model model) {
	model.addAttribute(accountRepository.findAccount(number));
	// add more ...
}
@ModelAttribute
fun populateModel(@RequestParam number: String, model: Model) {
	model.addAttribute(accountRepository.findAccount(number))
	// add more ...
}

以下示例只添加了一个属性：

  • Java

  • Kotlin

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

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

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

  • Java

  • Kotlin

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