SJDocs

SpringBootWeb请求响应

今日目标

目标

能够编写 SpringBoot 入门案例 ❤️
能够使用 PostMan/ApiFox 工具发送请求 ❤️ ✏️
能够掌握普通类型参数传递
能够掌握 POJO 类型参数传递
能够掌握 json 数据参数、路径参数传递 ❤️ ✏️
能够掌握响应 json 数据 ❤️ ✏️
能够理解IOC和DI 🍐

前言 🍐

在上一次的课程中，我们开发了springbootweb的入门程序。

需求

基于SpringBoot的方式开发一个web应用，浏览器发起请求/hello后，给浏览器返回字符串 “Hello World ~”。

知识点：

🌍 浏览器发起请求，请求了我们的后端web服务器💻(也就是内置的Tomcat)
请求会被部署在Tomcat中的Controller接收，然后Controller再给浏览器一个响应，响应一个字符串 “Hello World”。
请求响应的过程中是遵循HTTP协议的
在SpringBoot进行web程序开发时，它内置了一个核心的Servlet程序 DispatcherServlet，称之为核心控制器。 DispatcherServlet 负责接收页面发送的请求，然后根据执行的规则，将请求再转发给后面的请求处理器Controller，请求处理器处理完请求之后，最终再由DispatcherServlet给浏览器响应数据。
浏览器发送请求，会携带请求数据，包括：请求行、请求头。这些数据可以从HttpServletRequest对象中获取
而程序通过设置HttpServletResponse对象，通过服务器Tomcat给浏览器返回响应数据

那上述所描述的这种浏览器/服务器的架构模式呢，我们称之为：BS架构。

BS架构🌍：Browser/Server，浏览器/服务器架构模式。客户端只需要浏览器，应用程序的逻辑和数据都存储在服务端。
CS架构open in new window ：Client-Server，服务器-客户机架构模式。

作业

🚩 能够流畅的说出SpringBoot入门案例涉及的知识点
🚩 能够举例说明BS架构和CS架构的特点

1. 请求 🍐 ❤️

本章节，我们主要讲解，如何接收页面传递过来的请求数据。

1.1 Postman ✏️ 🔧

问题

Postman的作用是什么？

点击查看

常用于进行接口测试(如模拟发送get和post请求)

之前我们课程中有提到当前最为主流的开发模式：前后端分离

知识点

在前后端分离开发模式下，前端技术人员基于"接口文档"，开发前端程序 🌍；后端技术人员也基于"接口文档"，开发后端程序💻。
后端技术人员，在开发过程中，没有前端页面。需要通过Postman等工具模拟发送请求，测试接口，而避免书写的前端代码进行测试。

1.1.1 介绍

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

也可以使用 Apifox模拟发送请求，特点是：中文、微信登录 👍

ApiFox 是一款模拟请求的软件，有：API 文档、API 调试、API Mock、API 自动化测试等功能，官网：https://www.apifox.cn/open in new window Apifox 使用教程open in new window

1.2 简单参数❤️

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

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

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

原始方式 🚀
SpringBoot方式 ❤️

1.2.1 原始方式

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

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

postman测试( GET 请求)：

postman测试( POST请求 )：

结论

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

1.2.3 参数名不一致 ⚠️

问题

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

@RestController
public 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方法中的形参名不一致时，无法接收到请求数据

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

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

@RestController
public 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），代表该请求参数必须传递，如果不传递将报错
image-20221203130726310
如果该参数是可选的，可以将required属性设置为false

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

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/simpleParam?bookname=凡人修仙传&count=1000，并且将数据打印在控制台上

1.3 实体参数🍐 🚀

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

问题

将多个参数数据封装到实体类对象中，需要遵循什么规则？

点击查看答案

请求参数名与实体类的属性名相同

1.3.1 简单实体对象

定义POJO实体类：

public class User {
    private String name;
    private Integer age;
//   自行补充getset方法
    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

Controller方法：

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

Postman测试：

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

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

1.3.2 复杂实体对象

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

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

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

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

定义POJO实体类：

Address实体类

public class Address {
    private String province;
    private String city;

//   自行补充getset方法
    
    @Override
    public String toString() {
        return "Address{" +
                "province='" + province + '\'' +
                ", city='" + city + '\'' +
                '}';
    }
}

User实体类

public class User {
    private String name;
    private Integer age;
    private Address address; //地址对象

//   自行补充getset方法

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", address=" + address +
                '}';
    }
}

Controller方法：

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

