一、基礎知識介紹
@RequestBody主要用來接收前端傳遞給后端的json字符串中的數據的(請求體中的數據的);GET方式無請求體,所以使用@RequestBody接收數據時,前端不能使用GET方式提交數據,而是用POST方式進行提交。
在后端的同一個接收方法里,@RequestBody與@RequestParam()可以同時使用,@RequestBody最多只能有一個,而@RequestParam()可以有多個。
注意:
1、一個請求,只有一個RequestBody;一個請求,可以有多個RequestParam。
2、當同時使用@RequestParam()和@RequestBody時,@RequestParam()指定的參數可以是普通元素、數組、集合、對象等等(即:當,@RequestBody 與@RequestParam()可以同時使用時。
3、原SpringMVC接收參數的機制不變,只不過RequestBody 接收的是請求體里面的數據;而RequestParam接收的是key-value里面的參數,所以它會被切面進行處理從而可以用普通元素、數組、集合、對象等接收)。
4、如果參數時放在請求體中,application/json傳入后台的話,那么后台要用@RequestBody才能接收到;如果不是放在請求體中的話,那么后台接收前台傳過來的參數時,要用@RequestParam來接收,或則形參前 什么也不寫也能接收。
5、如果參數前寫了@RequestParam(xxx),那么前端必須有對應的xxx名字才行(不管其是否有值,當然可以通過設置該注解的required屬性來調節是否必須傳),如果沒有xxx名的話,那么請求會出錯,報400。
6、如果參數前不寫@RequestParam(xxx)的話,那么就前端可以有可以沒有對應的xxx名字才行,如果有xxx名的話,那么就會自動匹配;沒有的話,請求也能正確發送。
7、這里與feign消費服務時不同;feign消費服務時,如果參數前什么也不寫,那么會被默認是@RequestBody的。
8、如果后端參數是一個對象,且該參數前是以@RequestBody修飾的,那么前端傳遞json參數時,必須滿足以下要求:
(1)后端@RequestBody注解對應的類在將HTTP的輸入流(含請求體)裝配到目標類(即:@RequestBody后面的類)時,會根據json字符串中的key來匹配對應實體類的屬性,
如果匹配一致且json中的該key對應的值符合(或可轉換為),實體類的對應屬性的類型要求時,會調用實體類的setter方法將值賦給該屬性。
(2)json字符串中,如果value為""的話,后端對應屬性如果是String類型的,那么接受到的就是"",如果是后端屬性的類型是Integer、Double等類型,那么接收到的就是null。
(3)json字符串中,如果value為null的話,后端對應收到的就是null。
(4)如果某個參數沒有value的話,在傳json字符串給后端時,要么干脆就不把該字段寫到json字符串中;要么寫value時, 必須有值,null 或""都行。
二、示例詳細說明
先給出兩個等下要用到的實體類。
User實體類:
Team實體類:
1、@RequestBody直接以String接收前端傳過來的json數據:
后端對應的Controller:
使用PostMan測試:
2、@RequestBody以簡單對象接收前端傳過來的json數據:
后端對應的Controller:
使用PostMan測試:
3、@RequestBody以復雜對象接收前端傳過來的json數據:
后端對應的Controller:
使用PostMan測試:
4、@RequestBody與簡單的@RequestParam()同時使用:
后端對應的Controller:
使用PostMan測試:
5、@RequestBody與復雜的@RequestParam()同時使用:
后端對應的Controller:
使用PostMan測試:
6、@RequestBody接收請求體中的json數據;不加注解接收URL中的數據並組裝為對象:
后端對應的Controller:
使用PostMan測試:
注:
如果在后端方法參數前,指定了@RequestParam()的話,那么前端必須要有對應字段才行(當然可以通過設置
該注解的required屬性來調節是否必須傳),否者會報錯;如果參數前沒有任何該注解,那么前端可以傳,也可以不傳,如:
上圖中,如果我們傳參中沒有指定token,那么請求能正常進去,但是token為null;如果在String token前指定了@RequestParam(“token”),那么前端必須要有token這個鍵時,請求才能正常進去,否者報400錯誤。