java之@RequestBody的使用

基礎知識介紹:前端

        @RequestBody主要用來接收前端傳遞給後端的json字符串中的數據的(請求體中的數據的);GET方式無請求體,因此使用@RequestBody接收數據時,前端不能使用GET方式提交數據,而是用POST方式進行提交。在後端的同一個接收方法裏,@RequestBody與@RequestParam()能夠同時使用,@RequestBody最多隻能有一個,而@RequestParam()能夠有多個。java

注:一個請求,只有一個RequestBody;一個請求,能夠有多個RequestParam。json

注:當同時使用@RequestParam()和@RequestBody時,@RequestParam()指定的參數能夠是普通元素、
       數組、集合、對象等等(即:當,@RequestBody 與@RequestParam()能夠同時使用時,原SpringMVC接收
       參數的機制不變,只不過RequestBody 接收的是請求體裏面的數據;而RequestParam接收的是key-value
       裏面的參數,因此它會被切面進行處理從而能夠用普通元素、數組、集合、對象等接收)。
       即:若是參數時放在請求體中,傳入後臺的話,那麼後臺要用@RequestBody才能接收到;若是不是放在
              請求體中的話,那麼後臺接收前臺傳過來的參數時,要用@RequestParam來接收,或則形參前
              什麼也不寫也能接收。後端

注:若是參數前寫了@RequestParam(xxx),那麼前端必須有對應的xxx名字才行(無論其是否有值,固然能夠通
       過設置該註解的required屬性來調節是否必須傳),若是沒有xxx名的話,那麼請求會出錯,報400。數組

注:若是參數前不寫@RequestParam(xxx)的話,那麼就前端能夠有能夠沒有對應的xxx名字才行,若是有xxx名
       的話,那麼就會自動匹配;沒有的話,請求也能正確發送。
       追注:這裏與feign消費服務時不一樣;feign消費服務時,若是參數前什麼也不寫,那麼會被默認是
                  @RequestBody的。app

若是後端參數是一個對象,且該參數前是以@RequestBody修飾的,那麼前端傳遞json參數時,必須知足如下要求:post

    後端@RequestBody註解對應的類在將HTTP的輸入流(含請求體)裝配到目標類(即:@RequestBody後面的類)時,會根據json字符串中的key來匹配對應實體類的屬性,若是匹配一致且json中的該key對應的值符合(或可轉換爲),這一條我會在下面詳細分析,其餘的均可簡單略過,可是本文末的核心邏輯代碼以及幾個結論必定要看! 實體類的對應屬性的類型要求時,會調用實體類的setter方法將值賦給該屬性。測試

    json字符串中,若是value爲""的話,後端對應屬性若是是String類型的,那麼接受到的就是"",若是是後端屬性的類型是Integer、Double等類型,那麼接收到的就是null。ui

    json字符串中,若是value爲null的話,後端對應收到的就是null。編碼

    若是某個參數沒有value的話,在傳json字符串給後端時,要麼乾脆就不把該字段寫到json字符串中;要麼寫value時, 必須有值,null  或""都行。千萬不能有相似"stature":,這樣的寫法,如:

示例詳細說明

先給出兩個等下要用到的實體類

User實體類:

Team實體類:

@RequestBody直接以String接收前端傳過來的json數據:

後端對應的Controller:

使用PostMan測試:

@RequestBody以簡單對象接收前端傳過來的json數據:

後端對應的Controller:

使用PostMan測試:

@RequestBody以複雜對象接收前端傳過來的json數據:

後端對應的Controller:

使用PostMan測試:

@RequestBody與簡單的@RequestParam()同時使用

後端對應的Controller:

使用PostMan測試:

@RequestBody與複雜的@RequestParam()同時使用

後端對應的Controller:

使用PostMan測試:

@RequestBody接收請求體中的json數據;不加註解接收URL中的數據並組裝爲對象

後端對應的Controller:

使用PostMan測試:

注:若是在後端方法參數前,指定了@RequestParam()的話,那麼前端必需要有對應字段才行(固然能夠經過設置
       該註解的required屬性來調節是否必須傳),否者會報錯;若是參數前沒有任何該註解,那麼前端能夠傳,也可
       以不傳,如:

上圖中,若是咱們傳參中沒有指定token,那麼請求能正常進去,可是token爲null;若是在String token前指定了@RequestParam(「token」),那麼前端必需要有token這個鍵時,請求才能正常進去,否者報400錯誤。
 

@RequestBody與前端傳過來的json數據的匹配規則

聲明:根據不一樣的Content-Type等狀況,Spring-MVC會採起不一樣的HttpMessageConverter實現來進行信息轉換解析。
          下面介紹的是最經常使用的:前端以Content-Type 爲application/json,傳遞json字符串數據;後端以@RequestBody
          模型接收數據的狀況。

解析json數據大致流程概述:
        Http傳遞請求體信息,最終會被封裝進com.fasterxml.jackson.core.json.UTF8StreamJsonParser中(提示:Spring採用CharacterEncodingFilter設置了默認編碼爲UTF-8),而後在public class BeanDeserializer extends BeanDeserializerBase implements java.io.Serializable中,經過 public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException方法進行解析。
核心邏輯分析示例:

        假設前端傳的json串是這樣的: {"name1":"鄧沙利文","age":123,"mot":"我是一隻小小小小鳥~"} 後端的模型只有name和age屬性,以及對應的setter/getter方法;給出通常用到的deserializeFromObject(JsonParser p, DeserializationContext ctxt)方法的核心邏輯:

 

小技巧之指定模型中的屬性對應什麼key

這裏簡單介紹,更多的可參考:

           public class BeanPropertyMap implements Iterable<SettableBeanProperty>,java.io.Serializable

給出Controller中的測試類:

給出模型中的屬性(setter/getter方法沒截出來):

 

使用postman測試一下,示例:

相關文章
相關標籤/搜索