Postman测试：

localhost:8080/complexPojo?name=Tom&age=10&address.province=bj&address.city=bj

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/simplePojo?bookname=凡人修仙传&count=1000，定义一个Book实体类，接收上述数据，并打印book对象的toString方法

1.4 数组集合参数 ❤️ ✏️

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

1.4.1 数组

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

Controller方法：

@RestController
public 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 开发实用

1.4.2 集合

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

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

Controller方法：

@RestController
public 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 开发实用

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/arrayParam?bookname=凡人修仙传&count=1000&protagonist=韩立,南宫婉，定义一个Book实体类，接收上述数据，并打印book对象的toString方法

1.5 日期参数 ✏️

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

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

Controller方法：

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

Postman测试：

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/dateParam?bookname=凡人修仙传&count=1000&protagonist=韩立,南宫婉&createTime=2022-12-12，定义一个Book实体类，接收上述数据，并打印book对象的toString方法

1.6 JSON参数 ❤️ ✏️

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

1️⃣ Postman发送JSON格式数据：

{
  "name": "韩立",
  "age": 95,
  "address": {
    "province": "湖南省",
    "city": "长沙市"
  }
}

2️⃣ 服务端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方法：

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

Postman测试：

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/jsonParam，定义一个Book实体类，接收上述数据，并打印book对象的toString方法参数格式：

{
    "bookname": "凡人修仙传",
    "count": 1000,
    "protagonist": [
        "韩立",
        "南宫婉"
    ],
    "createTime": "2022-12-12"
}

步骤提示💡：

创建BookController,在类上添加注解
根据上述的json字符串，在pojo包中书写一个Book实体类
在BookController中书写一个方法接收json字符串，方法的返回值为Book
打印传过来的参数，并且修改bookname为计算机概念，返回book对象
启动postman 输入路径和参数，点击发送，观察idea控制台和postman的返回结果

在线Json转换网站open in new window

1.7 路径参数 ❤️ ✏️

问题

路径参数需要用到什么注解？需要遵循什么规则？

点击查看

路径参数：

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

传统的开发中请求参数是放在请求体(POST请求)传递或跟在URL后面通过?key=value的形式传递(GET请求)。在现在的开发中，经常还会直接在请求的URL中传递参数。例如：
http://localhost:8080/user/1open in new window
http://localhost:880/user/1/0open in new window
上述的这种传递请求参数的形式呢，我们称之为：路径参数。

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

Controller方法：

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

Postman测试：

Controller方法：

@RestController
public class RequestController {
    //路径参数
    @RequestMapping("/path/{id}/{name}")
    public String pathParam2(@PathVariable Integer id, @PathVariable String name){
        System.out.println(id+ " : " +name);
        return "OK";
    }
}

Postman：

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/books/110，书写一个方法接收路径参数110，接收后打印在控制台

步骤提示💡：

在BookController中书写一个方法接收路径参数，无返回值
打印传过来的路径参数
启动postman 输入路径和参数，点击发送，观察idea控制台和postman的返回结果
思考：如果{变量名}和形参中的参数名不一样，会出现什么情况？使用代码尝试一下！

2. 响应 🍐

问题

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

点击查看

问题1：使用@ResponseBody注解

2.1 @ResponseBody

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

@ResponseBody注解

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

问题

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

点击查看

@RestController
public class HelloController {
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("Hello World ~");
        return "Hello World ~";
    }
}

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

@RestController = @Controller + @ResponseBody 👈

@RestController源码：

@Target({ElementType.TYPE})   //元注解（修饰注解的注解）
@Retention(RetentionPolicy.RUNTIME)  //元注解
@Documented    //元注解
@Controller   
@ResponseBody 
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}

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

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

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

@RestController
public class ResponseController {
    //响应字符串
    @RequestMapping("/hello")
    public String hello(){
        System.out.println("Hello World ~");
        return "Hello World ~";
    }
    //响应实体对象
    @RequestMapping("/getAddr")
    public Address getAddr(){
        Address addr = new Address();//创建实体类对象
        addr.setProvince("广东");
        addr.setCity("深圳");
        return addr;
    }
    //响应集合数据
    @RequestMapping("/listAddr")
    public List<Address> listAddr(){
        List<Address> list = new ArrayList<>();//集合对象
        
        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");

        Address addr2 = new Address();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

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

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

2.2 统一响应结果 🍐 ❤️

问题：Controller方法中，返回值各种各样，没有任何的规范（如下图）

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

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

解决方案如下：

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

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

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

点击查看实体类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);
    }
}

