第@RequestBody注解的原理及使用技巧分享目錄基礎(chǔ)知識介紹示例詳細(xì)說明@RequestBody與前端傳過來的json數(shù)據(jù)的匹配規(guī)則核心邏輯分析示例小技巧之指定模型中的屬性對應(yīng)什么key全面的結(jié)論結(jié)論①結(jié)論②結(jié)論③結(jié)論④結(jié)論⑤結(jié)論⑥本文是基于SpringBoot，進(jìn)行的演示說明。

基礎(chǔ)知識介紹

@RequestBody主要用來接收前端傳遞給后端的json字符串中的數(shù)據(jù)的(請求體中的數(shù)據(jù)的)；GET方式無請求體，所以使用@RequestBody接收數(shù)據(jù)時(shí)，前端不能使用GET方式提交數(shù)據(jù)，而是用POST方式進(jìn)行提交。

在后端的同一個(gè)接收方法里，@RequestBody與@RequestParam()可以同時(shí)使用，@RequestBody最多只能有一個(gè)，而@RequestParam()可以有多個(gè)。

注：一個(gè)請求，只有一個(gè)RequestBody；一個(gè)請求，可以有多個(gè)RequestParam。注：當(dāng)同時(shí)使用@RequestParam（）和@RequestBody時(shí)，@RequestParam（）指定的參數(shù)可以是普通元素、數(shù)組、集合、對象等等(即:當(dāng)，@RequestBody與@RequestParam()可以同時(shí)使用時(shí)，原SpringMVC接收參數(shù)的機(jī)制不變，只不過RequestBody接收的是請求體里面的數(shù)據(jù)；而RequestParam接收的是key-value里面的參數(shù)，所以它會(huì)被切面進(jìn)行處理從而可以用普通元素、數(shù)組、集合、對象等接收)。即：如果參數(shù)時(shí)放在請求體中，傳入后臺的話，那么后臺要用@RequestBody才能接收到；如果不是放在請求體中的話，那么后臺接收前臺傳過來的參數(shù)時(shí)，要用@RequestParam來接收，或則形參前什么也不寫也能接收。注：如果參數(shù)前寫了@RequestParam(xxx)，那么前端必須有對應(yīng)的xxx名字才行(不管其是否有值，當(dāng)然可以通過設(shè)置該注解的required屬性來調(diào)節(jié)是否必須傳)，如果沒有xxx名的話，那么請求會(huì)出錯(cuò)，報(bào)400。注：如果參數(shù)前不寫@RequestParam(xxx)的話，那么就前端可以有可以沒有對應(yīng)的xxx名字才行，如果有xxx名的話，那么就會(huì)自動(dòng)匹配；沒有的話，請求也能正確發(fā)送。追注：這里與feign消費(fèi)服務(wù)時(shí)不同；feign消費(fèi)服務(wù)時(shí)，如果參數(shù)前什么也不寫，那么會(huì)被默認(rèn)是@RequestBody的。

如果后端參數(shù)是一個(gè)對象，且該參數(shù)前是以@RequestBody修飾的，那么前端傳遞json參數(shù)時(shí)

必須滿足以下要求：

后端@RequestBody注解對應(yīng)的類在將HTTP的輸入流(含請求體)裝配到目標(biāo)類(即：@RequestBody后面的類)時(shí)，會(huì)根據(jù)json字符串中的key來匹配對應(yīng)實(shí)體類的屬性，如果匹配一致且json中的該key對應(yīng)的值符合(或可轉(zhuǎn)換為)，這一條我會(huì)在下面詳細(xì)分析，其他的都可簡單略過，但是本文末的核心邏輯代碼以及幾個(gè)結(jié)論一定要看！實(shí)體類的對應(yīng)屬性的類型要求時(shí),會(huì)調(diào)用實(shí)體類的setter方法將值賦給該屬性。json字符串中，如果value為的話，后端對應(yīng)屬性如果是String類型的，那么接受到的就是，如果是后端屬性的類型是Integer、Double等類型，那么接收到的就是null。json字符串中，如果value為null的話，后端對應(yīng)收到的就是null。如果某個(gè)參數(shù)沒有value的話，在傳json字符串給后端時(shí)，要么干脆就不把該字段寫到j(luò)son字符串中；要么寫value時(shí)，必須有值，null或都行。千萬不能有類似stature:，這樣的寫法，如:

示例詳細(xì)說明

先給出兩個(gè)等下要用到的實(shí)體類

User實(shí)體類：

