3.9、在方法上使用@ModelAttribute注解

王笑朝發(fā)布于2019-08-14 15:50 / 2241人閱讀

摘要：用在方法上的指示那個(gè)方法的目的是添加一個(gè)或多個(gè)模型屬性。在控制器中的方法的調(diào)用時(shí)機(jī)是在同一個(gè)控制器中的方法之前。注意，有兩種形式的方法。注解也可以用在方法上。

??這一部分翻譯自 Spring 5.0.0.M1 文檔中的 Using @ModelAttribute on a method 一節(jié)。這一節(jié)的演示示例在這個(gè)項(xiàng)目的 mvc 分支中的 ModelAttrController.java 文件中。

??注解@ModelAttribute可以用在方法或者方法參數(shù)上。這一節(jié)解釋它用在方法上，下一節(jié)解釋把它用在方法參數(shù)上。

??用在方法上的@ModelAttribute指示那個(gè)方法的目的是添加一個(gè)或多個(gè)模型屬性（model attributes）。這樣的方法和@RequestMapping方法支持的參數(shù)類型相同，但是不能直接映射到請(qǐng)求。在控制器中的@ModelAttribute方法的調(diào)用時(shí)機(jī)是在同一個(gè)控制器中的@RequestMapping方法之前。下面是幾個(gè)例子：

// 添加一個(gè)屬性
// 這個(gè)方法的返回值被添加到名為 “account” 的模型下
// 你可以自定義這個(gè)名字，像這樣 @ModelAttribute("myAccount")
@ModelAttribute
public Account addAccount(@RequestParam String number) { return accountManager.findAccount(number); }

// 添加多個(gè)屬性
@ModelAttribute
public void populateModel(@RequestParam String number, Model model) 
{
    model.addAttribute(accountManager.findAccount(number));
    // add more ...
}

??@ModelAttribute方法用于構(gòu)建帶有常用屬性的模型，比如用狀態(tài)或者寵物類型填充一個(gè)下拉框，或者取回一個(gè)命令對(duì)象如 Account，把它用作 HTML 表單數(shù)據(jù)。后一種情況在下一節(jié)會(huì)進(jìn)行更深入的討論。

??注意，有兩種形式的@ModelAttribute方法。第一種，方法通過(guò)返回屬性來(lái)隱式地添加屬性。第二種，方法接受一個(gè)Model參數(shù)，并把任何數(shù)量的屬性添加給它。你可以根據(jù)需要選擇其中的任何一種。

??一個(gè)控制器可以有任何數(shù)量的@ModelAttribute方法。所有的這些方法都在同一個(gè)控制器中的@RequestMapping方法之前調(diào)用。【很遺憾，我現(xiàn)在還沒有找到關(guān)于一個(gè)控制器中有多個(gè)@ModelAttribute方法時(shí)，這些方法的調(diào)用順序的說(shuō)明。以后找到的話會(huì)補(bǔ)上】

??@ModelAttribute方法也可以定義在一個(gè)帶有@ControllerAdvice注解的類中，這些方法應(yīng)用于很多控制器。詳情參見“使用@ControllerAdvice和@RestControllerAdvice通知控制[2]”一節(jié)

??在不顯式指定屬性名的時(shí)候發(fā)生了什么？這種情況下，被賦值的模型屬性的缺省名稱是基于其類型的。比如，如果一個(gè)方法返回一個(gè) Account 類型的對(duì)象的話，那么缺省名就是“account”。你可以通過(guò)注解@ModelAttribute的值來(lái)改變。如果直接添加屬性到模型的話，請(qǐng)使用合適的方法 addAttribute(..) 的重載。

??注解@ModelAttribute也可以用在@RequestMapping方法上。這種情況下，@RequestMapping方法的返回值被攔截為一個(gè)模型屬性，而不是一個(gè)視圖名。關(guān)于視圖，參見源文檔的18.13.3節(jié)“視圖——RequestToViewNameTranslator”。