改造Controller：

@RestController
public class ResponseController { 
    //响应统一格式的结果
    @RequestMapping("/hello")
    public Result hello(){
        System.out.println("Hello World ~");
        //return new Result(1,"success","Hello World ~");
        return Result.success("Hello World ~");
    }

    //响应统一格式的结果
    @RequestMapping("/getAddr")
    public Result getAddr(){
        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");
        return Result.success(addr);
    }

    //响应统一格式的结果
    @RequestMapping("/listAddr")
    public Result listAddr(){
        List<Address> list = new ArrayList<>();

        Address addr = new Address();
        addr.setProvince("广东");
        addr.setCity("深圳");

        Address addr2 = new Address();
        addr2.setProvince("陕西");
        addr2.setCity("西安");

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

使用Postman测试：

作业

🚩 在BookController书写一个方法接收如下请求，http://localhost:8080/jsonParam，定义一个Book实体类，接收上述数据，并且将count修改为888，然后返回User对象的JSON字符串给浏览器.
🚩 在上一个需求前提下，将返回的数据使用Result对象封装后，再次返回给前端请求参数格式：

{
    "bookname": "凡人修仙传",
    "count": 1000,
    "protagonist": [
        "韩立",
        "南宫婉"
    ],
    "createTime": "2022-12-12"
}

步骤提示💡：

找到springboot-web-req-resp模块下的ResponseController，观察各个方法的返回值类型
导入Result统一结果类到pojo中
修改ResponseController各个方法的返回值为Result
启动postman 输入路径和参数，点击发送，观察idea控制台和postman的返回结果

在线Json转换网站open in new window

2.3 案例 ✏️ ❤️

下面我们通过一个案例，来加强对请求响应的学习。🎯

2.3.1 需求说明

需求：加载并解析xml文件中的数据，完成数据处理，并在页面展示

获取员工数据，返回统一响应结果，在页面渲染展示

⚠️ 注意：数据为假数据

2.3.2 准备工作

案例准备：

1️⃣ XML文件
- 已经准备好(emp.xml)，直接导入进来，放在 src/main/resources目录下
2️⃣ 工具类
- 已经准备好解析XML文件的工具类，无需自己实现
- 直接在创建一个包 com.itheima.utils ，然后将工具类拷贝进来
3️⃣ 前端页面资源
- 已经准备好，直接拷贝进来，放在src/main/resources下的static目录下

静态资源位置

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

在SpringBoot项目中，静态资源默认可以存放的目录：
classpath:/static/
classpath:/public/
classpath:/resources/
classpath:/META-INF/resources/
classpath：
代表的是类路径，在maven的项目中，其实指的就是 src/main/resources 或者 src/main/java，但是java目录是存放java代码的，所以相关的配置文件及静态资源文档，就放在 src/main/resources下。

点击查看XmlParserUtils.java代码

package com.itheima.utils;

import org.dom4j.Document;
import org.dom4j.Element;
import org.dom4j.io.SAXReader;
import java.io.File;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.List;

public class XmlParserUtils {

    public static <T> List<T> parse(String file , Class<T> targetClass)  {
        ArrayList<T> list = new ArrayList<T>(); //封装解析出来的数据
        try {
            //1.获取一个解析器对象
            SAXReader saxReader = new SAXReader();
            //2.利用解析器把xml文件加载到内存中,并返回一个文档对象
            Document document = saxReader.read(new File(file));
            //3.获取到根标签
            Element rootElement = document.getRootElement();
            //4.通过根标签来获取 user 标签
            List<Element> elements = rootElement.elements("emp");

            //5.遍历集合,得到每一个 user 标签
            for (Element element : elements) {
                //获取 name 属性
                String name = element.element("name").getText();
                //获取 age 属性
                String age = element.element("age").getText();
                //获取 image 属性
                String image = element.element("image").getText();
                //获取 gender 属性
                String gender = element.element("gender").getText();
                //获取 job 属性
                String job = element.element("job").getText();

                //组装数据
                Constructor<T> constructor = targetClass.getDeclaredConstructor(String.class, Integer.class, String.class, String.class, String.class);
                constructor.setAccessible(true);
                T object = constructor.newInstance(name, Integer.parseInt(age), image, gender, job);

                list.add(object);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        return list;
    }

}

点击查看emp.xml代码

<?xml version="1.0" encoding="UTF-8" ?>
<emps>
    <emp>
        <name>金毛狮王</name>
        <age>55</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/1.jpg</image>
        <!-- 1: 男, 2: 女 -->
        <gender>1</gender>
        <!-- 1: 讲师, 2: 班主任 , 3: 就业指导 -->
        <job>1</job>
    </emp>

    <emp>
        <name>白眉鹰王</name>
        <age>65</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/2.jpg</image>
        <gender>1</gender>
        <job>1</job>
    </emp>

    <emp>
        <name>青翼蝠王</name>
        <age>45</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/3.jpg</image>
        <gender>1</gender>
        <job>2</job>
    </emp>

    <emp>
        <name>紫衫龙王</name>
        <age>38</age>
        <image>https://web-framework.oss-cn-hangzhou.aliyuncs.com/web/4.jpg</image>
        <gender>2</gender>
        <job>3</job>
    </emp>
</emps>

点击查看emp实体类代码

package com.itheima.pojo;

public class Emp {
    private String name;
    private Integer age;
    private String image;
    private String gender;
    private String job;

    public Emp() {
    }

    public Emp(String name, Integer age, String image, String gender, String job) {
        this.name = name;
        this.age = age;
        this.image = image;
        this.gender = gender;
        this.job = job;
    }

    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 String getImage() {
        return image;
    }

    public void setImage(String image) {
        this.image = image;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public String getJob() {
        return job;
    }

    public void setJob(String job) {
        this.job = job;
    }

    @Override
    public String toString() {
        return "Emp{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", image='" + image + '\'' +
                ", gender='" + gender + '\'' +
                ", job='" + job + '\'' +
                '}';
    }
}

2.3.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
image-20221204182828547
引入资料中提供的静态页面文件，放在resources下的static目录下
image-20221204183044848
创建EmpController类，编写Controller程序，处理请求，响应数据
image-20221204184313822

2.3.4 代码实现和测试

Contriller代码：

@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);
    }
}

统一返回结果实体类：

public class Result {
    private Integer code ;//1 成功 , 0 失败
    private String msg; //提示信息
    private Object data; //数据 date

    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(Object data){
        return new Result(1, "success", data);
    }
    public static Result success(){
        return new Result(1, "success", null);
    }
    public static Result error(String msg){
        return new Result(0, msg, null);
    }
}

技巧

springboot项目的前端静态资源是放在 resources 下的static文件夹中
resources 的资源经过编译后，在target文件下的clases文件夹中（常常说的classpath、类路径）

作业

🚩 独自完成上述案例。

步骤提示💡：

按照准备工作的提示，将文件导入进工程
书写Controller逻辑，并使用Postman测试接口
打开浏览器输入http://localhost:8080/emp.html 观察是否成功加载

2.3.6 问题分析

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

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

注意

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

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

3. 分层解耦

3.1 三层架构 🍐

三层架构

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

单一职责原则：一个类或一个方法，就只做一件事情，只管一块功能。
这样就可以让类、接口、方法的复杂度更低，可读性更强，扩展性更好，也更利用后期的维护。

我们之前开发的程序呢，并不满足单一职责原则。点击查看之前的程序open in new window 👈

上述案例的处理逻辑，从组成上看可以分为三个部分：

数据访问：负责业务数据的维护操作，包括增、删、改、查等操作。
逻辑处理：负责业务逻辑处理的代码。
请求处理、响应数据：负责，接收页面的请求，给页面响应数据。

如果你理解了单一职责原则和三层架构的好处，那么接下来，实操一波，将理论落地吧！！

三层架构实操

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

控制层包名：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);
    }
}

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

