spring學習之@ModelAttribute運用詳解
spring學習之@ModelAttribute運用詳解
@ModelAttribute使用詳解
1.@ModelAttribute注釋方法
例子(1),(2),(3)類似,被@ModelAttribute注釋的方法會在此controller每個方法執行前被執行,因此對於一個controller映射多個URL的用法來說,要謹慎使用。
(1)@ModelAttribute注釋void返回值的方法
1 @Controller 2 public class HelloWorldController { 3 @ModelAttribute 4 public void populateModel(@RequestParam String abc, Model model) { 5 model.addAttribute("attributeName", abc); 6 } 7 8 @RequestMapping(value = "/helloWorld") 9 public String helloWorld() { 10 return "helloWorld"; 11 } 12 }
這個例子,在獲得請求/helloWorld 后,populateModel方法在helloWorld方法之前先被調用,它把請求參數(/helloWorld?abc=text)加入到一個名為attributeName的model屬性中,在它執行后 helloWorld被調用,返回視圖名helloWorld和model已由@ModelAttribute方法生產好了。
這個例子中model屬性名稱和model屬性對象有model.addAttribute()實現,不過前提是要在方法中加入一個Model類型的參數。
當URL或者post中不包含次參數時,會報錯,其實不需要這個方法,完全可以把請求的方法寫成,這樣缺少此參數也不會出錯
1 @RequestMapping(value = "/helloWorld") 2 public String helloWorld(String abc) { 3 return "helloWorld"; 4 }
(2)@ModelAttribute注釋返回具體類的方法
1 @ModelAttribute 2 public Account addAccount(@RequestParam String number) { 3 return accountManager.findAccount(number); 4 }
這種情況,model屬性的名稱沒有指定,它由返回類型隱含表示,如這個方法返回Account類型,那么這個model屬性的名稱是account。
這個例子中model屬性名稱有返回對象類型隱含表示,model屬性對象就是方法的返回值。它無須要特定的參數。
(3)@ModelAttribute(value="")注釋返回具體類的方法
1 @Controller 2 public class HelloWorldController { 3 @ModelAttribute("attributeName") 4 public String addAccount(@RequestParam String abc) { 5 return abc; 6 } 7 8 @RequestMapping(value = "/helloWorld") 9 public String helloWorld() { 10 return "helloWorld"; 11 } 12 }
這個例子中使用@ModelAttribute注釋的value屬性,來指定model屬性的名稱。model屬性對象就是方法的返回值。它無須要特定的參數。
(4)@ModelAttribute和@RequestMapping同時注釋一個方法
1 @Controller 2 public class HelloWorldController { 3 @RequestMapping(value = "/helloWorld.do") 4 @ModelAttribute("attributeName") 5 public String helloWorld() { 6 return "hi"; 7 } 8 }
這時這個方法的返回值並不是表示一個視圖名稱,而是model屬性的值,視圖名稱由RequestToViewNameTranslator根據請求"/helloWorld.do"轉換為邏輯視圖helloWorld。
Model屬性名稱有@ModelAttribute(value=””)指定,相當於在request中封裝了key=attributeName,value=hi。
2.@ModelAttribute注釋一個方法的參數
(1)從model中獲取
1 @Controller 2 public class HelloWorldController { 3 @ModelAttribute("user") 4 public User addAccount() { 5 return new User("jz","123"); 6 } 7 8 @RequestMapping(value = "/helloWorld") 9 public String helloWorld(@ModelAttribute("user") User user) { 10 user.setUserName("jizhou"); 11 return "helloWorld"; 12 } 13 }
在這個例子里,@ModelAttribute("user") User user注釋方法參數,參數user的值來源於addAccount()方法中的model屬性。
此時如果方法體沒有標注@SessionAttributes("user"),那么scope為request,如果標注了,那么scope為session
(2)從Form表單或URL參數中獲取(實際上,不做此注釋也能拿到user對象)
@ModelAttribute具有如下三個作用:
①綁定請求參數到命令對象:放在功能處理方法的入參上時,用於將多個請求參數綁定到一個命令對象,從而簡化綁定流程,而且自動暴露為模型數據用於視圖頁面展示時使用。
其實 @ModelAttribute 此處對於供視圖頁面展示來說與 model.addAttribute("attributeName", abc); 功能類似。
1 @Controller 2 public class HelloWorldController { 3 @RequestMapping(value = "/helloWorld") 4 public String helloWorld(@ModelAttribute User user) { 5 return "helloWorld"; 6 } 7 }
此處多了一個注解@ModelAttribute("user"),它的作用是將該綁定的命令對象以“user”為名稱添加到模型對象中供視圖頁面展示使用。我們此時可以在視圖頁面使用${user.username}來獲取綁定的命令對象的屬性。
②暴露@RequestMapping 方法返回值為模型數據:放在功能處理方法的返回值上時,是暴露功能處理方法的返回值為模型數據,用於視圖頁面展示時使用。
public @ModelAttribute("user2") UserModel test3(@ModelAttribute("user2") UserModel user)
大家可以看到返回值類型是命令對象類型,而且通過 @ModelAttribute("user2") 注解,此時會暴露返回值到模型數據( 名字為user2 ) 中供視圖展示使用
@ModelAttribute 注解的返回值會覆蓋 @RequestMapping 注解方法中的 @ModelAttribute 注解的同名命令對象
③暴露表單引用對象為模型數據:放在處理器的一般方法(非功能處理方法)上時,是為表單准備要展示的表單引用對象,如注冊時需要選擇的所在城市等,而且在執行功能處理方法( @RequestMapping 注解的方法)之前,自動添加到模型對象中,用於視圖頁面展示時使用;
注意這時候這個User類一定要有沒有參數的構造函數。