JavaWeb——005 -- 请求响应分层解耦（Postman、三层架构、IOC、DI、注解）

一、请求

1、Postman（接口测试工具）

1.1、介绍

②、安装

2、简单参数

1.1、原始方式

1.2、SpringBoot方法

③、小结

3、实体参数

3.1、简单实体对象

3.2、复杂实体对象

3.3、小结

4、数组集合参数

①、数组编辑

②、集合

③、小结

5、日期参数

6、JSON参数

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

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

7、路径参数

①、传递单个参数

②、传递多个参数编辑

8、小结编辑

二、响应

1、@ResponseBody

2、统一响应结果

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

②、小结

3、案例

3.1、需求说明

编辑

3.2、实现步骤

3.3、代码实现

3.4、问题分析

三、分层解耦

1、三层架构

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

1.2、代码拆分

1.3、三层架构的好处

2、分层解耦

2.1、耦合问题

2.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（接口测试工具）

1.1、介绍

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

②、安装

运行安装包，创建一个工作空间

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

这个软件我没创建账号（可能需要梯子）

2、简单参数

1.1、原始方式

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. 需要手动的进行类型转换

1.2、SpringBoot方法

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

GEt方法

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

    }

发送Post请求：

结果

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

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

    }

结果

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

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

③、小结

3、实体参数

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

3.1、简单实体对象

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

代码示例：

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

3.2、复杂实体对象

User.java

package com.yaqi.pojo;

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

Address.java

package com.yaqi.pojo;

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 + '\'' +
                '}';
    }
}

复杂实体对象示例：

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

效果展示：

3.3、小结

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

4、数组集合参数

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

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

①、数组

②、集合

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

数组
集合

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

③、小结

5、日期参数

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

6、JSON参数

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

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

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

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

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

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

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

7、路径参数

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

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

http://localhost:8080/user/1

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

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

①、传递单个参数

②、传递多个参数

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、案例

3.1、需求说明

3.2、实现步骤

在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程序，处理请求，响应数据

3.3、代码实现

package com.yaqi.controller;


import com.yaqi.pojo.Emp;
import com.yaqi.pojo.Result;
import com.yaqi.tuils.XmlParserUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class EmpController {

    @RequestMapping("/listEmp")
    public Result list(){
        //1. 加载并解析emp.xml
        String file = this.getClass().getClassLoader().getResource("emp.xml").getFile();
        System.out.println(file);
        List<Emp> empList = XmlParserUtils.parse(file, Emp.class);

        //2. 对数据进行转换处理 - gender, job
        empList.stream().forEach(emp -> {
            //处理 gender 1: 男, 2: 女
            String gender = emp.getGender();
            if("1".equals(gender)){
                emp.setGender("男");
            }else if("2".equals(gender)){
                emp.setGender("女");
            }

            //处理job - 1: 讲师, 2: 班主任 , 3: 就业指导
            String job = emp.getJob();
            if("1".equals(job)){
                emp.setJob("讲师");
            }else if("2".equals(job)){
                emp.setJob("班主任");
            }else if("3".equals(job)){
                emp.setJob("就业指导");
            }
        });

        //3. 响应数据
        return Result.success(empList);
    }

}

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

效果展示：

3.4、问题分析

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

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

- 当我们要修改操作数据部分的代码，需要改动Controller
- 当我们要完善逻辑处理部分的代码，需要改动Controller
- 当我们需要修改数据响应的代码，还是需要改动Controller

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

三、分层解耦

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

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

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

1、三层架构

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

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

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

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

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

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

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

答案：不会影响。（程序的扩展性、维护性变得更好了）

1.2、代码拆分

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

- 控制层包名：xxxx.controller

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

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

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

@RestController
public class EmpController {

    private EmpService empService = new EmpServiceA();

    @RequestMapping("/listEmp")
    public Result list(){
        //1.调用service，获取数据
        List<Emp> empList = empService.listEmp();

        //3. 响应数据
        return Result.success(empList);
    }
}

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

接口

import com.yaqi.pojo.Emp;

import java.util.List;

public interface EmpService {
    //获取员工列表
    public List<Emp> listEmp();
}

实现类

package com.yaqi.service.impl;


import com.yaqi.dao.EmpDao;
import com.yaqi.dao.impl.EmpDaoA;
import com.yaqi.pojo.Emp;
import com.yaqi.service.EmpService;

import java.util.List;

public class EmpServiceA implements EmpService {
    private EmpDao empDao = new EmpDaoA();
    @Override
    public List<Emp> listEmp() {
        //1.调用dao，获取数据
        List<Emp> empList = empDao.listEmp();

        //2. 对数据进行转换处理 - gender, job
        empList.stream().forEach(emp -> {
            //处理 gender 1: 男, 2: 女
            String gender = emp.getGender();
            if("1".equals(gender)){
                emp.setGender("男");
            }else if("2".equals(gender)){
                emp.setGender("女");
            }

            //处理job - 1: 讲师, 2: 班主任 , 3: 就业指导
            String job = emp.getJob();
            if("1".equals(job)){
                emp.setJob("讲师");
            }else if("2".equals(job)){
                emp.setJob("班主任");
            }else if("3".equals(job)){
                emp.setJob("就业指导");
            }
        });
       return empList;
    }
}

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

接口



import com.yaqi.pojo.Emp;

import java.util.List;

public interface EmpDao {
    //用来获取员工数据
    public List<Emp> listEmp();


}

实现类


import com.yaqi.dao.EmpDao;
import com.yaqi.pojo.Emp;
import com.yaqi.tuils.XmlParserUtils;

import java.util.List;

public class EmpDaoA implements EmpDao {
    @Override
    public List<Emp> listEmp() {
        //1. 加载并解析emp.xml
        String file = this.getClass().getClassLoader().getResource("emp.xml").getFile();
        System.out.println(file);
        List<Emp> empList = XmlParserUtils.parse(file, Emp.class);
        return empList;
    }
}

代码调用逻辑图：