Model

可以使用 @ModelAttribute 注释：

  • 在 `@RequestMapping`方法中对 method argument创建或访问模型中的对象，并通过 `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);
}

如果未显式指定名称，系统会根据类型选择一个默认名称，如 Conventions 中的 javadoc 所述。您始终可以通过使用重载的 addAttribute 方法或通过 @ModelAttribute 中的名称属性（用于返回值）指定显式名称。

与 Spring MVC 不同，Spring WebFlux 在模型中明确支持反应式类型（例如，Mono<Account> 或 io.reactivex.Single<Account>）。此类异步模型属性可以透明地解析（并更新模型） 为调用 @RequestMapping 时的实际值，前提是声明了 @ModelAttribute 参数，且没有包装，如下例所示：

  • Java

  • Kotlin

@ModelAttribute
public void addAccount(@RequestParam String number) {
    Mono<Account> accountMono = accountRepository.findAccount(number);
    model.addAttribute("account", accountMono);
}

@PostMapping("/accounts")
public String handle(@ModelAttribute Account account, BindingResult errors) {
	// ...
}
import org.springframework.ui.set

@ModelAttribute
fun addAccount(@RequestParam number: String) {
	val accountMono: Mono<Account> = accountRepository.findAccount(number)
	model["account"] = accountMono
}

@PostMapping("/accounts")
fun handle(@ModelAttribute account: Account, errors: BindingResult): String {
	// ...
}

此外，具有反应式类型包装的任何模型属性都会在渲染视图前解析为其实际值（并更新模型）。

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