跨境派

跨境派

跨境派,专注跨境行业新闻资讯、跨境电商知识分享!

当前位置:首页 > 卖家故事 > SpringBootWeb请求

SpringBootWeb请求

时间:2024-04-29 10:50:17 来源:网络cs 作者:利杜鹃 栏目:卖家故事 阅读:

标签: 请求 
阅读本书更多章节>>>>

文章目录

前言一、Postman介绍 二、简单参数三、实体参数四、数组集合参数五、日期参数六、JSON参数七、路径参数


前言

在上一篇文章中,已经基于SpringBoot的方式开发一个web应用,浏览器发起请求 /hello 后 ,给浏览器返回字符串 “Hello World ~”。
在这里插入图片描述

其实呢,是我们在浏览器发起请求,请求了我们的后端web服务器(也就是内置的Tomcat)。而我们在开发web程序时呢,定义了一个控制器类Controller,请求会被部署在Tomcat中的Controller接收,然后Controller再给浏览器一个响应,响应一个字符串 “Hello World”。 而在请求响应的过程中是遵循HTTP协议的。
但是呢,在Tomcat这类Web服务器中,是不识别我们自己定义的Controller的。但是Tomcat是一个Servlet容器,是支持Serlvet规范的,所以呢,在tomcat中是可以识别 Servlet程序的。 那我们所编写的XxxController 是如何处理请求的,又与Servlet之间有什么联系呢?
其实呢,在SpringBoot进行web程序开发时,它内置了一个核心的Servlet程序 DispatcherServlet,称之为 核心控制器。 DispatcherServlet 负责接收页面发送的请求,然后根据执行的规则,将请求再转发给后面的请求处理器Controller,请求处理器处理完请求之后,最终再由DispatcherServlet给浏览器响应数据。

在这里插入图片描述

那将来浏览器发送请求,会携带请求数据,包括:请求行、请求头;请求到达tomcat之后,tomcat会负责解析这些请求数据,然后呢将解析后的请求数据会传递给Servlet程序的HttpServletRequest对象,那也就意味着 HttpServletRequest 对象就可以获取到请求数据。 而Tomcat,还给Servlet程序传递了一个参数 HttpServletResponse,通过这个对象,我们就可以给浏览器设置响应数据 。

在这里插入图片描述

那上述所描述的这种浏览器/服务器的架构模式呢,我们称之为:BS架构。
在这里插入图片描述
• BS架构:Browser/Server,浏览器/服务器架构模式。客户端只需要浏览器,应用程序的逻辑和数据都存储在服务端。

接下来,主要讲解一下如何接收页面传递过来的请求数据。


一、Postman

当前最为主流的开发模式:前后端分离
在这里插入图片描述
在这种模式下,前端技术人员基于"接口文档",开发前端程序;后端技术人员也基于"接口文档",开发后端程序。

由于前后端分离,对我们后端技术人员来讲,在开发过程中,是没有前端页面的,那我们怎么测试自己所开发的程序呢?

方式1:像之前SpringBoot入门案例中一样,直接使用浏览器。在浏览器中输入地址,测试后端程序。

弊端:在浏览器地址栏中输入地址这种方式都是GET请求,如何我们要用到POST请求怎么办呢? 要解决POST请求,需要程序员自己编写前端代码(比较麻烦)

方式2:使用专业的接口测试工具(Postman工具)

介绍

Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。

Postman原是Chrome浏览器的插件,可以模拟浏览器向后端服务器发起任何形式(如:get、post)的HTTP请求

使用Postman还可以在发起请求时,携带一些请求参数、请求头等信息

作用:常用于进行接口测试

特征

简单实用美观大方

二、简单参数

简单参数:在向服务器发起请求时,向服务器传递的是一些普通的请求数据。
在这里插入图片描述
那么在后端程序中,如何接收传递过来的普通参数数据呢?

我们在这里讲解两种方式:

原始方式 (了解即可)

