基礎知識介紹:
@RequestBody主要用來接收前端傳遞給後端的json字符串中的數據的(請求體中的數據的);GET方式無請求體,所以使用@RequestBody接收數據時,前端不能使用GET方式提交數據,而是用POST方式進行提交。在後端的同一個接收方法裏,@RequestBody與@RequestParam()可以同時使用,@RequestBody最多只能有一個,而@RequestParam()可以有多個。
注:一個請求,只有一個RequestBody;一個請求,可以有多個RequestParam。
注:當同時使用@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的。
如果後端參數是一個對象,且該參數前是以@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 或""都行。千萬不能有類似"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測試一下,示例:
上圖簡單測試了一下,但是測得並不全面,這裏就不帶大家一起測試了,直接給出。
全面的結論:
結論①:@JsonAlias註解,實現:json轉模型時,使json中的特定key能轉化爲特定的模型屬性;但是模型轉json時,
對應的轉換後的key仍然與屬性名一致,見:上圖示例中的name字段的請求與響應。
以下圖進一步說明:
此時,json字符串轉換爲模型時,json中key爲Name或爲name123或爲name的都能識別。
結論②:@JsonProperty註解,實現:json轉模型時,使json中的特定key能轉化爲指定的模型屬性;同樣的,模
型轉json時,對應的轉換後的key爲指定的key,見:示例中的motto字段的請求與響應。
以下圖進一步說明:
此時,json字符串轉換爲模型時,key爲MOTTO的能識別,但key爲motto的不能識別。
結論③:@JsonAlias註解需要依賴於setter、getter,而@JsonProperty註解不需要。
結論④:在不考慮上述兩個註解的一般情況下,key與屬性匹配時,默認大小寫敏感。
結論⑤:有多個相同的key的json字符串中,轉換爲模型時,會以相同的幾個key中,排在最後的那個key的值給模
型屬性複製,因爲setter會覆蓋原來的值。見示例中的gender屬性。
結論⑥:後端@RequestBody註解對應的類在將HTTP的輸入流(含請求體)裝配到目標類(即:@RequestBody後面
的類)時,會根據json字符串中的key來匹配對應實體類的屬性,如果匹配一致且json中的該key對應的值
符合(或可轉換爲)實體類的對應屬性的類型要求時,會調用實體類的setter方法將值賦給該屬性。
原文鏈接:https://blog.csdn.net/justry_deng/article/details/80972817