本篇文章為大家展示了如何正確的使用@RequestBody,內(nèi)容簡(jiǎn)明扼要并且容易理解,絕對(duì)能使你眼前一亮,通過這篇文章的詳細(xì)介紹希望你能有所收獲。
在網(wǎng)站設(shè)計(jì)制作、網(wǎng)站設(shè)計(jì)過程中,需要針對(duì)客戶的行業(yè)特點(diǎn)、產(chǎn)品特性、目標(biāo)受眾和市場(chǎng)情況進(jìn)行定位分析,以確定網(wǎng)站的風(fēng)格、色彩、版式、交互等方面的設(shè)計(jì)方向。創(chuàng)新互聯(lián)公司還需要根據(jù)客戶的需求進(jìn)行功能模塊的開發(fā)和設(shè)計(jì),包括內(nèi)容管理、前臺(tái)展示、用戶權(quán)限管理、數(shù)據(jù)統(tǒng)計(jì)和安全保護(hù)等功能。
基礎(chǔ)知識(shí)介紹:
@RequestBody主要用來接收前端傳遞給后端的json字符串中的數(shù)據(jù)的(請(qǐng)求體中的數(shù)據(jù)的);GET方式無請(qǐng)求體,所以使用@RequestBody接收數(shù)據(jù)時(shí),前端不能使用GET方式提交數(shù)據(jù),而是用POST方式進(jìn)行提交。在后端的同一個(gè)接收方法里,@RequestBody與@RequestParam()可以同時(shí)使用,@RequestBody最多只能有一個(gè),而@RequestParam()可以有多個(gè)。
注:一個(gè)請(qǐng)求,只有一個(gè)RequestBody;一個(gè)請(qǐng)求,可以有多個(gè)RequestParam。
注:當(dāng)同時(shí)使用@RequestParam()和@RequestBody時(shí),@RequestParam()指定的參數(shù)可以是普通元素、
數(shù)組、集合、對(duì)象等等(即:當(dāng),@RequestBody 與@RequestParam()可以同時(shí)使用時(shí),原SpringMVC接收
參數(shù)的機(jī)制不變,只不過RequestBody 接收的是請(qǐng)求體里面的數(shù)據(jù);而RequestParam接收的是key-value
里面的參數(shù),所以它會(huì)被切面進(jìn)行處理從而可以用普通元素、數(shù)組、集合、對(duì)象等接收)。
即:如果參數(shù)時(shí)放在請(qǐng)求體中,傳入后臺(tái)的話,那么后臺(tái)要用@RequestBody才能接收到;如果不是放在
請(qǐng)求體中的話,那么后臺(tái)接收前臺(tái)傳過來的參數(shù)時(shí),要用@RequestParam來接收,或則形參前
什么也不寫也能接收。
注:如果參數(shù)前寫了@RequestParam(xxx),那么前端必須有對(duì)應(yīng)的xxx名字才行(不管其是否有值,當(dāng)然可以通
過設(shè)置該注解的required屬性來調(diào)節(jié)是否必須傳),如果沒有xxx名的話,那么請(qǐng)求會(huì)出錯(cuò),報(bào)400。
注:如果參數(shù)前不寫@RequestParam(xxx)的話,那么就前端可以有可以沒有對(duì)應(yīng)的xxx名字才行,如果有xxx名
的話,那么就會(huì)自動(dòng)匹配;沒有的話,請(qǐng)求也能正確發(fā)送。
追注:這里與feign消費(fèi)服務(wù)時(shí)不同;feign消費(fèi)服務(wù)時(shí),如果參數(shù)前什么也不寫,那么會(huì)被默認(rèn)是
@RequestBody的。
如果后端參數(shù)是一個(gè)對(duì)象,且該參數(shù)前是以@RequestBody修飾的,那么前端傳遞json參數(shù)時(shí),必須滿足以下要求:
后端@RequestBody注解對(duì)應(yīng)的類在將HTTP的輸入流(含請(qǐng)求體)裝配到目標(biāo)類(即:@RequestBody后面的類)時(shí),會(huì)根據(jù)json字符串中的key來匹配對(duì)應(yīng)實(shí)體類的屬性,如果匹配一致且json中的該key對(duì)應(yīng)的值符合(或可轉(zhuǎn)換為),這一條我會(huì)在下面詳細(xì)分析,其他的都可簡(jiǎn)單略過,但是本文末的核心邏輯代碼以及幾個(gè)結(jié)論一定要看!實(shí)體類的對(duì)應(yīng)屬性的類型要求時(shí),會(huì)調(diào)用實(shí)體類的setter方法將值賦給該屬性。
json字符串中,如果value為""的話,后端對(duì)應(yīng)屬性如果是String類型的,那么接受到的就是"",如果是后端屬性的類型是Integer、Double等類型,那么接收到的就是null。
json字符串中,如果value為null的話,后端對(duì)應(yīng)收到的就是null。
如果某個(gè)參數(shù)沒有value的話,在傳json字符串給后端時(shí),要么干脆就不把該字段寫到j(luò)son字符串中;要么寫value時(shí), 必須有值,null 或""都行。千萬不能有類似"stature":,這樣的寫法,如:
注:關(guān)于@RequestParam()的用法,這里就不再一一說明了,可詳見 《程序員成長(zhǎng)筆記(一)》中的相關(guān)章節(jié)。
示例詳細(xì)說明:
先給出兩個(gè)等下要用到的實(shí)體類
User實(shí)體類:
Team實(shí)體類:
@RequestBody直接以String接收前端傳過來的json數(shù)據(jù):
后端對(duì)應(yīng)的Controller:
使用PostMan測(cè)試:
@RequestBody以簡(jiǎn)單對(duì)象接收前端傳過來的json數(shù)據(jù):
后端對(duì)應(yīng)的Controller:
使用PostMan測(cè)試:
@RequestBody以復(fù)雜對(duì)象接收前端傳過來的json數(shù)據(jù):
后端對(duì)應(yīng)的Controller:
使用PostMan測(cè)試:
@RequestBody與簡(jiǎn)單的@RequestParam()同時(shí)使用:
后端對(duì)應(yīng)的Controller:
使用PostMan測(cè)試:
@RequestBody與復(fù)雜的@RequestParam()同時(shí)使用:
后端對(duì)應(yīng)的Controller:
使用PostMan測(cè)試:
@RequestBody接收請(qǐng)求體中的json數(shù)據(jù);不加注解接收URL中的數(shù)據(jù)并組裝為對(duì)象:
后端對(duì)應(yīng)的Controller:
使用PostMan測(cè)試:
注:如果在后端方法參數(shù)前,指定了@RequestParam()的話,那么前端必須要有對(duì)應(yīng)字段才行(當(dāng)然可以通過設(shè)置
該注解的required屬性來調(diào)節(jié)是否必須傳),否者會(huì)報(bào)錯(cuò);如果參數(shù)前沒有任何該注解,那么前端可以傳,也可
以不傳,如:
上圖中,如果我們傳參中沒有指定token,那么請(qǐng)求能正常進(jìn)去,但是token為null;如果在String token前指定了@RequestParam(“token”),那么前端必須要有token這個(gè)鍵時(shí),請(qǐng)求才能正常進(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傳遞請(qǐng)求體信息,最終會(huì)被封裝進(jìn)com.fasterxml.jackson.core.json.UTF8StreamJsonParser中(提示:Spring采用CharacterEncodingFilter設(shè)置了默認(rèn)編碼為UTF-8),然后在public class BeanDeserializer extends BeanDeserializerBase implements java.io.Serializable中,通過 public Object deserializeFromObject(JsonParser p, DeserializationContext ctxt) throws IOException方法進(jìn)行解析。
核心邏輯分析示例:
假設(shè)前端傳的json串是這樣的: {"name1":"鄧沙利文","age":123,"mot":"我是一只小小小小鳥~"}后端的模型只有name和age屬性,以及對(duì)應(yīng)的setter/getter方法;給出一般用到的deserializeFromObject(JsonParser p, DeserializationContext ctxt)方法的核心邏輯:
小技巧之指定模型中的屬性對(duì)應(yīng)什么key
這里簡(jiǎn)單介紹,更多的可參考:
publicclassBeanPropertyMap implementsIterable
給出Controller中的測(cè)試類:
給出模型中的屬性(setter/getter方法沒截出來):
使用postman測(cè)試一下,示例:
上圖簡(jiǎn)單測(cè)試了一下,但是測(cè)得并不全面,這里就不帶大家一起測(cè)試了,直接給出。
全面的結(jié)論:
結(jié)論①:@JsonAlias注解,實(shí)現(xiàn):json轉(zhuǎn)模型時(shí),使json中的特定key能轉(zhuǎn)化為特定的模型屬性;但是模型轉(zhuǎn)json時(shí),對(duì)應(yīng)的轉(zhuǎn)換后的key仍然與屬性名一致,見:上圖示例中的name字段的請(qǐng)求與響應(yīng)。
以下圖進(jìn)一步說明:
此時(shí),json字符串轉(zhuǎn)換為模型時(shí),json中key為Name或?yàn)閚ame123或?yàn)閚ame的都能識(shí)別。
結(jié)論②:@JsonProperty注解,實(shí)現(xiàn):json轉(zhuǎn)模型時(shí),使json中的特定key能轉(zhuǎn)化為指定的模型屬性;同樣的,模型轉(zhuǎn)json時(shí),對(duì)應(yīng)的轉(zhuǎn)換后的key為指定的key,見:示例中的motto字段的請(qǐng)求與響應(yīng)。
以下圖進(jìn)一步說明:
此時(shí),json字符串轉(zhuǎn)換為模型時(shí),key為MOTTO的能識(shí)別,但key為motto的不能識(shí)別。
結(jié)論③:@JsonAlias注解需要依賴于setter、getter,而@JsonProperty注解不需要。
結(jié)論④:在不考慮上述兩個(gè)注解的一般情況下,key與屬性匹配時(shí),默認(rèn)大小寫敏感。
結(jié)論⑤:有多個(gè)相同的key的json字符串中,轉(zhuǎn)換為模型時(shí),會(huì)以相同的幾個(gè)key中,排在最后的那個(gè)key的值給模型屬性復(fù)制,因?yàn)閟etter會(huì)覆蓋原來的值。見示例中的gender屬性。
結(jié)論⑥:后端@RequestBody注解對(duì)應(yīng)的類在將HTTP的輸入流(含請(qǐng)求體)裝配到目標(biāo)類(即:@RequestBody后面的類)時(shí),會(huì)根據(jù)json字符串中的key來匹配對(duì)應(yīng)實(shí)體類的屬性,如果匹配一致且json中的該key對(duì)應(yīng)的值符合(或可轉(zhuǎn)換為)實(shí)體類的對(duì)應(yīng)屬性的類型要求時(shí),會(huì)調(diào)用實(shí)體類的setter方法將值賦給該屬性。
上述內(nèi)容就是如何正確的使用@RequestBody,你們學(xué)到知識(shí)或技能了嗎?如果還想學(xué)到更多技能或者豐富自己的知識(shí)儲(chǔ)備,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。