模型
Model
您可以使用 @ModelAttribute
注解:
-
在
@RequestMapping
方法中的 方法参数,用于从模型中创建或访问一个对象,并通过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 WebFlux 与 Spring MVC 不同,明确支持模型中的反应式类型(例如,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
}