@RequestBody與post請(qǐng)求的關(guān)系

@RequestBody主要用來(lái)接收前端傳遞給后端的json字符串中的數(shù)據(jù)的(請(qǐng)求體中的數(shù)據(jù)的)；

GET方式無(wú)請(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ī)制不變，只不過(guò)RequestBody 接收的是請(qǐng)求體里面的數(shù)據(jù)；而RequestParam接收的是key-value里面的參數(shù)，所以它會(huì)被切面進(jìn)行處理從而可以用普通元素、數(shù)組、集合、對(duì)象等接收)。

即：如果參數(shù)是放在請(qǐng)求體中，傳入后臺(tái)的話，那么后臺(tái)要用@RequestBody才能接收到；如果不是放在請(qǐng)求體中的話，那么后臺(tái)接收前臺(tái)傳過(guò)來(lái)的參數(shù)時(shí)，要用@RequestParam來(lái)接收，或者形參前什么也不寫也能接收。

• 注：如果參數(shù)前寫了@RequestParam(xxx)，那么前端必須有對(duì)應(yīng)的xxx名字才行(不管其是否有值，當(dāng)然可以通過(guò)設(shè)置該注解的required屬性來(lái)調(diào)節(jié)是否必須傳)，如果沒(méi)有xxx名的話，那么請(qǐng)求會(huì)出錯(cuò)，報(bào)400。
• 注：如果參數(shù)前不寫@RequestParam(xxx)的話，那么就前端可以有可以沒(méi)有對(duì)應(yīng)的xxx名字才行，如果有xxx名的話，那么就會(huì)自動(dòng)匹配；沒(méi)有的話，請(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來(lái)匹配對(duì)應(yīng)實(shí)體類的屬性，如果匹配一致且json中的該key對(duì)應(yīng)的值符合(或可轉(zhuǎn)換為)，這一條我會(huì)在下面詳細(xì)分析，其他的都可簡(jiǎn)單略過(guò)，但是本文末的核心邏輯代碼以及幾個(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。

問(wèn)題描述

由于項(xiàng)目是前后端分離，因此后臺(tái)使用的是spring boot，做成微服務(wù)，只暴露接口。接口設(shè)計(jì)風(fēng)格為restful的風(fēng)格，在get請(qǐng)求下，后臺(tái)接收參數(shù)的注解為RequestBody時(shí)會(huì)報(bào)錯(cuò)；在post請(qǐng)求下，后臺(tái)接收參數(shù)的注解為RequestParam時(shí)也會(huì)報(bào)錯(cuò)。

問(wèn)題原因

由于spring的RequestParam注解接收的參數(shù)是來(lái)自于requestHeader中，即請(qǐng)求頭，也就是在url中，格式為xxx?username=123&password=456，而RequestBody注解接收的參數(shù)則是來(lái)自于requestBody中，即請(qǐng)求體中。

解決方法

因此綜上所述，如果為get請(qǐng)求時(shí)，后臺(tái)接收參數(shù)的注解應(yīng)該為RequestParam，如果為post請(qǐng)求時(shí)，則后臺(tái)接收參數(shù)的注解就是為RequestBody。附上兩個(gè)例子，截圖如下：

• get請(qǐng)求

• post請(qǐng)求

另外，還有一種應(yīng)用場(chǎng)景，接口規(guī)范為resultful風(fēng)格時(shí)，舉個(gè)例子：如果要獲取某個(gè)id下此條問(wèn)題答案的查詢次數(shù)的話，則后臺(tái)就需要?jiǎng)討B(tài)獲取參數(shù)，其注解為@PathVariable，并且requestMapping中的value應(yīng)為value="/{id}/queryNum"，截圖如下：

Post請(qǐng)求中@RequestParam和@RequestBody混合使用

如何在一個(gè)@RestController方法中混合使用@RequestParam和@RequestBody呢？就像這樣的代碼：

@PostMapping("/scanRecord")
public Response scanRecord(@RequestParam("t") int type, @RequestBody ScanRecord scanRecord) {
    System.out.println("type="+type);
    System.out.println(JSON.toJSONString(scanRecord));
    return Response.ok();
}

@RequestBody用來(lái)接收http post請(qǐng)求的body，前端傳入序列化好的json數(shù)據(jù)，后端可以解析為json對(duì)象（Content-Type需要指定為 application/json）。

@RequestParam用來(lái)接收請(qǐng)求url?后面的參數(shù)，或者Content-Type為multipart/form-data、application/x-www-form-urlencoded時(shí)的http body數(shù)據(jù)。

所以，如果想要在@RestController的一個(gè)方法中，同時(shí)接收@RequestParam和@RequestBody數(shù)據(jù)，前端應(yīng)該這樣用：

application/json的方式傳入@RequestBody接收的對(duì)象，并且在url?后帶上@RequestParam需要接收的參數(shù)。

前端js使用axios提交的話，是這樣的：

function post() {
    var data = {
        id: 1000,
        pn:'華為手機(jī)'
    };
    axios.post('http://localhost:8080/api/scanRecord?t=1', data).then(function (res) {
        
    }).catch(function (error) {

    });
}

最后，附上前端通過(guò)axios post提交multipart/form-data、application/x-www-form-urlencoded數(shù)據(jù)的示例代碼：

//form-data方式
function post() {
    var data = new FormData();
    data.append("id", 1000);
    data.append("pn", '華為手機(jī)');
    axios.post('http://localhost:8080/api/scanRecord?t=1', data).then(function (res) {
    }).catch(function (error) {
    });
}

//x-www-form-urlencoded方式
function encodeData(data) {
    var args = [];
    for(var attr in data) {
        args.push(attr+"=" + data[attr]);
    }
    return encodeURI(args.join("&"));
}
function post() {
    var data = {
        id: 1000,
        pn:'華為手機(jī)'
    };
    axios.post('http://localhost:8080/api/scanRecord?t=1', encodeData(data)).then(function (res) {

    }).catch(function (error) {

    });
}

總結(jié)

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論