Spring之RequestBody的使用姿勢小結

一灰灰發表於2018-07-30
Spring

logo

Spring之RequestBody的使用姿勢小結

SpringMVC中處理請求引數有好幾種不同的方式，如我們常見的下面幾種

  • 根據 HttpServletRequest 物件獲取
  • 根據 @PathVariable 註解獲取url引數
  • 根據 @RequestParam 註解獲取請求引數
  • 根據Bean的方式獲取請求引數
  • 根據 @ModelAttribute 註解獲取請求引數

對上面幾種方式有興趣的可以看一下這篇博文: SpringMVC之請求引數的獲取方式

除了上面的幾種方式之外，還有一種 @RequestBody 的使用方式，本文則主要介紹這種傳參的使用姿勢和相關注意事項

I. 使用姿勢

1. 服務介面

藉助Spring框架，使用@RequestBody並沒有什麼難度，很簡單的就可以寫一個使用case出來，如下

@Slf4j
@RestController
public class ReqBodyController {
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public static class Req {
        private String key;
        private Integer size;
    }

    @RequestMapping(value = "/body", method = {RequestMethod.POST, RequestMethod.GET, RequestMethod.OPTIONS})
    public BaseRsp body(@RequestBody Req req) {
        log.info("req: {}", req);
        return new BaseRsp<>(req);
    }
}
複製程式碼

看上面的實現，和我們通常的寫法並無差別，無非是將以前的 @RequsetParam 註解換成 @RequsetBody 註解，而且這個註解內部只有一個filed，比RequsetParam還少

