模型

查看响应式堆栈中的等效项

您可以使用 @ModelAttribute 注解

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

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

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

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

@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
}