快捷導(dǎo)航

SpringBoot傳遞單一參數(shù)時(shí)@RequestParam和@RequestBody的區(qū)別小結(jié)

更新時(shí)間：2023年08月25日 09:34:01 作者：SiegfriedG

用SpringBoot框架做項(xiàng)目時(shí),經(jīng)常需要前端給后端傳遞參數(shù),本文主要介紹了SpringBoot傳遞單一參數(shù)時(shí)@RequestParam和@RequestBody的區(qū)別,具有一定的參考價(jià)值,感興趣的可以了解一下

用SpringBoot框架做項(xiàng)目時(shí)，經(jīng)常需要前端給后端傳遞參數(shù)，如果需要多條參數(shù)，通常的做法是把這些參數(shù)封裝為一個(gè)對(duì)象來傳遞，前端用POST方式調(diào)用。但有時(shí)會(huì)遇到后端只需要一條參數(shù)（比如一個(gè)String）的情況，此時(shí)如果還封裝為一個(gè)對(duì)象，有些多余；最好的辦法是用GET方式調(diào)用，直接把參數(shù)拼接在url后面。但，一般項(xiàng)目都有統(tǒng)一的接口規(guī)范，要求接口都要用POST方式，此時(shí)就遇到一個(gè)問題：controller方法上到底是用@RequestParam注解還是用@RequestBody注解？

之前對(duì)這兩個(gè)注解的區(qū)別，只有一個(gè)粗枝大葉的理解——@RequestParam針對(duì)單一的參數(shù)，而@RequestBody針對(duì)多個(gè)參數(shù)封裝為一個(gè)對(duì)象，問了身邊幾個(gè)同事，大概也都是這種理解。但是，實(shí)際測(cè)試中（使用Postman），當(dāng)我用@RequestParam接受String的單一參數(shù)時(shí)，前端給我傳遞的參數(shù)卻接收不到。于是決定通過實(shí)驗(yàn)，徹底搞明白二者的區(qū)別（針對(duì)單一參數(shù)、POST方法的場(chǎng)景）。實(shí)驗(yàn)的過程是分別用@RequestParam和@RequestBody兩個(gè)注解去接受前端傳遞的一個(gè)名為content的String。

實(shí)驗(yàn)一：使用@RequestParam注解

Controller方法代碼：（省略其他部分以及返回值Result代碼）

@RequestMapping(value="/requestParam", method= RequestMethod.POST, produces = "application/json;charset=UTF-8")
public Result<String> requestParam(@RequestParam("content") String content) {
	System.out.println("content:"+content);
	return success(new Result<String>(), content);

現(xiàn)在我用postman來測(cè)試幾種可能的參數(shù)傳遞方式：

1. 在Body的raw里面?zhèn)鬟f，也是最通常的傳參方式：

body-raw

結(jié)果是接收不到（不管是用text還是json等各種文本形式）！

 { "timestamp": 1544798083474,
    "status": 400,
    "error": "Bad Request",
    "exception": "org.springframework.web.bind.MissingServletRequestParameterException",
    "message": "Required String parameter 'content' is not present",
    "path": "/testParam/requestParam"
  }

2. 在Headers里通過key-value的形式傳遞。這是網(wǎng)上一些帖子里說的方式。

Headers方式

但結(jié)果還是接收不到！和上面一樣報(bào)錯(cuò)400。

關(guān)于這一點(diǎn)，網(wǎng)上有些帖子里說@RequestParam的參數(shù)會(huì)寫到Headers里，可見是錯(cuò)誤的，并非在Headers里，還是在Body里。

3. 在Body的form-data里通過key-value的形式傳遞，可以接收！

form-data

但是，前端調(diào)后端接口傳參時(shí)，是無法向這個(gè)form-data里傳遞參數(shù)的，所以這種方法只能被排除。

4. 在url后問號(hào)拼接參數(shù)。和很多人一樣，之前一直根深蒂固地認(rèn)為只有GET方式才能用url問號(hào)傳參，POST方式不行，但事實(shí)證明在這里問號(hào)傳參POST方式同樣能接收到。如圖：

問號(hào)傳參

雖然能接受到參數(shù)，但前端也有統(tǒng)一的規(guī)范，一般不使用問號(hào)傳參的方式，所以這種方法也被排除。

實(shí)驗(yàn)二：使用@RequestBody注解

@RequestMapping(value="/requestBody", method= RequestMethod.POST, produces = "application/json;charset=UTF-8")
public Result<String> requestBody(@RequestBody String content) {
	System.out.println("content:"+content);
	return success(new Result<String>(), content);
}

既然是Body，自然不能在header里傳參，也不能在url里問號(hào)傳參。至于Body的form-data，經(jīng)測(cè)試也無效。所以，這里只有唯一一種方式，就是將參數(shù)直接寫在Body的raw模式下，實(shí)驗(yàn)結(jié)果：可以接收到，如圖：

body

注意：這里body體里面?zhèn)魇裁磧?nèi)容，后臺(tái)就會(huì)原樣接收，所以不要寫成content: XXX這種鍵值對(duì)形式，而應(yīng)直接把String的內(nèi)容寫在body體里。

總結(jié)：

對(duì)于傳遞單一參數(shù)（最典型的是String）的場(chǎng)合，理論上最簡便的方法是用GET請(qǐng)求。但鑒于很多項(xiàng)目接口統(tǒng)一要求使用POST方式，此時(shí)不能使用@RequestParam方式，因?yàn)榇朔绞角岸藗鬟f的參數(shù)后端無法接收；而只能用@RequestBody，直接將需要的參數(shù)內(nèi)容寫入Body體，后端即可正常獲?。?/p>

到此這篇關(guān)于SpringBoot傳遞單一參數(shù)時(shí)@RequestParam和@RequestBody的區(qū)別小結(jié)的文章就介紹到這了,更多相關(guān)SpringBoot @RequestParam @RequestBody內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: