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

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

 

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

---

SpringMVC中使用@ResponseBody注解標注業務方法，將業務方法的返回值做成json輸出給頁面

導包：

除了一些spring的包之外，還需要jackson-annotations.jar , jackson-core.jar , jackson-databind.jar 這三個包

 

開啟@ResponseBody注解：

在 spring-mvc.xml 中通過<mvc:annotation-driven />開啟@ResponseBody注解

 

使用@ResponseBody標注業務方法

package com.loger.controller;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import com.loger.entity.User;

/**
 * ResponseBody 注解，可以將如下類型的數據做成json：
 * 1）基本數據類型，如 boolean , String , int 等
 * 2) Map 類型數據
 * 3）集合或數組
 * 4）實體對象
 * 5）實體對象集合
 *
 */

@Controller
@RequestMapping("/test")
public class JsonController {

    @RequestMapping("test1.do")
    @ResponseBody
    public boolean test1(){
        return true;
    }
    
    @RequestMapping("/test2.do")
    @ResponseBody
    public Map<String, Object> test2(){
        Map<String , Object> map = new HashMap<String ,Object>();
        map.put("id", "s20070");
        map.put("name", "鄭城斌");
        return map;
    }
    
    @RequestMapping("/test3.do")
    @ResponseBody
    public List<String> test3(){
        List<String> list = new ArrayList<>();
        list.add("aaa");
        list.add("bbb");
        list.add("ccc");
        return list;
    }
    
    @RequestMapping("/test4.do")
    @ResponseBody
    public User test4(){
        User user = new User();
        user.setId("s20068");
        user.setName("余清波");
        user.setAge(21);
        return user;
    }
    
    @RequestMapping("/test5.do")
    @ResponseBody
    public List<User> test5(){
        List<User> list = new ArrayList<>();
        
        User user1 = new User();
        user1.setId("s200681");
        user1.setName("余清波1");
        user1.setAge(21);
        list.add(user1);
        
        User user2 = new User();
        user2.setId("s200682");
        user2.setName("余清波2");
        user2.setAge(21);
        list.add(user2);
        
        User user3 = new User();
        user3.setId("s200683");
        user3.setName("余清波3");
        user3.setAge(21);
        list.add(user3);
        
        return list;
    }
}