Spring中@RequestParam與@RequestBody的使用場景詳解
一、前言
一直有這么一個疑問:在使用postman工具測試api接口的時候,如何使用 json 字符串傳值呢,而不是使用 x-www-form-urlencoded 類型,畢竟通過 key-value 傳值是有局限性的。假如我要測試批量插入數(shù)據(jù)的接口呢,使用 x-www-form-urlencoded 方法根本就不適用于這種場景。
那么如何通過postman工具使用json字符串傳值呢,這里就引申出來了spring的兩個注解:
- @RequestParam
- @RequestBody
總而言之,這兩個注解都可以在后臺接收參數(shù),但是使用場景不一樣。繼續(xù)往下看
二、@RequestParam
先介紹一下@RequestParam的使用場景:
注解@RequestParam接收的參數(shù)是來自requestHeader中即請求頭或body(請求體)。
通常用于GET請求,比如常見的url://localhost:8081/spring-boot-study/novel/findByAuthorAndType?author=唐家三少&type=已完結(jié),其在Controller 層的寫法如下圖所示:
@RequestParam有三個配置參數(shù):
- required 表示是否必須,默認為 true,必須。
- defaultValue 可設(shè)置請求參數(shù)的默認值。
- value 為接收url的參數(shù)名(相當于key值)。
@RequestParam用來處理 Content-Type 為 application/x-www-form-urlencoded 編碼的內(nèi)容,Content-Type默認為該屬性。
@RequestParam也可用于其它類型的請求,例如:POST、DELETE等請求。比如向表中插入單條數(shù)據(jù),Controller 層的寫法如下圖所示:
由于@RequestParam是用來處理 Content-Type 為 application/x-www-form-urlencoded 編碼的內(nèi)容的,所以在postman中,要選擇body的類型為 x-www-form-urlencoded,這樣在headers中就自動變?yōu)榱?Content-Type : application/x-www-form-urlencoded 編碼格式。
如下圖所示:
但是這樣不支持批量插入數(shù)據(jù)啊,如果改用 json 字符串來傳值的話,類型設(shè)置為 application/json,點擊發(fā)送的話,會報錯,后臺接收不到值,為 null。
這時候,注解@RequestBody就派上用場了。
三、@RequestBody
先介紹一下@RequestBody的使用場景:
注解@RequestBody接收的參數(shù)是來自requestBody中,即請求體。
一般用于處理非 Content-Type: application/x-www-form-urlencoded編碼格式的數(shù)據(jù),比如:application/json、application/xml等類型的數(shù)據(jù)。
就application/json類型的數(shù)據(jù)而言,使用注解@RequestBody可以將body里面所有的json數(shù)據(jù)傳到后端,后端再進行解析。
3.1 向表中批量插入數(shù)據(jù)
舉個批量插入數(shù)據(jù)的例子,Controller層的寫法如下圖所示:
由于@RequestBody可用來處理 Content-Type 為 application/json 編碼的內(nèi)容,所以在postman中,選擇body的類型為row -> JSON(application/json),這樣在 Headers 中也會自動變?yōu)?Content-Type : application/json 編碼格式。body內(nèi)的數(shù)據(jù)如下圖所示:
批量向表中插入兩條數(shù)據(jù),這里的 saveBatchNovel()方法已經(jīng)封裝了 JPA的 saveAll() 方法。body 里面的 json 語句的 key 值要與后端實體類的屬性一一對應(yīng)。
注意:前端使用$.ajax的話,一定要指定 contentType: “application/json;charset=utf-8;”,默認為 application/x-www-form-urlencoded。
3.2 后端解析json數(shù)據(jù)
上述示例是傳遞到實體類中的具體寫法,那么如果傳遞到非實體類中,body里面的json數(shù)據(jù)需要怎么解析呢?我們再來看下面這個例子:
在body中,我們還是輸入上面的json數(shù)據(jù),根據(jù)分析,上面的json數(shù)據(jù)是一個List數(shù)組內(nèi)嵌套著map對象,那么在后臺的接收形式可寫為 List<Map<String, String>>,具體代碼如下圖所示:
控制臺輸出:
四、總結(jié)
注解@RequestParam接收的參數(shù)是來自requestHeader中,即請求頭。
通常用于GET請求,像POST、DELETE等其它類型的請求也可以使用。
注解@RequestBody接收的參數(shù)是來自requestBody中,即請求體。
一般用于處理非 Content-Type: application/x-www-form-urlencoded編碼格式的數(shù)據(jù),比如:application/json、application/xml等類型的數(shù)據(jù)。通常用于接收POST、DELETE等類型的請求數(shù)據(jù),GET類型也可以適用。
**重點補充:
**在使用注解@RequestParam的時候【不加注解的時候效果與@RequestParam類似】,在body data中我們不能傳json字符串類型的參數(shù),否則對象中是接收不到傳遞參數(shù)相應(yīng)的值。
相應(yīng)的在@RequestBody注解標記的形式上傳遞表格參數(shù)則會報錯。
postman模擬發(fā)送請求【@RequestParam接受json字符串】:
debug斷點后頁面展示的結(jié)果:
postman模擬發(fā)送請求【@RequestBody接受application/x-www-form-urlencoded表格參數(shù)】:
代碼以及報錯顯示:
到此這篇關(guān)于Spring中@RequestParam與@RequestBody的使用場景詳解的文章就介紹到這了,更多相關(guān)@RequestParam與@RequestBody注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
java DataInputStream和DataOutputStream詳解及實例代碼
這篇文章主要介紹了java DataInputStream和DataOutputStream詳解及實例代碼的相關(guān)資料,需要的朋友可以參考下2017-01-01SpringBoot Application的exclude不生效問題及排查
這篇文章主要介紹了SpringBoot Application的exclude不生效問題及排查,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2023-11-11Java設(shè)計模塊系列之書店管理系統(tǒng)單機版(一)
這篇文章主要為大家詳細介紹了Java單機版的書店管理系統(tǒng)設(shè)計模塊和思想第一章,感興趣的小伙伴們可以參考一下2016-08-08Java8中對于LocalDateTime的序列化和反序列化問題
這篇文章主要介紹了Java8中對于LocalDateTime的序列化和反序列化問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-06-06