深入解析SpringBoot的请求响应机制

SpringBootWeb请求响应

前言

在我们基于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，浏览器/服务器架构模式。客户端只需要浏览器，应用程序的逻辑和数据都存储在服务端。

1. 请求

1.1 Postman

当前最为主流的开发模式：前后端分离

在这种模式下，前端技术人员基于"接口文档"，开发前端程序；后端技术人员也基于"接口文档"，开发后端程序。

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

方式1：直接使用浏览器。在浏览器中输入地址，测试后端程序。

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

方式2：使用专业的接口测试工具

介绍

• Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。> Postman原是Chrome浏览器的插件，可以模拟浏览器向后端服务器发起任何形式(如:get、post)的HTTP请求> > 使用Postman还可以在发起请求时，携带一些请求参数、请求头等信息
• 作用：常用于进行接口测试
• 特征- 简单- 实用- 美观- 大方

界面介绍:

如果我们需要将测试的请求信息保存下来，就需要创建一个postman的账号，然后登录之后才可以。

1.2 简单参数

简单参数：在向服务器发起请求时，向服务器传递的是一些普通的请求数据。

那么在后端程序中，如何接收传递过来的普通参数数据呢？

1. 原始方式
2. SpringBoot方式

1.2.1 原始方式

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

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

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

//根据指定的参数名获取请求参数的数据值
String  request.getParameter("参数名")

