模型
您可以使用@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 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
方法的返回值被解释为模型属性。这通常不需要,因为它是 HTML 控制器中的默认行为,除非返回值是字符串,否则会被解释为视图名称。@ModelAttribute
还可以帮助自定义模型属性名称,如下例所示
-
Java
-
Kotlin
@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
public Account handle() {
// ...
return account;
}
@GetMapping("/accounts/{id}")
@ModelAttribute("myAccount")
fun handle(): Account {
// ...
return account
}