业务接口

//业务逻辑接口（制定业务标准）
public interface EmpService {
    //获取员工列表
    public List<Emp> listEmp();
}

业务实现类

//业务逻辑实现类（按照业务标准实现）
public class EmpServiceA implements EmpService {
    //dao层对象
    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;
    }
}

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

数据访问接口

//数据访问层接口（制定标准）
public interface EmpDao {
    //获取员工列表数据
    public List<Emp> listEmp();
}

数据访问实现类

//数据访问实现类
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;
    }
}

作业

🚩 能够流畅的说出三层架构分为哪三层，以及每一层的作用，还有三层架构的好处

3.2 分层解耦 🍐❤️

分层解耦

目标：解耦(解除耦合)

如果你理解了左边的耦合问题以及解耦的意义，那么接下来学习如何解耦 👇

解耦思路 👇

之前我们在编写代码时，需要什么对象，就直接new一个就可以了。这种做法呢，层与层之间代码就耦合了，当service层的实现变了之后，我们还需要修改controller层的代码。

**步骤：**👇

首先不能在EmpController中使用new对象。代码如图解：点击查看代码图解open in new window👈
此时，就存在另一个问题了，不能new，就意味着没有业务层对象（程序运行就报错），怎么办呢？

解决思路

提供一个容器，容器中存储一些对象(例：EmpService对象)
controller程序自动从容器中获取EmpService类型的对象

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

