一、前言

一直有這么一個(gè)疑問(wèn)：在使用postman工具測(cè)試api接口的時(shí)候，如何使用 json 字符串傳值呢，而不是使用 x-www-form-urlencoded 類型，畢竟通過(guò) key-value 傳值是有局限性的。假如我要測(cè)試批量插入數(shù)據(jù)的接口呢，使用 x-www-form-urlencoded 方法根本就不適用于這種場(chǎng)景。

那么如何通過(guò)postman工具使用json字符串傳值呢，這里就引申出來(lái)了spring的兩個(gè)注解：

• @RequestParam
• @RequestBody

總而言之，這兩個(gè)注解都可以在后臺(tái)接收參數(shù)，但是使用場(chǎng)景不一樣。繼續(xù)往下看

二、@RequestParam

先介紹一下@RequestParam的使用場(chǎng)景：

注解@RequestParam接收的參數(shù)是來(lái)自requestHeader中即請(qǐng)求頭或body（請(qǐng)求體）。

通常用于GET請(qǐng)求，比如常見(jiàn)的url：//localhost:8081/spring-boot-study/novel/findByAuthorAndType?author=唐家三少&type=已完結(jié)，其在Controller 層的寫法如下圖所示：

@RequestParam有三個(gè)配置參數(shù)：

• required 表示是否必須，默認(rèn)為 true，必須。
• defaultValue 可設(shè)置請(qǐng)求參數(shù)的默認(rèn)值。
• value 為接收url的參數(shù)名（相當(dāng)于key值）。

@RequestParam用來(lái)處理 Content-Type 為 application/x-www-form-urlencoded 編碼的內(nèi)容，Content-Type默認(rèn)為該屬性。

@RequestParam也可用于其它類型的請(qǐng)求，例如：POST、DELETE等請(qǐng)求。比如向表中插入單條數(shù)據(jù)，Controller 層的寫法如下圖所示：

由于@RequestParam是用來(lái)處理 Content-Type 為 application/x-www-form-urlencoded 編碼的內(nèi)容的，所以在postman中，要選擇body的類型為 x-www-form-urlencoded，這樣在headers中就自動(dòng)變?yōu)榱?Content-Type : application/x-www-form-urlencoded 編碼格式。

如下圖所示：

但是這樣不支持批量插入數(shù)據(jù)啊，如果改用 json 字符串來(lái)傳值的話，類型設(shè)置為 application/json，點(diǎn)擊發(fā)送的話，會(huì)報(bào)錯(cuò)，后臺(tái)接收不到值，為 null。

這時(shí)候，注解@RequestBody就派上用場(chǎng)了。

三、@RequestBody

先介紹一下@RequestBody的使用場(chǎng)景：

注解@RequestBody接收的參數(shù)是來(lái)自requestBody中，即請(qǐng)求體。

一般用于處理非 Content-Type: application/x-www-form-urlencoded編碼格式的數(shù)據(jù)，比如：application/json、application/xml等類型的數(shù)據(jù)。

就application/json類型的數(shù)據(jù)而言，使用注解@RequestBody可以將body里面所有的json數(shù)據(jù)傳到后端，后端再進(jìn)行解析。

3.1 向表中批量插入數(shù)據(jù)

舉個(gè)批量插入數(shù)據(jù)的例子，Controller層的寫法如下圖所示：

由于@RequestBody可用來(lái)處理 Content-Type 為 application/json 編碼的內(nèi)容，所以在postman中，選擇body的類型為row -> JSON(application/json)，這樣在 Headers 中也會(huì)自動(dòng)變?yōu)?Content-Type : application/json 編碼格式。body內(nèi)的數(shù)據(jù)如下圖所示：

批量向表中插入兩條數(shù)據(jù)，這里的 saveBatchNovel()方法已經(jīng)封裝了 JPA的 saveAll() 方法。body 里面的 json 語(yǔ)句的 key 值要與后端實(shí)體類的屬性一一對(duì)應(yīng)。

注意：前端使用$.ajax的話，一定要指定 contentType: “application/json;charset=utf-8;”，默認(rèn)為 application/x-www-form-urlencoded。

3.2 后端解析json數(shù)據(jù)

上述示例是傳遞到實(shí)體類中的具體寫法，那么如果傳遞到非實(shí)體類中，body里面的json數(shù)據(jù)需要怎么解析呢？我們?cè)賮?lái)看下面這個(gè)例子：

在body中，我們還是輸入上面的json數(shù)據(jù)，根據(jù)分析，上面的json數(shù)據(jù)是一個(gè)List數(shù)組內(nèi)嵌套著map對(duì)象，那么在后臺(tái)的接收形式可寫為 List<Map<String, String>>，具體代碼如下圖所示：

控制臺(tái)輸出：

四、總結(jié)

注解@RequestParam接收的參數(shù)是來(lái)自requestHeader中，即請(qǐng)求頭。

通常用于GET請(qǐng)求，像POST、DELETE等其它類型的請(qǐng)求也可以使用。

注解@RequestBody接收的參數(shù)是來(lái)自requestBody中，即請(qǐng)求體。

一般用于處理非 Content-Type: application/x-www-form-urlencoded編碼格式的數(shù)據(jù)，比如：application/json、application/xml等類型的數(shù)據(jù)。通常用于接收POST、DELETE等類型的請(qǐng)求數(shù)據(jù)，GET類型也可以適用。

**重點(diǎn)補(bǔ)充：

**在使用注解@RequestParam的時(shí)候【不加注解的時(shí)候效果與@RequestParam類似】，在body data中我們不能傳json字符串類型的參數(shù)，否則對(duì)象中是接收不到傳遞參數(shù)相應(yīng)的值。

相應(yīng)的在@RequestBody注解標(biāo)記的形式上傳遞表格參數(shù)則會(huì)報(bào)錯(cuò)。

postman模擬發(fā)送請(qǐng)求【@RequestParam接受json字符串】：

debug斷點(diǎn)后頁(yè)面展示的結(jié)果：

postman模擬發(fā)送請(qǐng)求【@RequestBody接受application/x-www-form-urlencoded表格參數(shù)】：

代碼以及報(bào)錯(cuò)顯示：

到此這篇關(guān)于Spring中@RequestParam與@RequestBody的使用場(chǎng)景詳解的文章就介紹到這了,更多相關(guān)@RequestParam與@RequestBody注解內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論