模型
你可以使用 @ModelAttribute 注解
-
在
@RequestMapping方法中的方法参数上,用于从模型中创建或访问一个对象,并通过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);
}
当没有明确指定名称时,将根据类型选择一个默认名称,如 Conventions 的 javadoc 中所解释的。你始终可以通过使用重载的 addAttribute 方法或通过 @ModelAttribute(对于返回值)上的 name 属性来分配一个显式名称。 |
Spring WebFlux,与 Spring MVC 不同,明确支持模型中的响应式类型(例如,Mono<Account> 或 io.reactivex.Single<Account>)。只要 @ModelAttribute 参数在没有包装器的情况下声明,这些异步模型属性就可以在 @RequestMapping 调用时透明地解析(并更新模型)为其实际值,如下例所示
-
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
}