模型

您可以使用 @ModelAttribute 註解

  • 方法引數 上,於 @RequestMapping 方法中使用,以從模型建立或存取 Object,並通過 WebDataBinder 將其繫結到請求。

  • 作為 `@Controller` 或 `@ControllerAdvice` 類別中的方法層級註解,有助於在任何 `@RequestMapping` 方法調用之前初始化模型。

  • 在 `@RequestMapping` 方法上標記其回傳值為模型屬性。

本節討論 `@ModelAttribute` 方法,即前述列表中的第二項。一個控制器可以有多個 `@ModelAttribute` 方法。所有這些方法都會在同一控制器中的 `@RequestMapping` 方法之前調用。`@ModelAttribute` 方法也可以通過 `@ControllerAdvice` 在控制器之間共享。有關更多詳細資訊,請參閱「Controller Advice」章節。

`@ModelAttribute` 方法具有彈性的方法簽名。它們支援與 `@RequestMapping` 方法相同的許多引數,但 `@ModelAttribute` 本身或與請求 Body 相關的任何內容除外。

以下範例顯示 `@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
}