@Target({ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RequestBody {
    // 預設引數必須存在，否則會拋一個異常
    boolean required() default true; 
}
複製程式碼

看到上面的實現，估計也可以猜出，這個註解對於後端而言，寫沒啥問題，關鍵是如何用（具體來講是如何給前端用）

2. 介面呼叫

上面寫完了，接下來的重點就是如何使用了，在使用之前，有必要了解下 RequestBody 這個註解出現的原有以及應用場景（換句話說它和RequestParam有什麼區別，為什麼要單獨的搞一個這個東西出來）

RequestBody

@requestBody註解常用來處理content-type不是預設的application/x-www-form-urlcoded編碼的內容，比如說：application/json或者是application/xml等。一般情況下來說常用其來處理application/json型別。

a. content-type定義

在進入下一步之前，有必要說一下Content-Type這個http請求頭的作用了，下面一段來自其他博文，原文連結見最後

MediaType，即是Internet Media Type，網際網路媒體型別；也叫做MIME型別，在Http協議訊息頭中，使用Content-Type來表示具體請求中的媒體型別資訊。

常見媒體格式如下:

  • text/html ： HTML格式
  • text/plain ：純文字格式
  • text/xml ： XML格式
  • image/gif ：gif圖片格式
  • image/jpeg ：jpg圖片格式
  • image/png：png圖片格式

以application開頭的媒體格式型別：

  • application/xhtml+xml ：XHTML格式
  • application/xml ： XML資料格式
  • application/atom+xml ：Atom XML聚合格式
  • application/json ： JSON資料格式
  • application/pdf ：pdf格式
  • application/msword ： Word文件格式
  • application/octet-stream ： 二進位制流資料（如常見的檔案下載）
  • application/x-www-form-urlencoded ：
    中預設的encType，form表單資料被編碼為key/value格式傳送到伺服器（表單預設的提交資料的格式）

b. content-type 例項說明

上面算是基本定義和取值，下面結合例項對典型的幾種方式進行說明

  • application/x-www-form-urlencoded：資料被編碼為名稱/值對。這是標準的編碼格式。
  • multipart/form-data： 資料被編碼為一條訊息，頁上的每個控制元件對應訊息中的一個部分。
  • text/plain： 資料以純文字形式(text/json/xml/html)進行編碼，其中不含任何控制元件或格式字元

對於前端使用而言，form表單的enctype屬性為編碼方式，常用有兩種：application/x-www-form-urlencoded和multipart/form-data，預設為application/x-www-form-urlencoded。

Get請求

發起Get請求時，瀏覽器用application/x-www-form-urlencoded方式，將表單資料轉換成一個字串(key1=value1&key2=value2...)拼接到url上，這就是我們常見的url帶請求引數的情況

Post表單

發起post請求時，如果沒有傳檔案，瀏覽器也是將form表單的資料封裝成k=v的結果丟到http body中，拿開源中國的部落格提交的表單為例，一個典型的post表單，上傳的資料拼裝在form data中，為kv結構

post

如果有傳檔案的場景，Content-Type型別會升級為multipart/form-data，這一塊不詳細展開，後面有機會再說

Post json串

post表單除了前面一種方式之外，還有一種也是我們常見的，就是講所有的表單資料放在一個大的json串中，然後丟給後端，這裡也有一個線上的例項，某電商平臺的商品發表，截圖如下

IMAGE

注意看上面的Request Payload，是一個大的json串，和前面差別明顯

c. RequestBody請求

根據RequestBody的定義，要想訪問前面定義的那個介面，使用傳統的表單傳遞方式是不行的，curl命令測試如下

curl -X POST -d 'key=haha&size=123' http://127.0.0.1:19533/body
複製程式碼

後端對應的輸出如下（拋了一個異常，表示@RequestBody註解修飾rest介面，不支援 Content type 'application/x-www-form-urlencoded;charset=UTF-8'

IMAGE

因此使用姿勢需要顯示新增請求頭，傳參也改變一下

curl -l -H "Content-type: application/json" -X GET -d '{"key": "!23", "size": 10}' http://127.0.0.1:19533/body
複製程式碼

返回結果如下

IMAGE

3. 注意事項

a. content-type顯示指定

根據前面的說明，可以知道 @RequestBody 這個註解的使用，使得REST介面接收的不再content-type為application/x-www-form-urlencoded的請求, 反而需要顯示指定為application/json

b. 請求方法

RequestBody支援GET方法麼？前面都是採用post提交引數，如果改成GET會怎樣？

curl測試方式

curl -l -H "Content-type: application/json" -X GET -d '{"key": "!23", "size": 10}' http://127.0.0.1:19533/body\?key\=app
複製程式碼

對應的後端debug截圖如下，發現使用GET方式，並沒有問題，依然可以獲取到引數

IMAGE

換成大名鼎鼎的POSTMAN來測試

使用post方法請求時，截圖如下，主要就是修改header的content-type，然後在body中新增json串格式的請求

IMAGE

然而改成get之後，body都直接灰掉了，也就是它不支援在get請求時，提交Body資料

IMAGE

url請求方式

接下來直接換成url的請求方式，看是否直接支援get請求

http://127.0.0.1:19533/body?{"key": "!23", "size": 10}
複製程式碼

瀏覽器中輸入時，伺服器400, 換成curl方式請求，拋的是缺少RequestBody的異常，也就是說，將json串拼接到url中貌似不行（也有可能是我的使用姿勢不對。。。）

小結

  • 到這裡小結一下，使用RequestBody獲取引數時，還是老老實實的選擇POST方法比較合適，至於原因，跟大眾，隨主流，跟著大家的習慣走比較好

c. 引數獲取

這個主要就是後端編寫介面時，獲取RequestBody引數的問題了，通過測試，發現在HttpServletRequest引數中，居然拿不到提交的RequestBody引數，演示如下

請求url為

curl -l -H "Content-type: application/json" -X POST -d '{"key": "!23", "size": 10}' http://127.0.0.1:19533/body\?url\=ddd
複製程式碼

對應的debug截圖如下，url引數可以拿到，RequestBody引數沒有

IMAGE

首先宣告，下面的這段分析，沒有看原始碼，純屬於個人推斷，如有問題，對被誤導的朋友表示歉意，也希望對此有了解的朋友，多多批評指正

從傳檔案的思路出發，前端傳檔案給後端時，後端是基於流的方式，將上傳的二進位制流，寫入到`MultipartFile`；而二進位制流讀完之後，沒法再重複的讀
RequestBody可能也是這麼個邏輯，首先是從HttpServletRequest的Reader流中讀取body引數並封裝到上面的req物件，而不會像url引數一樣，寫回到`javax.servlet.ServletRequest#getParameterMap`
複製程式碼

對上面的猜測做一個小小的驗證，改成直接從HttpServletRequest的Reader流中獲取請求body引數

@RequestMapping(value = "/body", method = {RequestMethod.POST, RequestMethod.GET, RequestMethod.OPTIONS})
public BaseRsp body(HttpServletRequest request) throws IOException {
    BufferedReader reader = request.getReader();
    StringBuilder builder = new StringBuilder();
    String line = reader.readLine();
    while (line != null) {
        builder.append(line);
        line = reader.readLine();
    }
    reader.close();

    String reqBody = builder.toString();
    Req req = JSON.parseObject(reqBody, Req.class);
    log.info("req: {}, request: {}", req, request.getParameterMap());
    return new BaseRsp<>(req);
}
複製程式碼

驗證如下

image

其實到這裡，有個有意思的地方已經引起了我的好奇，那就是在Spring容器中HttpServletRequest這個東西，是怎麼運轉的，後面有機會再聊，此處不展開...

4. 小結

  • ReuqestBody 主要是處理json串格式的請求引數，要求使用方指定header content-type:application/json
  • RequestBody 通常要求呼叫方使用post請求
  • RequsetBody引數，不會放在HttpServletRequest的Map中，因此沒法通過javax.servlet.ServletRequest#getParameter獲取

II. 其他

0. 參考

1. 一灰灰Blog： https://liuyueyi.github.io/hexblog

一灰灰的個人部落格，記錄所有學習和工作中的博文，歡迎大家前去逛逛

2. 宣告

盡信書則不如，已上內容，純屬一家之言，因個人能力有限，難免有疏漏和錯誤之處，如發現bug或者有更好的建議，歡迎批評指正，不吝感激

3. 掃描關注

小灰灰Blog&公眾號

QrCode

知識星球

zhishi

相關文章