1. 程式人生 > 其它 >@RequestMapping @ResponseBody 和 @RequestBody 註解的用法與區別

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

大家在使用SSM框架進行web開發的時候,經常會在Ctrl層遇到@RequestMapping、@ResponseBody以及@RequestBody這三個引數,下面就來談一下三者之間微妙的關係。

1.@RequestMapping
國際慣例先介紹什麼是@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);
}

2.@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 資料。

3.@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