spring之@ModelAttribute,@RequestBody, @ResponseBody 參數傳遞的運用詳解

簡介：

@RequestBody

作用： 

      i) 該注解用於讀取Request請求的body部分數據，使用系統默認配置的HttpMessageConverter進行解析，然后把相應的數據綁定到要返回的對象上；

      ii) 再把HttpMessageConverter返回的對象數據綁定到 controller中方法的參數上。

使用時機：

A) GET、POST方式提時， 根據request header Content-Type的值來判斷:

•     application/x-www-form-urlencoded， 可選（即非必須，因為這種情況的數據@RequestParam, @ModelAttribute也可以處理，當然@RequestBody也能處理）；
•     multipart/form-data, 不能處理（即使用@RequestBody不能處理這種格式的數據）；
•     其他格式， 必須（其他格式包括application/json, application/xml等。這些格式的數據，必須使用@RequestBody來處理）；

B) PUT方式提交時， 根據request header Content-Type的值來判斷:

•     application/x-www-form-urlencoded， 必須；
•     multipart/form-data, 不能處理；
•     其他格式， 必須；

說明：request的body部分的數據編碼格式由header部分的Content-Type指定；

@ResponseBody

作用： 

      該注解用於將Controller的方法返回的對象，通過適當的HttpMessageConverter轉換為指定格式后，寫入到Response對象的body數據區。

使用時機：

      返回的數據不是html標簽的頁面，而是其他某種格式的數據時（如json、xml等）使用；

 

 

 

@ModelAttribute使用詳解

1.@ModelAttribute注釋方法 
    例子（1），（2），（3）類似，被@ModelAttribute注釋的方法會在此controller每個方法執行前被執行，因此對於一個controller映射多個URL的用法來說，要謹慎使用。
    
    （1）@ModelAttribute注釋void返回值的方法 
    

<span style="font-size:12px;">@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";
        }
    }</span>
<span style="font-size:12px;">
</span>

 

    這個例子，在獲得請求/helloWorld 后，populateModel方法在helloWorld方法之前先被調用，它把請求參數（/helloWorld?abc=text）加入到一個名為attributeName的model屬性中，在它執行后helloWorld被調用，返回視圖名helloWorld和model已由@ModelAttribute方法生產好了。
這個例子中model屬性名稱和model屬性對象有model.addAttribute()實現，不過前提是要在方法中加入一個Model類型的參數。
    當URL或者post中不包含次參數時，會報錯，其實不需要這個方法，完全可以把請求的方法寫成，這樣缺少此參數也不會出錯

<span style="font-size:12px;">       @RequestMapping(value = "/helloWorld")
        public String helloWorld(String abc) {
           return "helloWorld";
        }</span>
<span style="font-size:12px;">
</span>

        
    （2）@ModelAttribute注釋返回具體類的方法 
    

<span style="font-size:12px;">@ModelAttribute
    public Account addAccount(@RequestParam String number) {
       return accountManager.findAccount(number);
    }
</span>
<span style="font-size:12px;">
</span>

 

    這種情況，model屬性的名稱沒有指定，它由返回類型隱含表示，如這個方法返回Account類型，那么這個model屬性的名稱是account。
    這個例子中model屬性名稱有返回對象類型隱含表示，model屬性對象就是方法的返回值。它無須要特定的參數。
    
    （3）@ModelAttribute(value="")注釋返回具體類的方法 
    

<span style="font-size:12px;">@Controller
    public class HelloWorldController {

        @ModelAttribute("attributeName")
        public String addAccount(@RequestParam String abc) {
           return abc;
        }

        @RequestMapping(value = "/helloWorld")
        public String helloWorld() {
           return "helloWorld";
        }
    }</span>
<span style="font-size:12px;">
</span>

 

    這個例子中使用@ModelAttribute注釋的value屬性，來指定model屬性的名稱。model屬性對象就是方法的返回值。它無須要特定的參數。
    
    （4）@ModelAttribute和@RequestMapping同時注釋一個方法 
    

<span style="font-size:12px;">@Controller
    public class HelloWorldController {

        @RequestMapping(value = "/helloWorld.do")
        @ModelAttribute("attributeName")
        public String helloWorld() {
           return "hi";
        }
    }</span>
<span style="font-size:12px;">
</span>

 

    這時這個方法的返回值並不是表示一個視圖名稱，而是model屬性的值，視圖名稱由RequestToViewNameTranslator根據請求"/helloWorld.do"轉換為邏輯視圖helloWorld。
    Model屬性名稱有@ModelAttribute(value=””)指定，相當於在request中封裝了key=attributeName，value=hi。
    
2.@ModelAttribute注釋一個方法的參數 

    （1）從model中獲取     
    

<span style="font-size:12px;">@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";
        }
    }</span>
<span style="font-size:12px;">
</span>

 

    在這個例子里，@ModelAttribute("user") User user注釋方法參數，參數user的值來源於addAccount()方法中的model屬性。
    此時如果方法體沒有標注@SessionAttributes("user")，那么scope為request，如果標注了，那么scope為session
    
    （2）從Form表單或URL參數中獲取（實際上，不做此注釋也能拿到user對象） 
    
    

<span style="font-size:12px;">@Controller
    public class HelloWorldController {

        @RequestMapping(value = "/helloWorld")
        public String helloWorld(@ModelAttribute User user) {
           return "helloWorld";
        }
    }</span>
<span style="font-size:12px;">
</span>