@RequestBody和@RequestParam的原理及使用


一、@RequestBody

      @RequestBody主要用來接收前端傳遞給后端的json字符串中的數據的(請求體中的數據的);而最常用的使用請求體傳參的無疑是POST請求了,所以使用@RequestBody接收數據時,一般都用POST方式進行提交。在后端的同一個接收方法里,@RequestBody與@RequestParam()可以同時使用,@RequestBody最多只能有一個,而@RequestParam()可以有多個。

       注解@RequestBody接收的參數是來自requestBody中,即請求體。一般用於處理非 Content-Type: application/x-www-form-urlencoded編碼格式的數據,比如:application/json、application/xml等類型的數據。
就application/json類型的數據而言,使用注解@RequestBody可以將body里面所有的json數據傳到后端,后端再進行解析。
  GET請求中,因為沒有HttpEntity,所以@RequestBody並不適用。
  POST請求中,通過HttpEntity傳遞的參數,必須要在請求頭中聲明數據的類型Content-Type,SpringMVC通過使用
  HandlerAdapter 配置的HttpMessageConverters來解析HttpEntity中的數據,然后綁定到相應的bean上。

  Restful請求由DispatcherServlet處理,找到相應的HandlerAdapter進行處理,RequestMappingHandlerAdapter會處理@RequestMapping注解的請求,設置一系列參數解析器進行解析,如果參數使用@RequestBody注解,則使用RequestResponseBodyMethodProcessor進行解析,此參數解析器用HttpMessageConverter將HttpMessage封裝為具體的JavaBean對象,json格式的數據內部使用jackson進行json數據的解析。

使用說明:
1、一個請求,只有一個RequestBody;一個請求,可以有多個RequestParam。
2、當同時使用@RequestParam()和@RequestBody時,@RequestParam()指定的參數可以是普通元素、數組、集合、對象等等(即:當,@RequestBody 與@RequestParam()可以同時使用時,原SpringMVC接收參數的機制不變,只不過RequestBody 接收的是請求體里面的數據;而RequestParam接收的是key-value里面的參數,所以它會被切面進行處理從而可以用普通元素、數組、集合、對象等接收)。
       即:如果參數時放在請求體中,application/json傳入后台的話,那么后台要用@RequestBody才能接收到;
             如果不是放在請求體中的話,那么后台接收前台傳過來的參數時,要用@RequestParam來接收,或則形參前 什么也不寫也能接收。
3、如果參數前寫了@RequestParam(paramName),那么前端必須有對應的paramName名字才行(不管其是否有值,當然可以通過設置該注解的required屬性來調節是否必須傳),如果沒有paramName名的話,那么請求會出錯,報400。
4、如果參數前不寫@RequestParam(paramName)的話,那么就前端可以有可以沒有對應的paramName名字才行,如果有paramName名的話,那么就會自動匹配;沒有的話,請求也能正確發送。
5、如果后端參數是一個對象,且該參數前是以@RequestBody修飾的,那么前端傳遞json參數時,必須滿足以下要求:

  •      后端@RequestBody注解對應的類在將HTTP的輸入流(含請求體)裝配到目標類(即:@RequestBody后面的類)時,會根據json字符串中的key來匹配對應實體類的屬性,如果匹配一致且json中的該key對應的值符合(或可轉換為),這一條我會在下面詳細分析,其他的都可簡單略過,但是本文末的核心邏輯代碼以及幾個結論一定要看! 實體類的對應屬性的類型要求時,會調用實體類的setter方法將值賦給該屬性。
  •     json字符串中,如果value為""的話,后端對應屬性如果是String類型的,那么接受到的就是"",如果是后端屬性的類型是Integer、Double等類型,那么接收到的就是null。
  •     json字符串中,如果value為null的話,后端對應收到的就是null。
  •     如果某個參數沒有value的話,在傳json字符串給后端時,要么干脆就不把該字段寫到json字符串中;要么寫value時, 必須有值,null  或""都行。

二、@RequestParam

     注解@RequestParam接收的參數是來自HTTP請求體或請求url的QueryString中。
     RequestParam可以接受簡單類型的屬性,也可以接受對象類型。
    @RequestParam有三個配置參數:

  •     required 表示是否必須,默認為 true,必須。
  •     defaultValue 可設置請求參數的默認值。
  •     value 為接收url的參數名(相當於key值)。

     @RequestParam用來處理 Content-Type 為 application/x-www-form-urlencoded 編碼的內容,Content-Type默認為該屬性。@RequestParam也可用於其它類型的請求,例如:POST、DELETE等請求。
所以在postman中,要選擇body的類型為 x-www-form-urlencoded,這樣在headers中就自動變為了 Content-Type : application/x-www-form-urlencoded 編碼格式。不推薦使用@RequestParam接收application/json,這時候就需要使用到@RequestBody。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM