Springboot 最细节全面的接口传参接参介绍，总有你喜欢的一种方式

青旅半醒 2024-04-17 18:52 12阅读 0赞

这篇里面对每种传参接参方式都会举出较多的例子，不多说，入正题：

## **@PathVariable**      一 ##

@GetMapping("/getId/{id}")
        public String pathVariableTest(@PathVariable Integer id) {
            return  "id:   "+id;
        }

二

@GetMapping("/getId/{id}")
        public String pathVariableTest(@PathVariable("id") Integer id) {
    
            return  "id:   "+id;
        }

三

@GetMapping("/getId/{idValue}")
        public String pathVariableTest(@PathVariable("idValue") Integer id) {
    
            return  "id:   "+id;
        }

以上三种方式的调用结果都是成功的：  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70][]  
*虽然说三种方式都是成功的，但是推荐使用第二种，也就是明确地指定对应参数对应名称。  
第一种方式不注明参数名称的，仅仅在单个参的时候选择使用。*  
最后给出推荐使用的第二种方式的传接多参例子：

@GetMapping("/getIdAny/{id}/{name}")
        public String pathVariableTestAny(@PathVariable("id") Integer id,@PathVariable("name") String name) {
    
            return  "**id:   "+id+"  **name:        "+name;
        }

调用结果（[http://localhost:8023/getId/1001/JCccc][http_localhost_8023_getId_1001_JCccc]）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 1][]

## **@RequestParam** ##

一

@GetMapping("/getId")
        public String requestParamTest( Integer id) {
            return  "id:   "+id;
        }

二

@GetMapping("/getId")
        public String requestParamTest( @RequestParam Integer id) {
            return  "id:   "+id;
        }

三

@GetMapping("/getId")
        public String requestParamTest( @RequestParam("id") Integer id) {
            return  "id:   "+id;
        }

以上三种方式都是可以正常调用的：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 2][]

四

@GetMapping("/getId")
        public String requestParamTest( @RequestParam("idValue") Integer id) {
            return  "id:   "+id;
        }

第四种，可以看到在@RequestParam里面给参数id取名为： idValue，这时候传参时参数名称也需要写成idValue即可。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 3][]

那么以上四种方式，我推荐第三种，也就是规范地注解命名对应参数名称。

最后给出推荐使用的第三种方式的传接多参例子：

@GetMapping("/getIdAny")
        public String requestParamTestAny( @RequestParam("id") Integer id,@RequestParam("name") String name,@RequestParam Integer age) {
            return  "**id:   "+id+"    **name:   "+name+"    **age:   "+age;
        }

调用结果（[http://localhost:8023/getIdAny?id=1002&name=JCccc&age=10][http_localhost_8023_getIdAny_id_1002_name_JCccc_age_10]）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 4][]

**针对使用@RequestParam，补充一下上传文件的是需要注意的以及方式：**

简单示例一下怎么接收以及传递文件（使用MultipartFile接收）：

@ResponseBody
        @PostMapping("upload")
        public String upload(@RequestParam("myFile") MultipartFile file)  {
    
            return "---file name:" + file.getOriginalFilename()+
                    "---file type:" + file.getContentType()+
                    "---file size:" + file.getSize();
        }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 5][]

## **@RequestBody**      ***PS：对应RequestBody的使用，方式其实是比较多的，可以耐心看看，传参以json格式传递，接收方式较多（***一定要记住Content-Type为application/json***）*** ##

### **通过实体类接参的方式：**   **User.java：** ###

![20190830110000114.png][]

*PS：Get 方式 和 Post方式 其实都是可以有requestBody的，只不过一般来说post用的较多（后面都用post方式举例）。*

@GetMapping("/getRequestBodyValue")
        public String RequestBodyTest(@RequestBody User user) {
    
            return  user.toString();
        }

调用结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 6][]

### **通过Map接参的方式：**      *单独获取参通过map的get方法根据key获取即可* ###

@PostMapping("/getRequestBodyValue")
        public String RequestBodyTest(@RequestBody Map userMap) {
    
            return  userMap.toString();
        }

调用结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 7][]

### **通过JsonObject接参的方式：** ###

这里用到了fastjson的依赖包：

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>fastjson</artifactId>
                <version>1.2.7</version>
            </dependency>

@PostMapping("/getRequestBodyValue")
        public String RequestBodyTest(@RequestBody JSONObject jsonObject) {
    
            Integer id = jsonObject.getInteger("id");
            String name = jsonObject.getString("name");
            Integer age = jsonObject.getInteger("age");
    
            return  "---id:"+id+"  ---name:"+name+"  ---age:"+age;
        }

调用结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 8][]

### **通过String接参数的方式：**      *这种情况是先使用String把body里面的数据获取出来，再转换成jsonobject再进行参数解析* ###

