模型

你可以使用 @ModelAttribute 註解

  • @RequestMapping 方法中的方法引數上,以建立或訪問模型中的 Object,並透過 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)
}
當未明確指定名稱時,將根據 Object 型別選擇一個預設名稱,如 Conventions 的 javadoc 中所解釋的。你可以透過使用過載的 addAttribute 方法或透過 @ModelAttribute 上的 name 屬性(對於返回值)來始終指定一個明確的名稱。

你也可以在 @RequestMapping 方法上使用 @ModelAttribute 作為方法級註解,在這種情況下,@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
}