天天看點

Spring 常用注解 @RequestMapping @ResponseBody 和 @RequestBody 注解的用法與差別

文章目錄

      • Spring 常用注解 @RequestMapping @ResponseBody 和 @RequestBody 注解的用法與差別
        • 1、@RequestMapping
        • 2、@ResponseBody
        • 3、@ResponseBody

Spring 常用注解 @RequestMapping @ResponseBody 和 @RequestBody 注解的用法與差別

1、@RequestMapping

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

​ 在此順便說一下 **@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 等)使用。
	③ 當方法上面沒有寫 ResponseBody 注解時,底層會将方法的傳回值封裝為 ModelAndView 對象。
	④ 如果是字元串,則直接将字元串寫到用戶端,預設按 ISO8859-1 編碼(頁面可能出現亂碼),可使用 @RequestMapping(value="/cat/query",produces="text/html;charset=utf-8") 來改變編碼格式;假如是一個對象,會調用對象的 getXxx() 方法擷取屬性值并且以鍵值對的形式進行封裝進而轉化為 json 串;如果是 map 集合,采用 get(key) 方式擷取 value 值,然後進行封裝。
           

3、@ResponseBody

  • 原理
    • 該注解用于讀取 Request 請求的 body 部分資料,使用系統預設配置的 HttpMessageConverter 進行解析,然後把相應的資料綁定到要傳回的 對象上
    • 再把 HttpMessageConverter 傳回的對象資料綁定到 Controller 中方法的參數上
  • 使用時間
    • 使用 Get、Post 方式送出時,根據 Request header Content-Type 的值來判斷
      • application/x-www-form-urlencoded:可選(即非必須,因為這種情況的資料@RequestParam, @ModelAttribute也可以處理,當然@RequestBody也能處理)
      • multipart/form-data:不能處理(即使用@RequestBody不能處理這種格式的資料)
      • 其他格式, 必須(其他格式包括application/json, application/xml等。這些格式的資料,必須使用@RequestBody來處理)
    • Put 方式送出時, 根據 Request header Content-Type 的值來判斷:
      • application/x-www-form-urlencoded:必須;
      • multipart/form-data:不能處理;其他格式, 必須;

        說明:request 的 body 部分的資料編碼格式由 header 部分的 Content-Type 指定;

繼續閱讀