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

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

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


@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;
    }



以上三种方式的调用结果都是成功的:


image.png


虽然说三种方式都是成功的,但是推荐使用第二种,也就是明确地指定对应参数对应名称。


第一种方式不注明参数名称的,仅仅在单个参的时候选择使用。


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


    @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):


image.png


@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;
    }


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


image.png



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


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


image.png


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


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


    @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):


image.png


上传文件


针对使用@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();
    }


image.png


@RequestBody


PS:对应RequestBody的使用,方式其实是比较多的,可以耐心看看,传参以json格式传递,接收方式较多(一定要记住Content-Type为application/json


通过实体类接参的方式:


User.java:

image.png

PS:Get 方式 和 Post方式 其实都是可以有requestBody的,只不过一般来说post用的较多(后面都用post方式举例)。


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


调用结果:

image.png


通过Map接参的方式:


单独获取参通过map的get方法根据key获取即可


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


调用结果:

image.png


通过JsonObject接参的方式:


这里用到了fastjson的依赖包:


        <!--添加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;
    }


调用结果:


image.png


通过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;
    }


调用结果:


image.png


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


举例使用User实体类,User.java:


image.png

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


调用方式(参数名需与实体类字段名报持一致):


全部参数都传,


image.png


只传部分参数,


image.png


@RequestHeader:



这是取出放在header里面的值,如:


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

image.png


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;
    }


以上两种方式调用结果:


image.png


通过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;
    }


调用结果:


image.png


OK,各种方式获取参数介绍就到此。


---------------------------------


对于评论中问到Get请求方式,RequestBody 能不能使用? 其实文中我有说到是可以的,只是不推荐

(其实跟的GET请求跟POST请求的所为的区别都是虚假,只能说是一种约束,规定。因为本身的HTTP协议上,人家可没说body只能Post请求使用;人家也没说GET和POST有长度限制,只不过是因为浏览器和服务器的种种原因生成了一些规定而已。这种东西就不展开了,了解知道就行。)。


示例:


image.pngimage.png


结果(能正常接收到):


image.png


调试接口的工具,可以参考这篇:


做一个合格的开发,从玩转Apipost开始_小目标青年的博客-CSDN博客_apipost压测

相关文章
|
3月前
|
Dubbo JavaScript Java
SpringBoot 调用外部接口的三种方式
SpringBoot不仅继承了Spring框架原有的特性,还简化了应用搭建与开发流程。在SpringBoot项目中,有时需要访问外部接口或URL。本文介绍三种不使用Dubbo的方式:一是利用原生`httpClient`发起请求;二是使用`RestTemplate`,支持GET和POST请求,包括`getForEntity`、`getForObject`及`postForEntity`等方法;三是采用`Feign`客户端简化HTTP请求,需引入相关依赖并在启动类上启用Feign客户端。这三种方式均能有效实现对外部服务的调用。
144 0
|
6天前
|
Java 开发者 Spring
精通SpringBoot:16个扩展接口精讲
【10月更文挑战第16天】 SpringBoot以其简化的配置和强大的扩展性,成为了Java开发者的首选框架之一。SpringBoot提供了一系列的扩展接口,使得开发者能够灵活地定制和扩展应用的行为。掌握这些扩展接口,能够帮助我们写出更加优雅和高效的代码。本文将详细介绍16个SpringBoot的扩展接口,并探讨它们在实际开发中的应用。
20 1
|
12天前
|
存储 安全 Java
|
12天前
|
存储 算法 安全
SpringBoot 接口加密解密实现
【10月更文挑战第18天】
|
10天前
|
监控 Java 开发者
掌握SpringBoot扩展接口:提升代码优雅度的16个技巧
【10月更文挑战第20天】 SpringBoot以其简化配置和快速开发而受到开发者的青睐。除了基本的CRUD操作外,SpringBoot还提供了丰富的扩展接口,让我们能够更灵活地定制和扩展应用。以下是16个常用的SpringBoot扩展接口,掌握它们将帮助你写出更加优雅的代码。
29 0
|
2月前
|
SQL JSON Java
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
本文为Spring Boot增删改查接口的小白入门教程,介绍了项目的构建、配置YML文件、代码编写(包括实体类、Mapper接口、Mapper.xml、Service和Controller)以及使用Postman进行接口测试的方法。同时提供了SQL代码和完整代码的下载链接。
springboot 如何编写增删改查后端接口,小白极速入门,附完整代码
|
2月前
|
存储 前端开发 Java
springboot文件上传和下载接口的简单思路
本文介绍了在Spring Boot中实现文件上传和下载接口的简单思路。文件上传通过`MultipartFile`对象获取前端传递的文件并存储,返回对外访问路径;文件下载通过文件的uuid名称读取文件,并通过流的方式输出,实现文件下载功能。
springboot文件上传和下载接口的简单思路
|
2月前
|
存储 数据采集 Java
Spring Boot 3 实现GZIP压缩优化:显著减少接口流量消耗!
在Web开发过程中,随着应用规模的扩大和用户量的增长,接口流量的消耗成为了一个不容忽视的问题。为了提升应用的性能和用户体验,减少带宽占用,数据压缩成为了一个重要的优化手段。在Spring Boot 3中,通过集成GZIP压缩技术,我们可以显著减少接口流量的消耗,从而优化应用的性能。本文将详细介绍如何在Spring Boot 3中实现GZIP压缩优化。
231 6
|
1月前
|
存储 NoSQL Java
Spring Boot项目中使用Redis实现接口幂等性的方案
通过上述方法,可以有效地在Spring Boot项目中利用Redis实现接口幂等性,既保证了接口操作的安全性,又提高了系统的可靠性。
32 0
|
2月前
|
Java 网络架构
springboot配合thymeleaf,调用接口不跳转页面只显示文本
springboot配合thymeleaf,调用接口不跳转页面只显示文本
108 0