@RequestParam,@RequestBody,@PathVariable注解還分不清嗎?


前言

在使用 SpringMVC 開發時,經常遇到前端傳遞的各種參數,比如 form 表單,JSON 數據,String[] 數組,再或者是最常見的 String 字符串等等,總之大部分場景都是在標題這三個注解來回切換,所以搞清楚這三個注解,日常開發就可以橫着走了。

正文

@RequestParam 和 @RequestBody 都是從 HttpServletRequest request 中取參的,而 @PathVariable 是映射 URI 請求參數中的占位符到目標方法的參數中的,接下來一一舉例說明。

希望大家能了解:前端在不明確指出 Content-Type 時,默認為 application/x-www-form-urlencoded 格式,@RequestParam 可以獲取 application/x-www-form-urlencoded 以及 application/json 這兩種類型的參數,但是 @RequestBody 是用來獲取非 application/x-www-form-urlencoded 類型的數據,比如 application/jsonapplication/xml 等。

1、@RequestParam

請求鏈接舉例(GET/POST):?param1=xxx&param2=yyy

http://javam4.com/m4detail?id=111&tag=java

后端接收舉例:

@RequestMapping(value = "/m4detail", method = {RequestMethod.GET,RequestMethod.POST})
public void m4detail(@RequestParam(value="id", required=true) String isId, @RequestParam String tag) {

    System.out.println("isId="+isId);
    System.out.println("tag="+tag);

}

首先這種方式無論是 GET 還是 POST 請求,都是可以獲取到參數的,舉例中特意使用了 @RequestParam 注解的一些參數,具體參數如下:

  • defaultValue 如果本次請求沒有攜帶這個參數,或者參數為空,那么就會啟用默認值
  • name 綁定本次參數的名稱,要跟URL上面的一樣
  • required 這個參數不是必須的,如果為 true,不傳參數會報錯
  • value 跟name一樣的作用,是name屬性的一個別名

2、@PathVariable

請求鏈接舉例(GET/POST):/{id}

http://javam4.com/m4detail/111?tag=java

后端接收舉例:

@RequestMapping(value = "/m4detail/{id}", method = {RequestMethod.GET,RequestMethod.POST})
public void m4detail(@PathVariable String id, @RequestParam String tag) {

    System.out.println("id="+id);
    System.out.println("tag="+tag);
}

然后有的小伙伴可能會問,你這就接收了一個 {id},那我能接受 2 個參數嗎?能。

一個 {xx} 就能對應一個參數,那你的請求鏈接假如是這樣:

http://javam4.com/m4detail/111/java

后端接收方式:

@RequestMapping(value = "/m4detail/{id}/{tag}", method = {RequestMethod.GET,RequestMethod.POST})
public void m4detail(@PathVariable String id, @PathVariable String tag) {

    System.out.println("id="+id);
    System.out.println("tag="+tag);
}

同樣 @PathVariable 也有相應的參數:

  • name 綁定參數的名稱,默認不傳遞時,綁定為同名的形參。 賦值但名稱不一致時則報錯
  • value 跟name一樣的作用,是name屬性的一個別名
  • required 這個參數不是必須的,如果為 true,不傳參數會報錯

總結,使用 @PathVariable 需要注意兩點:

  • 參數接收類型使用基本類型
  • 如果@PathVariable標明參數名稱,則參數名稱必須和URL中參數名稱一致

3、@ReuqestBody(不能用於GET請求)

通常后端與前端的交互大多情況下是 POST 請求,尤其是傳遞大量參數時,畢竟大量參數暴露在瀏覽的地址欄還是不怎么優雅的,而在 POST 請求中應用 JSON 串對於 Spring MVC 來說是比較友好的,后端使用 @RequestBody 注解就可以方便的實現 JSON 串到接收參數的數據映射。

說明一下 @RequestBody 為什么不能用用於 GET 請求,RequestBody 顧名思義,是將請求參數設置在請求 Body 中的,也就是請求體,而 GET 請求無請求體。

