SpringBootWeb请求响应

2024-03-16

Java

5.1k 词

一、概述

请求响应：
- 请求（HttpServletRequest)：获取请求数据
- 响应（HttpServletResponse）：设置响应请求
- BS架构：Browser/Server，浏览器/服务器架构模式。客户端只需要浏览器，应用程序的逻辑和数据都存储在服务器。(维护方便体验一般)
- CS架构：Client/Server，客户端/服务器架构模式。(开发、维护麻烦体验不错)

二、请求

2.1 Postman

在前后端分离开发模式下，前端技术人员基于”接口文档”，开发前端程序；后端技术人员也基于”接口文档”，开发后端程序。由于前后端分离，对我们后端技术人员来讲，在开发过程中，是没有前端页面的，那我们怎么测试自己所开发的程序呢
- 方式1：直接使用浏览器。在浏览器中输入地址，测试后端程序。
- 方式2：使用专业的接口测试工具（就是下面的Postman）
Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件，下载地址：https://www.postman.com/downloads/

2.2 简单参数

2.2.1 原始方式

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

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

@RestController
public 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";
    }
}

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

2.2.2 SpringBoot方式

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

@RestController
public 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";
    }
}

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

参数名不一致：如果方法形参名称与请求参数名称不一致时运行没有报错。 controller方法中的name值为：null，age值为10。由此可知对于简单参数来讲，请求参数名和controller方法中的形参名不一致时，无法接收到请求数据
那么如果我们开发中，遇到了这种请求参数名和controller方法中的形参名不相同时候，可以使用Spring提供的@RequestParam注解完成映射：

@RestController
public class RequestController {
    // http://localhost:8080/simpleParam?name=Tom&age=20
    // 请求参数名：name

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

注意事项：

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

如果该参数是可选的，可以将required属性设置为false
1
2
3
4
5
 >@RequestMapping("/simpleParam")
 >public String simpleParam(@RequestParam(name = "name", required = false) String username, Integer age){
System.out.println(username+ ":" + age);
return "OK";
 >}

2.3 实体参数

简单实体参数：请求参数名与形参对象属性名相同，定义POJO接收即可

@RequestMapping("/simplePojo")
public String simplePojo(User user){
	System.out.println(user);
	return "OK";
}

public class User {
    private String name;
    private Integer age;
}

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

2.4 数组集合参数

数组参数：请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接收参数
集合参数：请求参数名与形参集合名称相同且请求参数为多个，通过 @RequestParam 绑定参数关系

2.4 日期参数

日期的格式多种多样（如：2022-12-12 10:05:45 、2022/12/12 10:05:45），那么对于日期类型的参数在进行封装的时候，需要通过@DateTimeFormat注解，以及其pattern属性来设置日期的格式。
后端controller方法中，需要使用Date类型或LocalDateTime类型，来封装传递的参数。

2.5 JSON参数

JSON参数：JSON参数键名与形参对象属性名相同，定义POJO类型形参即可接收参数，需要使用 @ReauestBody 标识。

2.6 路径参数

路径参数：通过请求URL直接传递参数，使用 {...} 来标识路径参数，需要使用 @PathVariable 获取路径参数。
可以传递多层参数

2.7 总结

三、响应

3.1 @ResponseBody & 统一响应结果

@ResponseBody
- 类型：方法注解、类注解
- 位置：Controller方法上/类上
- 作用：将方法返回值直接响应，如果返回值类型是实体对象/集合，将会转换为 JSON 格式响应
- 说明：@RestController = @Controller + @ResponseBody
统一响应结果
- 在真实的项目开发中，我们都会定义一个统一的返回结果。方案如下：
- 统一的返回结果使用类来描述，在这个结果中包含：
  - 响应状态码：当前请求是成功，还是失败
  - 状态码信息：给页面的提示信息
  - 返回的数据：给前端响应的数据（字符串、对象、集合）

3.2 拓展

  1. springboot 项目的静态资源 (html、css、js等前端资源) 默认存放目录为：
     - `classpath:/static`
     - ``classpath:/public`
     - `classpath:/resources`

四、分层解耦

4.1 三层架构

Controller：接受请求、响应数据
- 控制层，接收前端发送的请求，对请求进行出来，并影响数据
Service：逻辑处理
- 业务逻辑层，处理具体的业务逻辑
Dao：数据访问
- 数据访问层 (Data Access Object)（持久层），负责数据访问操作，包括数据的增、删、改、查

4.2 分层解耦

内聚：软件中各个功能模块内部的功能联系。
耦合：衡量软件中各个层/模块之间的依赖、关联的程度
软件设计原则：高内聚低耦合
分层解耦：
- 控制反转： Inversion Of Control，简称IOC。对象的创建控制权由程序自身转移到外部（容器），这种思想称为控制反转。
- 依赖注入： Dependency Injection，简称DI。容器为应用程序提供运行时，所依赖的资源，称之为依赖注入。
- Bean对象：IOC容器中创建、管理的对象，称之为bean。

4.3 IOC & DI

4.3.1 入门

Service 层及 Dao 层的实现类，交给 IOC 容器管理。
- @Component：在接口的实现类上使用该注解，将其交给 IOC 容器管理
为 Controller 及 Service 注入运行时需要依赖的对象。
- @Autowired：无需创建对象，就可以实现程序运行时IOC容器自动注入需要的依赖对象

4.3.2 IOC 详解

Bean的声明

要把某个对象交给 IOC 容器管理，需要在对应的类上加上如下注解之一：

注解	说明	位置
@Component	声明bean的基础注解	不属于以下三类时，用此注解
@Controller	@Component 的衍生注解	标注在控制器上
@Service	@Component 的衍生注解	标注在业务类上
@Repository	@Component 的衍生注解	标注在数据访问类上（由于 mybaits 整合，用的少）

注意事项：
- 声明bean的时候，可以通过 value 属性指定 bean 的名字，如果没有指定，默认为类名首字母小写。
- 使用以上四个注解都可以声明bean，但是在springboot集成web开发中，声明控制器bean只能用 @Controller
Bean 组件扫描
- 前面声明 bean 的四大注解，要想生效，还需要被组件扫描注解 @ComponentScan 扫描，
- @ComponentScan 注解虽然没有显式配置，但是实际上已经包含在了启动类声明注解 @SpringBootApplication 中，默认扫描的范围是启动类所在包及其子包

4.3.3 DI详解

Bean 注入
- @Autowired 注解，默认是按照类型进行，如果存在多个相同类型的 bean，将会报错\
通过以下几个方案来解决：
- @Primary：设置优先级
- @Qualifier：指定注入对象
- @Resource：取代@Autowired，指定类名注入
@Resource 和 @Autowired 区别
- @Autowired是spring框架提供的注解，而 @Resource 是JDK 提供的注解。
- @Autowired 默认是按照类型注入，而 @Resource 默认是按照名称注入

分类

标签