publicclassUser{

privateStringname;//姓名

privateIntegerage;//年齡

privateStringgender;//性別

privateStringmotto;//座右銘

//geter和seter方法

publicStringgetName(){

returnname;

publicvoidsetName(Stringname){

=name;

publicIntegergetAge(){

returnage;

publicvoidsetAge(Integerage){

this.age=age;

publicStringgetGender(){

returngender;

publicvoidsetGender(Stringgender){

this.gender=gender;

publicStringgetMotto(){

returnmotto;

publicvoidsetMotto(Stringmotto){

this.motto=motto;

//重寫toString方法

@Override

publicStringtoString(){

returnage+"歲"+gender+"人["+name+"]的座右銘是:"+motto;

}

Team實(shí)體類：

classTeam{

privateIntegerid;//id

privateStringteamName;//小組名

privateListStringhonors;//所獲稱號

privateListUserteamMembers;//小組成員

//geter和seter方法

publicIntegergetId(){

returnid;

publicvoidsetId(Integerid){

this.id=id;

publicStringgetTeamName(){

returnteamName;

publicvoidsetTeamName(StringteamName){

this.teamName=teamName;

publicListStringgetHonors(){

returnhonors;

publicvoidsetHonors(ListStringhonors){

this.honors=honors;

publicListUsergetTeamMembers(){

returnteamMembers;

publicvoidsetTeamMembers(ListUserteamMembers){

this.teamMembers=teamMembers;

//重寫toString方法

@Override

publicStringtoString(){

//遍歷出小組所獲榮耀

StringBuffersbHonors=newStringBuffer("榮耀start----\n");

for(Stringhonor:honors){

sbHonors.append(honor);

sbHonors.append("\n");

sbHonors.append("榮耀end----\n");

//遍歷出小組成員

StringBuffersbMenbers=newStringBuffer("成員start---\n");

for(Useruser:teamMembers){

sbMenbers.append(user.toString());

sbMenbers.append("\n");

sbMenbers.append("成員end---\n");

return"小組id:"+id+"\n"+"小組名字:"+teamName+"\n"+"小組所獲榮耀："

+sbHonors+"\n"+"小組成員："+sbMenbers;

}

@RequestBody直接以String接收前端傳過來的json數(shù)據(jù)：

后端對應(yīng)的Controller：

使用PostMan測試：

@RequestBody以簡單對象接收前端傳過來的json數(shù)據(jù)：

后端對應(yīng)的Controller：

使用PostMan測試：

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

后端對應(yīng)的Controller：

使用PostMan測試：

@RequestBody與復(fù)雜的@RequestParam()同時(shí)使用：

后端對應(yīng)的Controller

使用PostMan測試：

@RequestBody接收請求體中的json數(shù)據(jù)；不加注解接收URL中的數(shù)據(jù)并組裝為對象：

后端對應(yīng)的Controller：

使用PostMan測試：

注：如果在后端方法參數(shù)前，指定了@RequestParam()的話，那么前端必須要有對應(yīng)字段才行(當(dāng)然可以通過設(shè)置該注解的required屬性來調(diào)節(jié)是否必須傳)，否者會(huì)報(bào)錯(cuò)；如果參數(shù)前沒有任何該注解，那么前端可以傳，也可以不傳，如：

上圖中，如果我們傳參中沒有指定token，那么請求能正常進(jìn)去，但是token為null；如果在Stringtoken前指定了@RequestParam(token)，那么前端必須要有token這個(gè)鍵時(shí)，請求才能正常進(jìn)去，否者報(bào)400錯(cuò)誤。

@RequestBody與前端傳過來的json數(shù)據(jù)的匹配規(guī)則

聲明：根據(jù)不同的Content-Type等情況,Spring-MVC會(huì)采取不同的HttpMessageConverter實(shí)現(xiàn)來進(jìn)行信息轉(zhuǎn)換解析。

下面介紹的是最常用的：前端以Content-Type為application/json,傳遞json字符串?dāng)?shù)據(jù);后端以@RequestBody模型接收數(shù)據(jù)的情況。

解析json數(shù)據(jù)大體流程概述：

Http傳遞請求體信息，最終會(huì)被封裝進(jìn)com.fasterxml.jackson.core.json.UTF8StreamJsonParser中(提示：Spring采用CharacterEncodingFilter設(shè)置了默認(rèn)編碼為UTF-8)，然后在publicclassBeanDeserializerextendsBeanDeserializerBaseimplementsjava.io.Serializable中，通過publicObjectdeserializeFromObject(JsonParserp,DeserializationContextctxt)throwsIOException方法進(jìn)行解析。

核心邏輯分析示例

假設(shè)前端傳的json串是這樣的：{name1:鄧沙利文,age:123,mot:我是一只小小小小鳥~}后端的模型只有name和age屬性，以及對應(yīng)的setter/getter方法；給出一般用到的deserializeFromObject(JsonParserp,DeserializationContextctxt)方法的核心邏輯：

小技巧之指定模型中的屬性對應(yīng)什么key

這里簡單介紹，更多的可參考：

publicclassBeanPropertyMapimplementsIterableSettableBeanProperty,java.io.Serializable

給出Controller中的測試類:

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

使用postman測試一下，示例：

上圖簡單測試了一下，但是測得并不全面,這里就不帶大家一起測試了，直接給出。

全面的結(jié)論

結(jié)論①

@JsonAlias注解，實(shí)現(xiàn):json轉(zhuǎn)模型時(shí)，使json中的特定key能轉(zhuǎn)化為特定的模型屬性;但是模型轉(zhuǎn)json時(shí)，對應(yīng)的轉(zhuǎn)換后的key仍然與屬性名一致，見：上圖示例中的name字段的請求與響應(yīng)。

以下圖進(jìn)一步說明：

此時(shí)，json字符串轉(zhuǎn)換為模型時(shí)，json中key為Name或?yàn)閚ame123或?yàn)閚ame的都能識別。