控制反转： Inversion Of Control，简称IOC。对象的创建控制权由程序自身转移到外部（容器），这种思想称为控制反转。
对象的创建权由程序员主动创建转移到容器(由容器创建、管理对象)。这个容器称为：IOC容器或Spring容器
依赖注入： Dependency Injection，简称DI。容器为应用程序提供运行时，所依赖的资源，称之为依赖注入。
程序运行时需要某个资源，此时容器就为其提供这个资源。
例：EmpController程序运行时需要EmpService对象，Spring容器就为其提供并注入EmpService对象

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

课堂作业

🚩 能够流利的说出软件设计原则，并且说出解耦的思路中涉及的2个概念

3.3 IOC&DI入门 🍐

IOC&DI入门

任务：完成Controller层、Service层、Dao层的代码解耦

控制反转： Inversion Of Control，简称IOC。对象的创建控制权由程序自身转移到外部（容器），这种思想称为控制反转。
对象的创建权由程序员主动创建转移到容器(由容器创建、管理对象)。这个容器称为：IOC容器或Spring容器

注解：@Component 👈 ❤️

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

依赖注入： Dependency Injection，简称DI。容器为应用程序提供运行时，所依赖的资源，称之为依赖注入。
程序运行时需要某个资源，此时容器就为其提供这个资源。
例：EmpController程序运行时需要EmpService对象，Spring容器就为其提供并注入EmpService对象

注解： @Autowired 👈 ❤️

代码操作步骤

删除Controller层、Service层中new对象的代码
Service层及Dao层的实现类，交给IOC容器管理
为Controller及Service注入运行时依赖的对象
- Controller程序中注入依赖的Service层对象
- Service程序中注入依赖的Dao层对象

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

**Controller层代码：**👇

@RestController
public class EmpController {

    @Autowired //运行时,从IOC容器中获取该类型对象,赋值给该变量
    private EmpService empService ;

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

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

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

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

Service层代码： 👇

@Component //将当前对象交给IOC容器管理,成为IOC容器的bean
public class EmpServiceA implements EmpService {

    @Autowired //运行时,从IOC容器中获取该类型对象,赋值给该变量
    private EmpDao empDao ;

    @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;
    }
}

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

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

**Dao层代码：**👇

@Component //将当前对象交给IOC容器管理,成为IOC容器的bean
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;
    }
}

作业

🚩 能说出@Component和@Autowired这2个注解的作用！

3.4 IOC详解 🍐

IOC详解

目标：学习IOC控制反转和DI依赖注入的细节

前面我们提到IOC控制反转，就是将对象的控制权交给Spring的IOC容器，由IOC容器创建及管理对象。IOC容器创建的对象称为bean对象。

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

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

@Controller （标注在控制层类上）
@Service （标注在业务层类上）
@Repository （标注在数据访问层类上）

点击查看代码图解open in new window 👈

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

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

1.点击查看注解源码open in new window 👈

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

2. 点击查看代码图解open in new window 👈

注意事项:
声明bean的时候，可以通过value属性指定bean的名字，如果没有指定，默认为类名首字母小写。
使用以上四个注解都可以声明bean，但是在springboot集成web开发中，声明控制器bean只能用@Controller。

1.使用前面学习的四个注解声明的bean，一定会生效吗？

不一定。（原因：bean想要生效，还需要被组件扫描）

下面我们通过修改项目工程的目录结构，来测试bean对象是否生效：

运行程序后，报错：

为什么没有找到bean对象呢？

使用四大注解声明的bean，要想生效，还需要被组件扫描注解@ComponentScan扫描

@ComponentScan注解虽然没有显式配置，但是实际上已经包含在了引导类声明注解 @SpringBootApplication 中，默认扫描的范围是SpringBoot启动类所在包及其子包。
image-20221204224643683

解决方案：手动添加@ComponentScan注解，指定要扫描的包（仅做了解，不推荐）

推荐做法（如下图）：

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

课堂作业

