淺談@RequestMapping @ResponseBody 和 @RequestBody 注解的用法與差別

廢話：

最近在使用@ResponseBody時遇到一個問題，如下：

//@ResponseBody
    @RequestMapping(value = "/reportFile/{reportId}/{fileFormat}", method = RequestMethod.GET)
    public void getReportFileToPortal(@PathVariable String reportId,
            @PathVariable String fileFormat, HttpServletResponse response) {
 ***************
}
           

發現頁面調用顯示404，因為是這裡是根據url擷取參數，在不清楚@ResponseBody作用的情況下，加入了這個注解，導緻了這個問題，是以想仔細研究一下@ResponseBody這個注解，特此看到網上這篇文章， 特此備份，希望作者諒解，文章最後已經注明來源，如有侵權，煩請告知，速删！

[email protected]

國際慣例先介紹什麼是@RequestMapping，@RequestMapping 是一個用來處理請求位址映射的注解，可用于類或方法上。用于類上，表示類中的所有響應請求的方法都是以該位址作為父路徑；用于方法上，表示在類的父路徑下追加方法上注解中的位址将會通路到該方法，此處需注意@RequestMapping用在類上可以沒用，但是用在方法上必須有。

例如：

@Controller
//設定想要跳轉的父路徑
@RequestMapping(value = "/Controllers")
public class StatisticUserCtrl {
    //如需注入，則寫入需要注入的類
    //@Autowired

            // 設定方法下的子路經
            @RequestMapping(value = "/method")
            public String helloworld() {

                return "helloWorld";

            }
}
           

其原理也非常好了解，其對應的 action 就是“ （父路徑） controller/（父路徑下方法路經）method ”。是以，在本地伺服器上通路方法 http://localhost:8080/controller/method 就會傳回（跳轉）到“ helloWorld.jsp ”頁面。

說到這了，順便說一下 @PathVariable 注解，其用來擷取請求路徑（url ）中的動态參數。

頁面送出請求：

function login() {
    var url = "${pageContext.request.contextPath}/person/login/";
    var query = $('#id').val() + '/' + $('#name').val() + '/' + $('#status').val();
    url += query;
    $.get(url, function(data) {
        alert("id: " + data.id + "name: " + data.name + "status: "
                + data.status);
    });
}
           

例如：

/**
* @RequestMapping(value = "user/login/{id}/{name}/{status}") 中的 {id}/{name}/{status}
* 與 @PathVariable int id、@PathVariable String name、@PathVariable boolean status
* 一一對應，按名比對。
*/

@RequestMapping(value = "user/login/{id}/{name}/{status}")
@ResponseBody
//@PathVariable注解下的資料類型均可用
public User login(@PathVariable int id, @PathVariable String name, @PathVariable boolean status) {
//傳回一個User對象響應ajax的請求
    return new User(id, name, status);
}
           

@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;    
}
           

來源：https://blog.csdn.net/ff906317011/article/details/78552426