使用 @RequestBody 需要滿足如下條件:

  • Content-Type 為 application/json,確保傳遞是 JSON 數據;
  • 參數轉化的配置必須統一,否則無法接收數據,比如 json、request 混用等

傳遞參數舉例:(JSON數據)

{
  "aaa": {
    "id""759791ec-0175-ff808081",
    "title""我是標題",
    "content""我是內容"
  },
  "bbb": [
    "123456"
  ],
  "ccc"10
}

后端想要接收這個 JSON 數據有兩種方式選擇,一種是建立與 JSON 數據與之對應的實體,二是直接使用 Map<string,object> 對象接收。

因為 SpringMVC 會幫我們把符合要求的參數封裝進實體對象中,所以在參數比較多的情況下,直接使用對象方式會比較方便。

后端接收舉例:(實體舉例)

@PostMapping("/save")
public void save(@RequestBody QuestionVo vo) {
    System.out.println(vo.getAaa().getId());
}

QuestionVo.java 實體:

public class QuestionVo {

    private Question aaa;

    private List<String> bbb;

    private List<String> ccc;

    省略get\set方法...
}
public class Question {

    private String id;

    private String title;

    private String content;

    省略get\set方法...
}

在這給大家說一下 @RequestBody 在一個請求中只能用一次,如下是報錯的:

@PostMapping("/save")
public void save(@RequestBody QuestionVo vo, @RequestBody String niceyoo) {
    System.out.println(vo.getAaa().getId());
}

報錯信息:

I/O error while reading input message; nested exception is java.io.IOException: Stream closed

但是 @RequestParam 是支持多個使用的。

總結(一定要看)

1、在 GET 請求中可以使用 @RequestParam,不能使用 @RequestBody,@RequestBody 是用來獲取請求體中的參數,因為 GET 請求沒有請求體,所以不能使用。

2、在 POST 請求中,可以使用 @RequestBody 和 @RequestParam ,其中 @RequestParam 是用來獲取 application/x-www-form-urlencodedform-data 格式數據的,@RequestBody 用來獲取非 application/x-www-form-urlencoded 數據的,比如 application/jsonapplication/xml 等。

3、一個方法中,可以同時使用多個 @RequestParam ,但是只能使用一個 @RequestBody,否則會報錯。

4、@PathVariable 起到的作用就是 URI 請求參數中的占位符到目標方法參數的映射。

5、前端請求的 Content-Type ,默認值為 application/x-www-form-urlencoded,在這種格式下,后端直接使用 @RequestParam 就可以直接獲取指定的參數,但是一旦前端傳遞的是 JSON 數據,也就是 Content-Type 的值為 application/json,那么使用 @RequestParam 是取不到值的,不但取不到值還報錯。

JSON 數據如下:

{
    "name""哈哈哈哈"
}

后端接收錯誤演示:

@PostMapping("/save")
public void save(@RequestParam String name) {
    System.out.println(name);
}

報錯內容:

Required String parameter 'name' is not present

然后小伙伴就會問,那么使用 @RequestBody 可以直接映射 name 值 '哈哈哈哈' 嗎?

答案也是否定的,舉例如下:

@PostMapping("/save")
public void save(@RequestBody String name) {
    System.out.println(name);
}

打印內容如下:

{
    "name""哈哈哈哈"
}

這樣其實是將 String name 當做一個對象,Spirng MVC 直接將值映射到 name 上,所以拿到的值是整個 JSON 數據的全部,而創建實體或者是使用 Map 接收就不會出問題,但顯然就這 name 一個字段,創建一個實體對象實屬浪費,直接用 Map<string,object> / Map<string,string> 接收就可以了:

@PostMapping("/save")
public void save(@RequestBody Map<String,String> map) {
    System.out.println(map.get("name"));
}

希望這篇文章對你有所幫助。博客園持續更新,歡迎關注。

博客園:https://www.cnblogs.com/niceyoo


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM