【Java Web】005 -- 请求响应 & 分层解耦(Postman、三层架构、IOC、DI、注解)

 

目录

前言(SpringBoot程序请求响应流程)

一、请求

1、Postman(接口测试工具)

①、介绍

②、安装

2、简单参数

①、原始方式

②、SpringBoot方法

③、小结

3、实体参数

①、简单实体对象

②、复杂实体对象

③、小结

4、数组集合参数

①、数组

②、集合

③、小结

5、日期参数

6、JSON参数

①、Postman在发送请求时,如何传递json格式的请求参数

②、在服务端的controller方法中,如何接收json格式的请求参数

7、路径参数

①、传递单个参数

②、传递多个参数

8、小结

二、响应

1、@ResponseBody

2、统一响应结果

①、定义一个统一响应结构类 Result

②、小结

3、案例

①、需求说明

②、实现步骤

③、代码实现

④、问题分析

三、分层解耦

1、三层架构

①、三层架构程序的执行流程

②、代码拆分

③、三层架构的好处

2、分层解耦

①、耦合问题

②、解耦思想

3、IOC & DI 入门

4、IOC详解

①、@Component的衍生注解

②、bean的声明

③、组件扫描

④、小结

5、DI详解

①、@Autowired(自动装配)

②、小结


前言(SpringBoot程序请求响应流程)

以上一章的程序为例,一个基于SpringBoot的方式开发一个web应用,浏览器发起请求 /hello 后 ,给浏览器返回字符串 “Hello World ~”。

的Tomcat)。而我们在开发web程序时呢,定义了一个控制器类Controller,请求会被部署在Tomcat中的Controller接收,然后Controller再给浏览器一个响应,响应一个字符在浏览器发起请求,请求了我们的后端web服务器(也就是内置串 “Hello World”。 而在请求响应的过程中是遵循HTTP协议的。

但是在Tomcat这类Web服务器中,是不识别我们自己定义的Controller的。而Tomcat是一个Servlet容器,支持Serlvet规范,因此tomcat中是可以识别 Servlet程序的

那么在SpringBoot进行web程序开发时,它其实内置了一个核心的Servlet程序 DispatcherServlet,称之为 核心控制器,也可以叫做 前端控制器。 DispatcherServlet 负责接收页面发送的请求,然后根据执行的规则,将请求再转发给后面的请求处理器Controller,请求处理器处理完请求之后,最终再由DispatcherServlet给浏览器响应数据。

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

一、请求

1、Postman(接口测试工具)

①、介绍

Postman是一款支持http协议的接口调试与测试工具,它不仅可以调试简单的css、html、脚本等简单的网页基本信息,还可以发送几乎所有类型的HTTP请求。

②、安装

Ⅰ、运行安装包

Ⅱ、创建一个Postman的账号

Ⅲ、创建一个工作空间

Ⅳ、在新创建的工作空间中添加一个请求

配置请求:

Ⅴ、保存测试数据 (Ctrl+s)

2、简单参数

①、原始方式

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

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

//根据指定的参数名获取请求参数的数据值

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

    }

}

该方式仅做了解接口,在以后的开发中基本不会用到,原因是因为:

1. 写法比较繁琐 2. 需要手动的进行类型转换

②、SpringBoot方法

在Springboot方法中可以自动进行类型转换。在Springboot的环境中,对原始的API进行了封装,接收参数的形式更加简单。 对于简单参数来讲,只要保证请求参数名和Controller方法中的形参名保持一致,就可以获取到请求参数中的数据值。

发送Post请求:

如果形参与请求参数对应不上,也可以通过注解@RequestParam来进行映射:

但是如果没有设置@RequestParam注解,且方法形参名与请求参数名不一致,那么虽然会无法接收到请求数据,但是它不会报错

注解@RequestParam中的required属性默认为true,代表该请求参数必须传递,如果不传递就会报错:

③、小结

3、实体参数

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

①、简单实体对象

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

代码示例:

效果展示:

②、复杂实体对象

User.java:

复杂实体对象示例:

效果展示:

③、小结

如果是复杂实体对象,也只需按照对象层次结构关系即可接收嵌套实体类属性参数

4、数组集合参数

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

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

①、数组

②、集合

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

  • 数组
  • 集合

如果要接收集合的话,需要加上@RequestParam这个注解,如果不加的话,默认接收的是数组形式

③、小结

5、日期参数

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

6、JSON参数

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

①、Postman在发送请求时,如何传递json格式的请求参数

②、在服务端的controller方法中,如何接收json格式的请求参数

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

- 传递json格式的参数,在Controller中会使用实体类进行封装。

- 封装规则:JSON数据键名与形参对象属性名相同,定义POJO类型形参即可接收参数。需要使用 @RequestBody标识。

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

控制台效果:

7、路径参数

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

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

上述的这种传递请求参数的形式,就称之为 路径参数

①、传递单个参数

路径参数:

- 前端:通过请求URL直接传递参数

- 后端:使用{…}来标识该路径参数,需要使用@PathVariable获取路径参数

②、传递多个参数

和传递单个参数方法相同,无非就是多写一个形参和注解,需要注意的是:形参要和传递的参数相同才能接收成功

8、小结

二、响应

1、@ResponseBody

在我们前面所编写的controller方法中,都已经设置了响应数据,那controller方法中的return的结果,怎么就可以响应给浏览器呢?

答案:使用 @ResponseBody 注解

@RestController是两个注解的组合,@RestController = @Controller + @ResponseBody

2、统一响应结果

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

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

①、定义一个统一响应结构类 Result

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

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

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

- 响应状态码(code):当前请求是成功,还是失败

- 状态码信息(msg):给页面的提示信息

- 返回的数据(data):给前端响应的数据(字符串、对象、集合)

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

public class Result {

    private Integer code;//响应码,1 代表成功; 0 代表失败

    private String msg;  //响应码 描述字符串

    private Object data; //返回的数据

    public Result() { }

    public Result(Integer code, String msg, Object data) {

        this.code = code;

        this.msg = msg;

        this.data = data;

    }

    public Integer getCode() {

        return code;

    }

    public void setCode(Integer code) {

        this.code = code;

    }

    public String getMsg() {

        return msg;

    }

    public void setMsg(String msg) {

        this.msg = msg;

    }

    public Object getData() {

        return data;

    }

    public void setData(Object data) {

        this.data = data;

    }

    //增删改 成功响应(不需要给前端返回数据)

    public static Result success(){

        return new Result(1,"success",null);

    }

    //查询 成功响应(把查询结果做为返回数据响应给前端)

    public static Result success(Object data){

        return new Result(1,"success",data);

    }

    //失败响应

    public static Result error(String msg){

        return new Result(0,msg,null);

    }

}

效果展示:

②、小结

3、案例

①、需求说明

②、实现步骤

Ⅰ、在pom.xml文件中引入dom4j的依赖,用于解析XML文件

<dependency>

    <groupId>org.dom4j</groupId>

    <artifactId>dom4j</artifactId>

    <version>2.1.3</version>

</dependency>

Ⅱ、引入资料中提供的:解析XML的工具类XMLParserUtils、实体类Emp、XML文件emp.xml

Ⅲ、引入资料中提供的静态页面文件,放在resources下的static目录下

Ⅳ、创建EmpController类,编写Controller程序,处理请求,响应数据

③、代码实现

Contriller代码:

统一返回结果实体类 Result:同上

效果展示:

④、问题分析

上述案例的功能,我们虽然已经实现,但是呢,我们会发现案例中:解析XML数据,获取数据的代码,处理数据的逻辑的代码,给页面响应的代码全部都堆积在一起了,全部都写在controller方法中了

当前程序的这个业务逻辑还是比较简单的,如果业务逻辑再稍微复杂一点,我们会看到Controller方法的代码量就很大了。

- 当我们要修改操作数据部分的代码,需要改动Controller

- 当我们要完善逻辑处理部分的代码,需要改动Controller

- 当我们需要修改数据响应的代码,还是需要改动Controller

这样呢,就会造成我们整个工程代码的复用性比较差,而且代码难以维护。 那如何解决这个问题呢?其实在现在的开发中,有非常成熟的解决思路,那就是分层开发

三、分层解耦

在我们进行程序设计以及程序开发时,尽可能让每一个接口、类、方法的职责更单一些(单一职责原则)

单一职责原则:一个类或一个方法,就只做一件事情,只管一块功能

这样就可以让类、接口、方法的复杂度更低,可读性更强,扩展性更好,也更利用后期的维护

1、三层架构

那其实我们上述案例的处理逻辑呢,从组成上看可以分为三个部分:

- 数据访问:负责业务数据的维护操作,包括增、删、改、查等操作。

- 逻辑处理:负责业务逻辑处理的代码。

- 请求处理、响应数据:负责,接收页面的请求,给页面响应数据。

按照上述的三个组成部分,在我们项目开发中呢,可以将代码分为三层:

①、三层架构程序的执行流程

思考:按照三层架构的思想,如何要对业务逻辑(Service层)进行变更,会影响到Controller层和Dao层吗?

答案:不会影响。 (程序的扩展性、维护性变得更好了)

②、代码拆分

我们使用三层架构思想,来改造下之前的程序:

- 控制层包名:xxxx.controller

- 业务逻辑层包名:xxxx.service

- 数据访问层包名:xxxx.dao

控制层:接收前端发送的请求,对请求进行处理,并响应数据

业务逻辑层:处理具体的业务逻辑

数据访问层:负责数据的访问操作,包含数据的增、删、改、查

代码调用逻辑图:

③、三层架构的好处

三层架构的好处:

1. 复用性强

2. 便于维护

3. 利用扩展

2、分层解耦

解耦:解除耦合

①、耦合问题

首先需要了解软件开发涉及到的两个概念:内聚和耦合

- 内聚:软件中各个功能模块内部的功能联系

- 耦合:衡量软件中各个层/模块之间的依赖、关联的程度

软件设计原则:高内聚低耦合

