模型
你可以使用 @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
}