模型

您可以使用@ModelAttribute注解:

  • @RequestMapping方法中的方法参数上,通过WebDataBinder创建或访问一个Object,并将其绑定到请求中。

  • 作为@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方法或通过@ModelAttributename属性(对于返回值)来分配显式名称。

您还可以将@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
}