高内聚指的是:一个模块中各个元素之间的联系的紧密程度,如果各个元素(语句、程序段)之间的联系程度越高,则内聚性越高,即 "高内聚"

低耦合指的是:软件中各个层、模块之间的依赖关联程序越低越好

程序中高内聚的体现:

- EmpServiceA类中只编写了和员工相关的逻辑处理代码

程序中耦合代码的体现:

- 把业务类变为EmpServiceB时,需要修改controller层中的代码

高内聚、低耦合的目的是使程序模块的可重用性、移植性大大增强

②、解耦思想

现在写的代码存在耦合

那我们应该如何解耦呢?首先第一步不能在EmpController中使用new对象,把new这一块代码删掉

此时,就存在另一个问题了,不能new,就意味着没有业务层对象(程序运行就报错),怎么办呢?

我们的解决思路是:

- 提供一个容器,容器中存储一些对象(例:EmpService对象)

- controller程序从容器中获取EmpService类型的对象

我们想要实现上述解耦操作,就涉及到Spring中的两个核心概念:

  • 控制反转: Inversion Of Control,简称IOC。对象的创建控制权由程序自身转移到外部(容器),这种思想称为控制反转。

  > 对象的创建权由程序员主动创建转移到容器(由容器创建、管理对象)。这个容器称为:IOC容器或Spring容器

  • 依赖注入:Dependency Injection,简称DI。容器为应用程序提供运行时,所依赖的资源,称之为依赖注入。

  > 程序运行时需要某个资源,此时容器就为其提供这个资源。

  > 例:EmpController程序运行时需要EmpService对象,Spring容器就为其提供并注入EmpService对象

IOC容器中创建、管理的对象,称之为:bean对象

3、IOC & DI 入门

思路:

1. 删除Controller层、Service层中new对象的代码

2. Service层及Dao层的实现类,交给IOC容器管理

3. 为Controller及Service注入运行时依赖的对象

   - Controller程序中注入依赖的Service层对象

   - Service程序中注入依赖的Dao层对象

第1步:删除Controller层、Service层中new对象的代码

第2步:Service层及Dao层的实现类,交给IOC容器管理

  • 使用Spring提供的注解:@Component ,就可以实现类交给IOC容器管理

第3步:为Controller及Service注入运行时依赖的对象

  • 使用Spring提供的注解:@Autowired ,就可以实现程序运行时IOC容器自动注入需要的依赖对象

运行测试:

思考:通过 IOC & DI 可以完成层与层之间的代码解耦吗?

答案:可以,想要切换相应的Service 只需要打开并注释掉其它Service的@Component注解即可

4、IOC详解

IOC控制反转,就是将对象的控制权交给Spring的IOC容器,由IOC容器创建及管理对象。IOC容器创建的对象称为bean对象。

在之前的入门案例中,要把某个对象交给IOC容器管理,需要在类上添加一个注解:@Component

①、@Component的衍生注解

而Spring框架为了更好的标识web应用程序开发当中,bean对象到底归属于哪一层,又提供了@Component的衍生注解:

@Service与@Repository注解源码:

②、bean的声明

在IOC容器中,每一个Bean都有一个属于自己的名字,可以通过注解的value属性指定bean的名字。如果没有指定,默认为类名首字母小写:

指定bean的名字(一般不用指定)

③、组件扫描

问题:使用前面学习的四个注解声明的bean,一定会生效吗?

答案:不一定。(原因:bean想要生效,还需要被组件扫描)

要想解决该问题,我们有两种做法:

  1. 手动添加@ComponentScan注解,指定要扫描的包   (仅做了解,不推荐

  1. 将我们定义的controller,service,dao这些包呢,都放在引导类所在包com.itheima的子包下,这样我们定义的bean就会被自动的扫描到

④、小结

5、DI详解

依赖注入,是指IOC容器要为应用程序去提供运行时所依赖的资源,而资源指的就是对象

①、@Autowired(自动装配)

在入门程序案例中,我们使用了@Autowired这个注解,完成了依赖注入的操作,而这个Autowired翻译过来叫:自动装配。

@Autowired注解,默认是按照类型进行自动装配的(去IOC容器中找某个类型的对象,然后完成注入操作)

问题:如果在IOC容器中,存在多个相同类型的bean对象,会出现什么情况呢?

答案:程序运行会报错,会提示我们不能完成自动装配了

解决方案:

  • 使用@Primary注解:当存在多个相同类型的Bean注入时,加上@Primary注解,来确定默认的实现

  • 使用@Qualifier注解:指定当前要注入的bean对象。 在@Qualifier的value属性中,指定注入的bean的名称
  • @Qualifier注解不能单独使用,必须配合@Autowired使用

  • 使用@Resource注解:是按照bean的名称进行注入。通过name属性指定要注入的bean的名称

面试题 : @Autowird 与 @Resource的区别:

- @Autowired 是spring框架提供的注解,而@Resource是JDK提供的注解

- @Autowired 默认是按照类型注入,而@Resource是按照名称注入

②、小结

猜你喜欢

转载自blog.csdn.net/qq_41071754/article/details/129903630