在原始的Web程序当中,需要通过Servlet中提供的API:HttpServletRequest(请求对象),获取请求的相关信息。比如获取请求参数:

Tomcat接收到http请求时:把请求的相关信息封装到HttpServletRequest对象中

在Controller中,我们要想获取Request对象,可以直接在方法的形参中声明 HttpServletRequest 对象。然后就可以通过该对象来获取请求信息:

//根据指定的参数名获取请求参数的数据值String  request.getParameter("参数名")
@RestControllerpublic class RequestController {    //原始方式    @RequestMapping("/simpleParam")    public String simpleParam(HttpServletRequest request){        // http://localhost:8080/simpleParam?name=Tom&age=10        // 请求参数: name=Tom&age=10   (有2个请求参数)        // 第1个请求参数: name=Tom   参数名:name,参数值:Tom        // 第2个请求参数: age=10     参数名:age , 参数值:10        String name = request.getParameter("name");//name就是请求参数名        String ageStr = request.getParameter("age");//age就是请求参数名        int age = Integer.parseInt(ageStr);//需要手动进行类型转换        System.out.println(name+"  :  "+age);        return "OK";    }}

以上这种方式,仅做了解。(在以后的开发中不会使用到)

SpringBoot方式

在Springboot的环境中,对原始的API进行了封装,接收参数的形式更加简单。 如果是简单参数,参数名与形参变量名相同,定义同名的形参即可接收参数。

@RestControllerpublic class RequestController {    // http://localhost:8080/simpleParam?name=Tom&age=10    // 第1个请求参数: name=Tom   参数名:name,参数值:Tom    // 第2个请求参数: age=10     参数名:age , 参数值:10        //springboot方式    @RequestMapping("/simpleParam")    public String simpleParam(String name , Integer age ){//形参名和请求参数名保持一致        System.out.println(name+"  :  "+age);        return "OK";    }}

postman测试( GET 请求):

在这里插入图片描述
postman测试( POST请求 ):

在这里插入图片描述
结论:不论是GET请求还是POST请求,对于简单参数来讲,只要保证请求参数名和Controller方法中的形参名保持一致,就可以获取到请求参数中的数据值。

参数名不一致
如果方法形参名称与请求参数名称不一致,controller方法中的形参还能接收到请求参数值吗?
@RestControllerpublic class RequestController {    // http://localhost:8080/simpleParam?name=Tom&age=20    // 请求参数名:name    //springboot方式    @RequestMapping("/simpleParam")    public String simpleParam(String username , Integer age ){//请求参数名和形参名不相同        System.out.println(username+"  :  "+age);        return "OK";    }}

答案:运行没有报错。 controller方法中的username值为:null,age值为20

结论:对于简单参数来讲,请求参数名和controller方法中的形参名不一致时,无法接收到请求数据

那么如果我们开发中,遇到了这种请求参数名和controller方法中的形参名不相同,怎么办?

解决方案:可以使用Spring提供的@RequestParam注解完成映射

在方法形参前面加上 @RequestParam 然后通过value属性执行请求参数名,从而完成映射。代码如下:

@RestControllerpublic class RequestController {    // http://localhost:8080/simpleParam?name=Tom&age=20    // 请求参数名:name    //springboot方式    @RequestMapping("/simpleParam")    public String simpleParam(@RequestParam("name") String username , Integer age ){        System.out.println(username+"  :  "+age);        return "OK";    }}

注意事项:

@RequestParam中的required属性默认为true(默认值也是true),代表该请求参数必须传递,如果不传递将报错

在这里插入图片描述
在这里插入图片描述如果该参数是可选的,可以将required属性设置为false

@RequestMapping("/simpleParam")public String simpleParam(@RequestParam(name = "name", required = false) String username, Integer age){System.out.println(username+ ":" + age);return "OK";}

三、实体参数

在使用简单参数做为数据传递方式时,前端传递了多少个请求参数,后端controller方法中的形参就要书写多少个。如果请求参数比较多,通过上述的方式一个参数一个参数的接收,会比较繁琐。

此时,我们可以考虑将请求参数封装到一个实体类对象中。 要想完成数据封装,需要遵守如下规则:请求参数名与实体类的属性名相同

在这里插入图片描述

简单实体对象
定义POJO实体类:
public class User {    private String name;    private Integer age;    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public Integer getAge() {        return age;    }    public void setAge(Integer age) {        this.age = age;    }    @Override    public String toString() {        return "User{" +                "name='" + name + '\'' +                ", age=" + age +                '}';    }}

Controller方法:

@RestControllerpublic class RequestController {    //实体参数:简单实体对象    @RequestMapping("/simplePojo")    public String simplePojo(User user){        System.out.println(user);        return "OK";    }}

Postman测试:

参数名和实体类属性名一致时

在这里插入图片描述

参数名和实体类属性名不一致时
在这里插入图片描述 复杂实体对象

上面是简单的实体对象,下面在来学习下复杂的实体对象。

复杂实体对象指的是,在实体类中有一个或多个属性,也是实体对象类型的。如下:

User类中有一个Address类型的属性(Address是一个实体类)

在这里插入图片描述
复杂实体对象的封装,需要遵守如下规则:

请求参数名与形参对象属性名相同,按照对象层次结构关系即可接收嵌套实体类属性参数。

定义POJO实体类:

Address实体类
public class Address {    private String province;    private String city;    public String getProvince() {        return province;    }    public void setProvince(String province) {        this.province = province;    }    public String getCity() {        return city;    }    public void setCity(String city) {        this.city = city;    }    @Override    public String toString() {        return "Address{" +                "province='" + province + '\'' +                ", city='" + city + '\'' +                '}';    }}
User实体类
public class User {    private String name;    private Integer age;    private Address address; //地址对象    public String getName() {        return name;    }    public void setName(String name) {        this.name = name;    }    public Integer getAge() {        return age;    }    public void setAge(Integer age) {        this.age = age;    }    public Address getAddress() {        return address;    }    public void setAddress(Address address) {        this.address = address;    }    @Override    public String toString() {        return "User{" +                "name='" + name + '\'' +                ", age=" + age +                ", address=" + address +                '}';    }}

Controller方法:

@RestControllerpublic class RequestController {    //实体参数:复杂实体对象    @RequestMapping("/complexPojo")    public String complexPojo(User user){        System.out.println(user);        return "OK";    }}

Postman测试:
在这里插入图片描述

四、数组集合参数

数组集合参数的使用场景:在HTML的表单中,有一个表单项是支持多选的(复选框),可以提交选择的多个值。

在这里插入图片描述

多个值是怎么提交的呢?其实多个值也是一个一个的提交。

在这里插入图片描述
后端程序接收上述多个值的方式有两种:

数组

数组参数:请求参数名与形参数组名称相同且请求参数为多个,定义数组类型形参即可接收参数
在这里插入图片描述
Controller方法:

@RestControllerpublic class RequestController {    //数组集合参数    @RequestMapping("/arrayParam")    public String arrayParam(String[] hobby){        System.out.println(Arrays.toString(hobby));        return "OK";    }}

Postman测试:

在前端请求时,有两种传递形式:

方式一: xxxxxxxxxx?hobby=game&hobby=java

在这里插入图片描述

方式二:xxxxxxxxxxxxx?hobby=game,java

在这里插入图片描述

集合

集合参数:请求参数名与形参集合对象名相同且请求参数为多个,@RequestParam 绑定参数关系

默认情况下,请求中参数名相同的多个值,是封装到数组。如果要封装到集合,要使用@RequestParam绑定参数关系

在这里插入图片描述
Controller方法:

@RestControllerpublic class RequestController {    //数组集合参数    @RequestMapping("/listParam")    public String listParam(@RequestParam List<String> hobby){        System.out.println(hobby);        return "OK";    }}

Postman测试:

方式一: xxxxxxxxxx?hobby=game&hobby=java

在这里插入图片描述
方式二:xxxxxxxxxxxxx?hobby=game,java

在这里插入图片描述

五、日期参数

上述演示的都是一些普通的参数,在一些特殊的需求中,可能会涉及到日期类型数据的封装。比如,如下需求:

在这里插入图片描述
因为日期的格式多种多样(如:2022-12-12 10:05:45 、2022/12/12 10:05:45),那么对于日期类型的参数在进行封装的时候,需要通过@DateTimeFormat注解,以及其pattern属性来设置日期的格式。

在这里插入图片描述

@DateTimeFormat注解的pattern属性中指定了哪种日期格式,前端的日期参数就必须按照指定的格式传递。后端controller方法中,需要使用Date类型或LocalDateTime类型,来封装传递的参数。

Controller方法:

@RestControllerpublic class RequestController {    //日期时间参数   @RequestMapping("/dateParam")    public String dateParam(@DateTimeFormat(pattern = "yyyy-MM-dd HH:mm:ss") LocalDateTime updateTime){        System.out.println(updateTime);        return "OK";    }}

Postman测试:
在这里插入图片描述

六、JSON参数

学习JSON格式参数,主要从以下两个方面着手:

Postman在发送请求时,如何传递json格式的请求参数在服务端的controller方法中,如何接收json格式的请求参数

Postman发送JSON格式数据:

在这里插入图片描述
服务端Controller方法接收JSON格式数据:

传递json格式的参数,在Controller中会使用实体类进行封装。封装规则:JSON数据键名与形参对象属性名相同,定义POJO类型形参即可接收参数。需要使用 @RequestBody标识。

在这里插入图片描述

@RequestBody注解:将JSON数据映射到形参的实体类对象中(JSON中的key和实体类中的属性名保持一致)

实体类:Address

public class Address {    private String province;    private String city;    //省略GET , SET 方法}

实体类:User

public class User {    private String name;    private Integer age;    private Address address;        //省略GET , SET 方法}    

Controller方法:

@RestControllerpublic class RequestController {    //JSON参数    @RequestMapping("/jsonParam")    public String jsonParam(@RequestBody User user){        System.out.println(user);        return "OK";    }}

Postman测试:
在这里插入图片描述

七、路径参数

传统的开发中请求参数是放在请求体(POST请求)传递或跟在URL后面通过?key=value的形式传递(GET请求)。

在这里插入图片描述

在现在的开发中,经常还会直接在请求的URL中传递参数。例如:

http://localhost:8080/user/1http://localhost:880/user/1/0

上述的这种传递请求参数的形式呢,我们称之为:路径参数。

学习路径参数呢,主要掌握在后端的controller方法中,如何接收路径参数。

路径参数:

前端:通过请求URL直接传递参数后端:使用{…}来标识该路径参数,需要使用@PathVariable获取路径参数

在这里插入图片描述

Controller方法:

@RestControllerpublic class RequestController {    //路径参数    @RequestMapping("/path/{id}")    public String pathParam(@PathVariable Integer id){        System.out.println(id);        return "OK";    }}

Postman测试:
在这里插入图片描述
传递多个路径参数:

Postman:

在这里插入图片描述
Controller方法:

@RestControllerpublic class RequestController {    //路径参数    @RequestMapping("/path/{id}/{name}")    public String pathParam2(@PathVariable Integer id, @PathVariable String name){        System.out.println(id+ " : " +name);        return "OK";    }}
阅读本书更多章节>>>>

本文链接:https://www.kjpai.cn/gushi/2024-04-29/163422.html,文章来源:网络cs,作者:利杜鹃,版权归作者所有,如需转载请注明来源和作者,否则将追究法律责任!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容,一经查实,本站将立刻删除。

文章评论