本文不再更新,可能存在內容過時的情況,實時更新請移步我的新博客:全面解析Spring中@ModelAttribute注解的用法;
@ModelAttribute
注解用於將方法的參數或方法的返回值綁定到指定的模型屬性上,並返回給Web視圖。具體用法整理如下:
1.@ModelAttribute
注釋方法
下面的1),2),3)這三個例子類似,被@ModelAttribute
注解注釋的方法會在此controller每個方法執行前被執行,因此對於一個controller映射多個URL的用法來說,要謹慎使用。
1)@ModelAttribute
注釋void返回值的方法
@Controller
public class HelloWorldController {
@ModelAttribute
public void populateModel(@RequestParam String abc, Model model) {
model.addAttribute("attributeName", abc);
}
@RequestMapping(value = "/helloWorld")
public String helloWorld() {
return "helloWorld";
}
}
說明:
這個例子,在獲得請求/helloWorld
后,populateModel
方法在helloWorld
方法之前先被調用,它把請求參數(/helloWorld?abc=text)
加入到一個名為attributeName
的model屬性中,在它執行后helloWorld
被調用,返回視圖名helloWorld
和model已由@ModelAttribute
方法生產好了。
這個例子中model屬性名稱和model屬性對象有model.addAttribute()實現,不過前提是要在方法中加入一個Model類型的參數。
當URL或者post中不包含參數時,會報錯,其實不需要這個方法,完全可以把請求的方法寫成下面的樣子,這樣缺少此參數也不會出錯:
@RequestMapping(value = "/helloWorld")
public String helloWorld(String abc) {
return "helloWorld";
}
2)@ModelAttribute
注釋返回具體類的方法
@ModelAttribute
public Account addAccount(@RequestParam String number) {
return accountManager.findAccount(number);
}
說明: 這種情況,model屬性的名稱沒有指定,它由返回類型隱含表示,如這個方法返回Account類型,那么這個model屬性的名稱是account
。這個例子中model屬性名稱有返回對象類型隱含表示,model屬性對象的值就是方法的返回值。它無須要特定的參數。
3)@ModelAttribute("attributeName")
注釋返回具體類的方法
@Controller
public class HelloWorldController {
@ModelAttribute("attributeName")
public String addAccount(@RequestParam String abc) {
return abc;
}
@RequestMapping(value = "/helloWorld")
public String helloWorld() {
return "helloWorld";
}
}
說明:
這個例子中使用@ModelAttribute
注釋,並使用注解指定的attributeName
屬性來指定model屬性的名稱。model屬性對象的值就是方法的返回值。它無須要特定的參數。
4)@ModelAttribute
和@RequestMapping
同時注釋一個方法
@Controller
public class HelloWorldController {
@RequestMapping(value = "/helloWorld.do")
@ModelAttribute("attributeName")
public String helloWorld() {
return "hi";
}
}
說明:
這時這個方法的返回值並不是表示一個視圖名稱,而是model屬性的值,視圖名稱由RequestToViewNameTranslator
根據請求"/helloWorld.do"轉換為邏輯視圖helloWorld。
Model屬性名稱由@ModelAttribute("attributeName")
指定,相當於在request中封裝了key=attributeName,value=hi
。
2.@ModelAttribute
注釋一個方法的參數
1)從model中獲取
@Controller
public class HelloWorldController {
@ModelAttribute("user")
public User addAccount() {
return new User("jz","123");
}
@RequestMapping(value = "/helloWorld")
public String helloWorld(@ModelAttribute("user") User user) {
user.setUserName("jizhou");
return "helloWorld";
}
}
說明:
在這個例子里,@ModelAttribute("user") User user
注釋方法參數,參數user的值來源於addAccount()方法中的model屬性。此時如果方法體沒有標注@SessionAttributes("user")
,那么scope為request,如果標注了,那么scope為session。
2)從Form表單或URL參數中獲取(實際上,不做此注釋也能拿到user對象)
@Controller
public class HelloWorldController {
@RequestMapping(value = "/helloWorld")
public String helloWorld(@ModelAttribute User user) {
return "helloWorld";
}
}
說明:
注意這時候這個User類一定要有無參數的構造函數。
References
本文不再更新,可能存在內容過時的情況,實時更新請移步我的新博客:全面解析Spring中@ModelAttribute注解的用法;