@RequestMapping、@ResponseBody 和 @RequestBody 注解的用法與區別

背景：

    幫助同事解決文件上傳的bug(文件上傳成功，但是頁面提示上傳接口異常，數據的確是插入了)，從前端layui頁面找錯誤，然后瀏覽器調試，找了半天無果。layui文件上傳格式code返回是數值，后台返回是success。然后嘗試從后台返回值入手，使用map返回。結果告敗。最后當我回到位置上運行自己的項目時，想起來了，可能是后台沒有響應體。果然是，bingo解決！

@RequestMapping @ResponseBody 和 @RequestBody 我們經常使用，它們的區別是什么呢，下面簡單介紹下：

@RequestMapping

     @RequestMapping 是一個用來處理請求地址映射的注解，可用於類或方法上。用於類上，表示類中的所有響應請求的方法都是以該地址作為父路徑；用於方法上，表示在類的父路徑下追加方法上注解中的地址將會訪問到該方法。例如.:

/**
* 用於類上，可以沒有
*/
@RequestMapping(value = "/controllerDemo")
public class ControllerDemo {
    // 用於方法上，必須有
    @RequestMapping(value = "/methodDemo")    
    public String methodDemo() {
        return "helloWorld";
    }
}

RequestMapping注解有六個屬性，下面我們把她分成三類進行說明。

1、value， method

   value： 指定請求的實際地址，指定的地址可以是URI Template 模式（后面將會說明）

   method：指定請求的method類型，GET、POST、PUT、DELETE等

2、consumes，produces

   consumes： 指定處理請求的提交內容類型（Content-Type），例如application/json, text/html;

   produces:    指定返回的內容類型，僅當request請求頭中的(Accept)類型中包含該指定類型才返回；

3、params，headers

   params：指定request中必須包含某些參數值是，才讓該方法處理。

   headers：指定request中必須包含某些指定的header值，才能讓該方法處理請求。

@ResponseBody

      @Responsebody 注解表示該方法的返回的結果直接寫入 HTTP 響應正文（ResponseBody）中，一般在異步獲取數據時使用，通常是在使用 @RequestMapping 后，返回值通常解析為跳轉路徑，加上 @Responsebody 后返回結果不會被解析為跳轉路徑，而是直接寫入HTTP 響應正文中。
作用： 
   該注解用於將Controller的方法返回的對象，通過適當的HttpMessageConverter轉換為指定格式后，寫入到Response對象的body數據區。 
使用時機： 
   返回的數據不是html標簽的頁面，而是其他某種格式的數據時（如json、xml等）使用；

當頁面發出異步請求時：

function login(){
    var datas='{"username":"'+$('#username').val()+'","userid":"'+$('#userid').val()+'","status":"'+$('#status').val()+'"}';
    $.ajax({
        type:'POST',
        contentType:'application/json',
        url:"${pageContext.request.contextPath}/user/login",
        processData:false,
        dataType:'json',
        data:datas,
        success:function(data){
           alert("userid:"+data.userid+"username:"+data.username+"status:"+data.status);

　　　　},
        error:function(XMLHttpRequest,textStatus,errorThrown){
           alert("出現異常，異常信息："+textStatus,"error");
        }
    });
};

后端代碼：


@RequestMapping(value="user/login")
@ResponseBody
//將ajax（datas）發出的請求寫入User對象中,返回json對象響應回去
public User login(User user) {
       User user = new User();
    user.setUserid(1);
    user.setUsername("MrF");
    user.setStatus("1");    
    return user ;
}

異步獲取 json 數據，加上 @Responsebody 注解后，就會直接返回 json 數據。

@RequestBody

   @RequestBody 注解則是將 HTTP 請求正文插入方法中，使用適合的 HttpMessageConverter 將請求體寫入某個對象。

作用：

1) 該注解用於讀取Request請求的body部分數據，使用系統默認配置的HttpMessageConverter進行解析，然后把相應的數據綁定到要返回的對象上； 
2) 再把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指定；

例如：

@RequestMapping(value = "user/login")
@ResponseBody
// 將ajax（datas）發出的請求寫入User對象中
public User login(@RequestBody User user) {   
// 這樣就不會再被解析為跳轉路徑，而是直接將user對象寫入 HTTP 響應正文中
    return user;    
}