Model

請參閱 Servlet 堆疊中的對等項

您可以使用 @ModelAttribute 註解

  • 在 @RequestMapping 方法中的方法參數上，從模型建立或存取物件，並透過 WebDataBinder 將其繫結至請求。

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

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

本節討論 @ModelAttribute 方法，或前述列表中的第二項。控制器可以有任意數量的 @ModelAttribute 方法。所有此類方法都會在同一個控制器中的 @RequestMapping 方法之前調用。@ModelAttribute 方法也可以透過 @ControllerAdvice 在控制器之間共享。有關更多詳細資訊，請參閱關於控制器建議的章節。

@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);
}
當未明確指定名稱時，會根據類型選擇預設名稱，如 Conventions 的 javadoc 中所述。您可以隨時使用重載的 addAttribute 方法或透過 @ModelAttribute 上的 name 屬性（對於回傳值）來指定明確的名稱。

與 Spring MVC 不同，Spring WebFlux 明確支援模型中的反應式類型（例如，Mono<Account> 或 io.reactivex.Single<Account>）。此類非同步模型屬性可以在 @RequestMapping 調用時透明地解析（並更新模型）為其實際值，前提是宣告了沒有 wrapper 的 @ModelAttribute 參數，如下列範例所示

  • 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 {
	// ...
}

此外，任何具有反應式類型 wrapper 的模型屬性都會在其視圖渲染之前解析為其實際值（並更新模型）。

您也可以在 @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
}