模型
Model
你可以使用 @ModelAttribute 注解:
-
在
@RequestMapping方法中的方法参数上,用于从模型中创建或访问一个对象,并通过WebDataBinder将其绑定到请求中。 -
作为
@Controller或@ControllerAdvice类中的方法级注解,帮助在调用任何@RequestMapping方法之前初始化模型。 -
在
@RequestMapping方法上,用于将返回值标记为模型属性。
本节讨论@ModelAttribute方法,即上述列表中的第二个项目。一个控制器可以拥有任意数量的@ModelAttribute方法。所有这些方法都会在同个控制器中的@RequestMapping方法之前被调用。通过@ControllerAdvice,@ModelAttribute方法还可以在多个控制器之间共享。有关更多详细信息,请参阅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);
}
当没有明确指定名称时,会根据类型选择默认名称,具体说明请参见Javadoc中的约定。你总是可以使用重载的addAttribute方法来指定一个明确的名称,或者通过@ModelAttribute上的name属性来指定(适用于返回值)。
与Spring MVC不同,Spring WebFlux在模型中明确支持响应式类型(例如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 {
// ...
}
此外,任何具有反应型类型包装器的模型属性都将在视图渲染之前被解析为其实际值(并且模型也会随之更新)。
你也可以在@RequestMapping方法上使用@ModelAttribute作为方法级别的注解,在这种情况下,@RequestMapping方法的返回值将被解释为模型属性(model attribute)。通常情况下这是不必要的,因为这已经是HTML控制器中的默认行为了,除非返回值是一个String,而该String本来会被解释为视图名称(view name)。如下面的例子所示,@ModelAttribute还可以帮助自定义模型属性的名称:
- Java
- Kotlin
@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
public Account handle() {
// ...
return account;
}
@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
fun handle(): Account {
// ...
return account
}