🚩 1. 能流利的说出@Component的衍生注解的作用？以及默认Bean的名字是什么？

🚩 2. 使用@Component注解声明的bean，一定会生效吗？

3.5 DI详解

前言

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

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

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

入门程序举例：在EmpController运行的时候，就要到IOC容器当中去查找EmpService这个类型的对象，而我们的IOC容器中刚好有一个EmpService这个类型的对象，所以就找到了这个类型的对象完成注入操作。

如何解决上述问题呢？Spring提供了以下几种解决方案：

@Primary
@Qualifier
@Resource

1️⃣ 使用@Primary注解：当存在多个相同类型的Bean注入时，加上@Primary注解，来确定默认的实现。

2️⃣ 使用@Qualifier注解：指定当前要注入的bean对象。在@Qualifier的value属性中，指定注入的bean的名称。

@Qualifier注解不能单独使用，必须配合@Autowired使用

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

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

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

课堂作业

🚩 1. 请流利的说出 @Autowird 与 @Resource的区别

SpringBootWeb请求响应 ​

今日目标 ​

前言 🍐 ​

1. 请求 🍐 ❤️ ​

1.1 Postman ✏️ 🔧 ​

1.1.1 介绍 ​

1.2 简单参数❤️ ​

1.2.1 原始方式 ​

1.2.2 SpringBoot方式 非常实用 ​

1.2.3 参数名不一致 ⚠️ ​

1.3 实体参数🍐 🚀 ​

1.3.1 简单实体对象 ​

1.3.2 复杂实体对象 ​

1.4 数组集合参数 ❤️ ✏️ ​

1.4.1 数组 ​

1.4.2 集合 ​

1.5 日期参数 ✏️ ​

1.6 JSON参数 ❤️ ✏️ ​

1️⃣ Postman发送JSON格式数据： ​

2️⃣ 服务端Controller方法接收JSON格式数据： ​

1.7 路径参数 ❤️ ✏️ ​

2. 响应 🍐 ​

2.1 @ResponseBody ​

2.2 统一响应结果 🍐 ❤️ ​

2.3 案例 ✏️ ❤️ ​

2.3.1 需求说明 ​

2.3.2 准备工作 ​

2.3.3 实现步骤 ​

2.3.4 代码实现和测试 ​

2.3.6 问题分析 ​

3. 分层解耦 ​

3.1 三层架构 🍐 ​

3.2 分层解耦 🍐❤️ ​

解耦思路 👇 ​

3.3 IOC&DI入门 🍐 ​

3.4 IOC详解 🍐 ​

3.5 DI详解 ​

1️⃣ 使用@Primary注解：当存在多个相同类型的Bean注入时，加上@Primary注解，来确定默认的实现。 ​

2️⃣ 使用@Qualifier注解：指定当前要注入的bean对象。 在@Qualifier的value属性中，指定注入的bean的名称。 ​

3️⃣ 使用@Resource注解：是按照bean的名称进行注入。通过name属性指定要注入的bean的名称。 ​

SpringBootWeb请求响应

今日目标

前言 🍐

1. 请求 🍐 ❤️

1.1 Postman ✏️ 🔧

1.1.1 介绍

1.2 简单参数❤️

1.2.1 原始方式

1.2.2 SpringBoot方式非常实用

1.2.3 参数名不一致 ⚠️

1.3 实体参数🍐 🚀

1.3.1 简单实体对象

1.3.2 复杂实体对象

1.4 数组集合参数 ❤️ ✏️

1.4.1 数组

1.4.2 集合

1.5 日期参数 ✏️

1.6 JSON参数 ❤️ ✏️

1️⃣ Postman发送JSON格式数据：

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

1.7 路径参数 ❤️ ✏️

2. 响应 🍐

2.1 @ResponseBody

2.2 统一响应结果 🍐 ❤️

2.3 案例 ✏️ ❤️

2.3.1 需求说明

2.3.2 准备工作

2.3.3 实现步骤

2.3.4 代码实现和测试

2.3.6 问题分析

3. 分层解耦

3.1 三层架构 🍐

3.2 分层解耦 🍐❤️

解耦思路 👇

3.3 IOC&DI入门 🍐

3.4 IOC详解 🍐

3.5 DI详解

1️⃣ 使用@Primary注解：当存在多个相同类型的Bean注入时，加上@Primary注解，来确定默认的实现。

2️⃣ 使用@Qualifier注解：指定当前要注入的bean对象。在@Qualifier的value属性中，指定注入的bean的名称。

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