@PostMapping("/getRequestBodyValue")
        public String RequestBodyTest(@RequestBody String jsonStr) {
            JSONObject jsonObject= JSON.parseObject(jsonStr); //将jsonStr转化为JSONObject,再进行取值
            Integer id = jsonObject.getInteger("id");
            String name = jsonObject.getString("name");
            Integer age = jsonObject.getInteger("age");
            return  "---id:"+id+"  ---name:"+name+"  ---age:"+age;
        }

调用结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 9][]

另外补充这种没有通过json格式传参的，以实体类传参接参方式：

**举例使用User实体类，User.java：**  
![20190830110000114.png][]

@GetMapping("/getValue")
        public String entityValueTest( User user) {
    
            return  user.toString();
        }

调用方式（参数名需与实体类字段名报持一致）：

全部参数都传，  
![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 10][]

只传部分参数，

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 11][]

## ** @RequestHeader：** ##

这是取出放在header里面的值，如：

@ResponseBody
        @RequestMapping("/getMyHeaderParam")
        public String getOrderList(@RequestHeader String token,@RequestHeader String uuid) {
    
            return "----token:"+token+"--- uuid:"+uuid;
        }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 12][]

## **HttpServletRequest** ： ##

@GetMapping("/getHttpServletRequest")
        public String httpServletRequestValueTest(HttpServletRequest request) {
            String id = request.getParameter("id");
            String name = request.getParameter("name");
            String age = request.getParameter("age");
            return  "---id:"+id+"  ---name:"+name+"  ---age:"+age;
        }

@GetMapping("/getHttpServletRequest")
        public String httpServletRequestValueTest(HttpServletRequest request) {
    
            Map<String, String[]> parameterMap = request.getParameterMap();
            String[] ids = parameterMap.get("id");
            String[] names = parameterMap.get("name");
            String[] ages = parameterMap.get("age");
            String id = ids[0];
            String name =names[0];
            String age =ages[0];
    
            return  "---id:"+id+"  ---name:"+name+"  ---age:"+age;
        }

以上两种方式调用结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 13][]

通过**HttpServletRequest** 获取body里面的json数据：  
（其实这种方式是较为麻烦的，不太推荐，还不如使用上面提到的@RequestBody好了）

@PostMapping("/getHttpServletRequest")
        public String get(HttpServletRequest request) throws IOException {
            BufferedReader reader = new BufferedReader(new InputStreamReader(request.getInputStream()));
            String str = "";
            String wholeStr = "";
            //一行一行的读取body体里面的内容
            while((str = reader.readLine()) != null){
                wholeStr += str;
            }
            //转化成JSONObject
            JSONObject jsonObject=JSONObject.parseObject(wholeStr);
            Integer id =  jsonObject.getInteger("id");
            String name = jsonObject.getString("name");
            Integer age = jsonObject.getInteger("age");
            return  "---id:"+id+"  ---name:"+name+"  ---age:"+age;
        }

调用结果：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 14][]  
  
  
OK，各种方式获取参数介绍就到此。

\---------------------------------

对于评论中问到Get请求方式，RequestBody 能不能使用？ 其实文中我有说到是可以的，只是不推荐  
（其实跟的GET请求跟POST请求的所为的区别都是虚假，只能说是一种约束，规定。因为本身的HTTP协议上，人家可没说body只能Post请求使用；人家也没说GET和POST有长度限制，只不过是因为浏览器和服务器的种种原因生成了一些规定而已。这种东西就不展开了，了解知道就行。）。

示例：

![20200402091601914.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 15][]

结果（能正常接收到）：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 16][]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/07eece2557134168b9fad40814ec25f7.png
[http_localhost_8023_getId_1001_JCccc]: http://localhost:8023/getId/1001/JCccc
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/e162443ce01c42f4bd46dc8516bf4070.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/b66a4296b43544fd9d3229debda507e5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/644a8f492a4942e79e621ee0c6812a2f.png
[http_localhost_8023_getIdAny_id_1002_name_JCccc_age_10]: http://localhost:8023/getIdAny?id=1002&name=JCccc&age=10
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/e6318b7bfeed4551bd2dcdd3bee73ba5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/e28d2b4b116a4e2b840e940f791c9383.png
[20190830110000114.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/56ccac88b92142dba80da8ff20d3477a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/a24f5c1c19ba45cdb18b774e942c38fe.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/36d7bc25bf7149cf80322759a50699b1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/e4bd53a034e54c9ba5f75fccdc9caee6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/750feb068fa74834ba4142040a832005.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/b031e97c1dfc4df083b5dbbbb990ad00.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/d18f6f3039394510991e16dc431efa23.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/0b583630b0ac4cc68ed7fbe556798594.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/9e5dae6b190c41b69ff580d20fa9f42e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 14]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/ea864f0025bc4fddb9be4bb9eaab0715.png
[20200402091601914.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/2b4cab1cfc7041e68ecf62453e58b3eb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 15]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/a49f6bbd301a4f75bd3215c1fef99d87.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM1Mzg3OTQw_size_16_color_FFFFFF_t_70 16]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/b81b9418b03a497fbe5edf9c29ad14a7.png