@RestControllerpublicclassRequestController{//原始方式@RequestMapping("/simpleParam")publicStringsimpleParam(HttpServletRequest request){// http://localhost:8080/simpleParam?name=Tom&age=10// 请求参数： name=Tom&age=10   （有2个请求参数）// 第1个请求参数： name=Tom   参数名:name，参数值:Tom// 第2个请求参数： age=10     参数名:age , 参数值:10String name = request.getParameter("name");//name就是请求参数名String ageStr = request.getParameter("age");//age就是请求参数名int age =Integer.parseInt(ageStr);//需要手动进行类型转换System.out.println(name+"  :  "+age);return"OK";}}

以上这种方式，我们仅做了解。（在以后的开发中不会使用到）

1.2.2 SpringBoot方式

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

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

postman测试( GET 请求)：

postman测试( POST请求 )：

结论：不论是GET请求还是POST请求，对于简单参数来讲，只要保证请求参数名和Controller方法中的形参名保持一致，就可以获取到请求参数中的数据值。

1.2.3 参数名不一致

如果方法形参名称与请求参数名称不一致，controller方法中的形参还能接收到请求参数值吗？

@RestControllerpublicclassRequestController{// http://localhost:8080/simpleParam?name=Tom&age=20// 请求参数名：name//springboot方式@RequestMapping("/simpleParam")publicStringsimpleParam(String username ,Integer age ){//请求参数名和形参名不相同System.out.println(username+"  :  "+age);return"OK";}}

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

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

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

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

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

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

注意事项：

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

如果该参数是可选的，可以将required属性设置为false

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

1.3 实体参数

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

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

1.3.1 简单实体对象

定义POJO实体类：

@DatapublicclassUser{privateString name;privateInteger age;}

Controller方法：

@RestControllerpublicclassRequestController{//实体参数：简单实体对象@RequestMapping("/simplePojo")publicStringsimplePojo(User user){System.out.println(user);return"OK";}}

Postman测试：

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

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

1.3.2 复杂实体对象

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

• User类中有一个Address类型的属性（Address是一个实体类）

复杂实体对象的封装，需要遵守如下规则：

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

定义POJO实体类：

• Address实体类

publicclassAddress{privateString province;privateString city;//get,set方法@OverridepublicStringtoString(){return"Address{"+"province='"+ province +'\''+", city='"+ city +'\''+'}';}}

• User实体类

publicclassUser{privateString name;privateInteger age;privateAddress address;//地址对象//get,set方法@OverridepublicStringtoString(){return"User{"+"name='"+ name +'\''+", age="+ age +", address="+ address +'}';}}

Controller方法：

@RestControllerpublicclassRequestController{//实体参数：复杂实体对象@RequestMapping("/complexPojo")publicStringcomplexPojo(User user){System.out.println(user);return"OK";}}

Postman测试：

1.4 数组集合参数

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

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

后端程序接收上述多个值的方式有两种：

1. 数组
2. 集合

1.4.1 数组

数组参数：请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接收参数

Controller方法：

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

Postman测试：

在前端请求时，有两种传递形式：

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

方式二：xxxxxxxxxxxxx?hobby=game,java

1.4.2 集合

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

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

Controller方法：

@RestControllerpublicclassRequestController{//数组集合参数@RequestMapping("/listParam")publicStringlistParam(@RequestParamList<String> hobby){System.out.println(hobby);return"OK";}}

Postman测试：

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

方式二：xxxxxxxxxxxxx?hobby=game,java

1.5 日期参数

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

因为日期的格式多种多样（如：2022-12-12 10:05:45 、2022/12/12 10:05:45），那么对于日期类型的参数在进行封装的时候，需要通过@DateTimeFormat注解，以及其pattern属性来设置日期的格式。

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

Controller方法：

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

Postman测试：

1.6 JSON参数

在前后端进行交互时，如果是比较复杂的参数，前后端通过会使用JSON格式的数据进行传输。 （JSON是开发中最常用的前后端数据交互方式）

我们学习JSON格式参数，主要从以下两个方面着手：

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

Postman发送JSON格式数据：

服务端Controller方法接收JSON格式数据：

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

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

实体类：Address

publicclassAddress{privateString province;privateString city;//省略GET , SET 方法}

实体类：User

publicclassUser{privateString name;privateInteger age;privateAddress address;//省略GET , SET 方法}

Controller方法：

@RestControllerpublicclassRequestController{//JSON参数@RequestMapping("/jsonParam")publicStringjsonParam(@RequestBodyUser user){System.out.println(user);return"OK";}}

Postman测试：

1.7 路径参数

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

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

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

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

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

路径参数：

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

Controller方法：

@RestControllerpublicclassRequestController{//路径参数@RequestMapping("/path/{id}")publicStringpathParam(@PathVariableInteger id){System.out.println(id);return"OK";}}

Postman测试：

传递多个路径参数：

Postman：

Controller方法：

@RestControllerpublicclassRequestController{//路径参数@RequestMapping("/path/{id}/{name}")publicStringpathParam2(@PathVariableInteger id,@PathVariableString name){System.out.println(id+" : "+name);return"OK";}}

2. 响应

前面我们学习过HTTL协议的交互方式：请求响应模式（有请求就有响应）

那么Controller程序呢，除了接收请求外，还可以进行响应。

2.1 @ResponseBody

在我们前面所编写的controller方法中，都已经设置了响应数据。

controller方法中的return的结果，怎么就可以响应给浏览器呢？

答案：使用@ResponseBody注解

@ResponseBody注解：

• 类型：方法注解、类注解
• 位置：书写在Controller方法上或类上
• 作用：将方法返回值直接响应给浏览器 - 如果返回值类型是实体对象/集合，将会转换为JSON格式后在响应给浏览器

但是在我们所书写的Controller中，只在类上添加了@RestController注解、方法添加了@RequestMapping注解，并没有使用@ResponseBody注解，怎么给浏览器响应呢？

@RestControllerpublicclassHelloController{@RequestMapping("/hello")publicStringhello(){System.out.println("Hello World ~");return"Hello World ~";}}

原因：在类上添加的@RestController注解，是一个组合注解。

• @RestController = @Controller + @ResponseBody

@RestController源码：

@Target({ElementType.TYPE})//元注解（修饰注解的注解）@Retention(RetentionPolicy.RUNTIME)//元注解@Documented//元注解@Controller@ResponseBodypublic@interfaceRestController{@AliasFor(
        annotation =Controller.class)Stringvalue()default"";}

结论：在类上添加@RestController就相当于添加了@ResponseBody注解。

• 类上有@RestController注解或@ResponseBody注解时：表示当前类下所有的方法返回值做为响应数据 - 方法的返回值，如果是一个POJO对象或集合时，会先转换为JSON格式，在响应给浏览器

下面我们来测试下响应数据：

@RestControllerpublicclassResponseController{//响应字符串@RequestMapping("/hello")publicStringhello(){System.out.println("Hello World ~");return"Hello World ~";}//响应实体对象@RequestMapping("/getAddr")publicAddressgetAddr(){Address addr =newAddress();//创建实体类对象
        addr.setProvince("广东");
        addr.setCity("深圳");return addr;}//响应集合数据@RequestMapping("/listAddr")publicList<Address>listAddr(){List<Address> list =newArrayList<>();//集合对象Address addr =newAddress();
        addr.setProvince("广东");
        addr.setCity("深圳");Address addr2 =newAddress();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

        list.add(addr);
        list.add(addr2);return list;}}

在服务端响应了一个对象或者集合，那私前端获取到的数据是什么样子的呢？我们使用postman发送请求来测试下。测试效果如下：

2.2 统一响应结果

大家有没有发现一个问题，我们在前面所编写的这些Controller方法中，返回值各种各样，没有任何的规范。

如果我们开发一个大型项目，项目中controller方法将成千上万，使用上述方式将造成整个项目难以维护。那在真实的项目开发中是什么样子的呢？

在真实的项目开发中，无论是哪种方法，我们都会定义一个统一的返回结果。方案如下：

前端：只需要按照统一格式的返回结果进行解析(仅一种解析方案)，就可以拿到数据。

统一的返回结果使用类来描述，在这个结果中包含：

• 响应状态码：当前请求是成功，还是失败
• 状态码信息：给页面的提示信息
• 返回的数据：给前端响应的数据（字符串、对象、集合）

定义在一个实体类Result来包含以上信息。代码如下：

publicclassResult{privateInteger code;//响应码，1 代表成功; 0 代表失败privateString msg;//响应码 描述字符串privateObject data;//返回的数据publicResult(){}publicResult(Integer code,String msg,Object data){this.code = code;this.msg = msg;this.data = data;}//get方法，set方法//增删改 成功响应(不需要给前端返回数据)publicstaticResultsuccess(){returnnewResult(1,"success",null);}//查询 成功响应(把查询结果做为返回数据响应给前端)publicstaticResultsuccess(Object data){returnnewResult(1,"success",data);}//失败响应publicstaticResulterror(String msg){returnnewResult(0,msg,null);}}

改造Controller：

@RestControllerpublicclassResponseController{//响应统一格式的结果@RequestMapping("/hello")publicResulthello(){System.out.println("Hello World ~");//return new Result(1,"success","Hello World ~");returnResult.success("Hello World ~");}//响应统一格式的结果@RequestMapping("/getAddr")publicResultgetAddr(){Address addr =newAddress();
        addr.setProvince("广东");
        addr.setCity("深圳");returnResult.success(addr);}//响应统一格式的结果@RequestMapping("/listAddr")publicResultlistAddr(){List<Address> list =newArrayList<>();Address addr =newAddress();
        addr.setProvince("广东");
        addr.setCity("深圳");Address addr2 =newAddress();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

        list.add(addr);
        list.add(addr2);returnResult.success(list);}}

使用Postman测试：

后记
👉👉💕💕美好的一天，到此结束，下次继续努力！欲知后续，请看下回分解，写作不易，感谢大家的支持！！ 🌹🌹🌹