模型

你可以使用 @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 属性(对于返回值)来始终指定一个明确的名称。

你也可以在 @RequestMapping 方法上使用 @ModelAttribute 作为方法级注解,在这种情况下,@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
}