SpringBootWeb请求-响应
HTTP请求
前后端分离
在这种模式下，前端技术人员基于"接口文档"，开发前端程序；后端技术人员也基于"接口文档"，开发后端程序。
由于前后端分离，对我们后端技术人员来讲，在开发过程中，是没有前端页面的，那我们怎么测试自己所开发的程序呢？
方式1：像之前SpringBoot入门案例中一样，直接使用浏览器。在浏览器中输入地址，测试后端程序。
-
弊端：在浏览器地址栏中输入地址这种方式都是GET请求，如何我们要用到POST请求怎么办呢？
-
要解决POST请求，需要程序员自己编写前端代码（比较麻烦）
-
方式2：使用专业的接口测试工具（课程中我们使用Postman工具）
Postman是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。
Postman原是Chrome浏览器的插件，可以模拟浏览器向后端服务器发起任何形式(如:get、post)的HTTP请求
使用Postman还可以在发起请求时，携带一些请求参数、请求头等信息
简单参数
简单参数：在向服务器发起请求时，向服务器传递的是一些普通的请求数据。
后端程序如何接收前端传过来的参数
1.原始方式
在原始的Web程序当中，需要通过Servlet中提供的API：HttpServletRequest（请求对象），获取请求的相关信息。比如获取请求参数：
Tomcat接收到http请求时：把请求的相关信息封装到HttpServletRequest对象中
在Controller中，我们要想获取Request对象，可以直接在方法的形参中声明 HttpServletRequest 对象。然后就可以通过该对象来获取请求信息：
@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.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方法中的形参名保持一致==，就可以获取到请求参数中的数据值。
参数名不一致
如果方法形参名称与请求参数名称不一致，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），代表该请求参数必须传递，如果不传递将报错
如果该参数是可选的，可以将required属性设置为false
@RequestMapping("/simpleParam")
public String simpleParam(@RequestParam(name = "name", required = false) String username, Integer age){
System.out.println(username+ ":" + age);
return "OK";
}
实体参数
在使用简单参数做为数据传递方式时，前端传递了多少个请求参数，后端controller方法中的形参就要书写多少个。如果请求参数比较多，通过上述的方式一个参数一个参数的接收，会比较繁琐。
此时，我们可以考虑将请求参数封装到一个实体类对象中。 要想完成数据封装，需要遵守如下规则：请求参数名与实体类的属性名相同
@RestController
public class RequestController {
//实体参数：简单实体对象
@RequestMapping("/simplePojo")
public String simplePojo(User user){
System.out.println(user);
return "OK";
}
}
复杂实体对象
复杂实体对象指的是，在实体类中有一个或多个属性，也是实体对象类型的。如下：
-
User类中有一个Address类型的属性（Address是一个实体类）
复杂实体对象的封装，需要遵守如下规则：
-
请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套实体类属性参数。
@RestController
public class RequestController {
//实体参数：复杂实体对象
@RequestMapping("/complexPojo")
public String complexPojo(User user){
System.out.println(user);
return "OK";
}
}
数组集合参数
数组
数组集合参数的使用场景：在HTML的表单中，有一个表单项是支持多选的(复选框)，可以提交选择的多个值。
数组参数：请求参数名与形参数组名称相同且请求参数为多个，定义数组类型形参即可接收参数
@RestController
public class RequestController {
//数组集合参数
@RequestMapping("/arrayParam")
public String arrayParam(String[] hobby){
System.out.println(Arrays.toString(hobby));
return "OK";
}
}在前端请求时，有两种传递形式：
方式一： xxxxxxxxxx?hobby=game&hobby=java
方式二：xxxxxxxxxxxxx?hobby=game,java
集合
集合参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam 绑定参数关系
默认情况下，请求中参数名相同的多个值，是封装到数组。如果要封装到集合，要使用@RequestParam绑定参数关系
@RestController
public class RequestController {
//数组集合参数
@RequestMapping("/listParam")
public String listParam(@RequestParam List hobby){
System.out.println(hobby);
return "OK";
}
} 日期参数
在一些特殊的需求中，可能会涉及到日期类型数据的封装。
因为日期的格式多种多样（如：2022-12-12 10:05:45 、2022/12/12 10:05:45），那么对于日期类型的参数在进行封装的时候，需要通过@DateTimeFormat注解，以及其pattern属性来设置日期的格式。
-
@DateTimeFormat注解的pattern属性中指定了哪种日期格式，前端的日期参数就必须按照指定的格式传递。
-
后端controller方法中，需要使用Date类型或LocalDateTime类型，来封装传递的参数。
@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";
}
}JSON参数（post请求）
在前后端进行交互时，如果是比较复杂的参数，前后端通过会使用JSON格式的数据进行传输。 （JSON是开发中最常用的前后端数据交互方式）
-
Postman在发送请求时，如何传递json格式的请求参数
-
在服务端的controller方法中，如何接收json格式的请求参数
-
传递json格式的参数，在Controller中会使用实体类进行封装。
-
封装规则：JSON数据键名与形参对象属性名相同，定义POJO类型形参即可接收参数。需要使用 @RequestBody标识。
-
@RequestBody注解：将JSON数据映射到形参的实体类对象中（JSON中的key和实体类中的属性名保持一致）
Post测试方法：
路径参数
-
前端：通过请求URL直接传递参数
-
后端：使用{…}来标识该路径参数，需要使用@PathVariable获取路径参数
@RestController
public class RequestController {
//路径参数
@RequestMapping("/path/{id}")
public String pathParam(@PathVariable Integer id){
System.out.println(id);
return "OK";
}
}
传递多个路径参数
@RestController
public class RequestController {
//路径参数
@RequestMapping("/path/{id}/{name}")
public String pathParam2(@PathVariable Integer id, @PathVariable String name){
System.out.println(id+ " : " +name);
return "OK";
}
}响应
@ResponseBody注解：
-
类型：方法注解、类注解
-
位置：书写在Controller方法上或类上
-
作用：将方法返回值直接响应给浏览器
- 如果返回值类型是实体对象/集合，将会转换为JSON格式后在响应给浏览器
在类上添加的@RestController注解，是一个组合注解。
-
@RestController = @Controller + @ResponseBody
@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格式，在响应给浏览器
-
统一响应结果
在真实的项目开发中，无论是哪种方法，我们都会定义一个统一的返回结果。方案如下：
前端：只需要按照统一格式的返回结果进行解析(仅一种解析方案)，就可以拿到数据。
统一的返回结果使用类来描述，在这个结果中包含：
-
响应状态码：当前请求是成功，还是失败
-
状态码信息：给页面的提示信息
-
返回的数据：给前端响应的数据（字符串、对象、集合）
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);
}
} //响应统一格式的结果
@RequestMapping("/listAddr")
public Result listAddr(){
List 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);
}
}
案例
需求：加载并解析xml文件中的数据，完成数据处理，并在页面展示
获取员工数据，返回统一响应结果，在页面渲染展示
在SpringBoot项目中，静态资源默认可以存放的目录：
-
classpath:/static/
-
classpath:/public/
-
classpath:/resources/
-
classpath:/META-INF/resources/
classpath：
-
代表的是类路径，在maven的项目中，其实指的就是 src/main/resources 或者 src/main/java，但是java目录是存放java代码的，所以相关的配置文件及静态资源文档，就放在 src/main/resources下。
1.在pom.xml文件中引入dom4j的依赖，用于解析XML文件
org.dom4j
dom4j
2.1.3
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 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);
}
}
分层解耦
在我们进行程序设计以及程序开发时，尽可能让每一个接口、类、方法的职责更单一些（单一职责原则）。
单一职责原则：一个类或一个方法，就只做一件事情，只管一块功能。
这样就可以让类、接口、方法的复杂度更低，可读性更强，扩展性更好，也更利用后期的维护。
我们之前开发的程序呢，并不满足单一职责原则。下面我们来分析下之前的程序：
那其实我们上述案例的处理逻辑呢，从组成上看可以分为三个部分：
-
数据访问：负责业务数据的维护操作，包括增、删、改、查等操作。
-
逻辑处理：负责业务逻辑处理的代码。
-
请求处理、响应数据：负责，接收页面的请求，给页面响应数据。
按照上述的三个组成部分，在我们项目开发中呢，可以将代码分为三层：
-
Controller：控制层。接收前端发送的请求，对请求进行处理，并响应数据。
-
Service：业务逻辑层。处理具体的业务逻辑。
-
Dao：数据访问层(Data Access Object)，也称为持久层。负责数据访问操作，包括数据的增、删、改、查。
基于三层架构的程序执行流程：
-
前端发起的请求，由Controller层接收（Controller响应数据给前端）
-
Controller层调用Service层来进行逻辑处理（Service层处理完后，把处理结果返回给Controller层）
-
Serivce层调用Dao层（逻辑处理过程中需要用到的一些数据要从Dao层获取）
-
Dao层操作文件中的数据（Dao拿到的数据会返回给Service层）
三层架构的好处：
-
复用性强
-
便于维护
-
利用扩展
控制反转： Inversion Of Control，简称IOC。对象的创建控制权由程序自身转移到外部（容器），这种思想称为控制反转。
对象的创建权由程序员主动创建转移到容器(由容器创建、管理对象)。这个容器称为：IOC容器或Spring容器
依赖注入： Dependency Injection，简称DI。容器为应用程序提供运行时，所依赖的资源，称之为依赖注入。
程序运行时需要某个资源，此时容器就为其提供这个资源。
例：EmpController程序运行时需要EmpService对象，Spring容器就为其提供并注入EmpService对象
IOC容器中创建、管理的对象，称之为：bean对象
第1步：删除Controller层、Service层中new对象的代码
第2步：Service层及Dao层的实现类，交给IOC容器管理
使用Spring提供的注解：@Component ，就可以实现类交给IOC容器管理
第3步：为Controller及Service注入运行时依赖的对象
使用Spring提供的注解：@Autowired ，就可以实现程序运行时IOC容器自动注入需要的依赖对象
IOC详解
IOC控制反转，就是将对象的控制权交给Spring的IOC容器，由IOC容器创建及管理对象。IOC容器创建的对象称为bean对象。
而Spring框架为了更好的标识web应用程序开发当中，bean对象到底归属于哪一层，又提供了@Component的衍生注解：
-
@RestController = @Controller + @ResponseBody （标注在控制层类上）
-
@Service （标注在业务层类上）
-
@Repository （标注在数据访问层类上）
要把某个对象交给IOC容器管理，需要在对应的类上加上如下注解之一：
| 注解 | 说明 | 位置 |
|---|---|---|
| @Controller | @Component的衍生注解 | 标注在控制器类上 |
| @Service | @Component的衍生注解 | 标注在业务类上 |
| @Repository | @Component的衍生注解 | 标注在数据访问类上（由于与mybatis整合，用的少） |
| @Component | 声明bean的基础注解 | 不属于以上三类时，用此注解 |
在IOC容器中，每一个Bean都有一个属于自己的名字，可以通过注解的value属性指定bean的名字。如果没有指定，默认为类名首字母小写。
注意事项:
-
声明bean的时候，可以通过value属性指定bean的名字，如果没有指定，默认为类名首字母小写。
-
使用以上四个注解都可以声明bean，但是在springboot集成web开发中，声明控制器bean只能用@Controller。
组件扫描
-
使用四大注解声明的bean，要想生效，还需要被组件扫描注解@ComponentScan扫描
@ComponentScan注解虽然没有显式配置，但是实际上已经包含在了引导类声明注解 @SpringBootApplicatio
n 中，==默认扫描的范围是SpringBoot启动类所在包及其子包==。
手动添加@ComponentScan注解，指定要扫描的包
DI详解
@Autowired注解，默认是按照类型进行自动装配的（去IOC容器中找某个类型的对象，然后完成注入操作）
使用@Primary注解：当存在多个相同类型的Bean注入时，加上@Primary注解，来确定默认的实现
使用@Qualifier注解：指定当前要注入的bean对象。 在@Qualifier的value属性中，指定注入的bean的名称。
@Qualifier注解不能单独使用，必须配合@Autowired使用
使用@Resource注解：是按照bean的名称进行注入。通过name属性指定要注入的bean的名称。
@Autowird 与 @Resource的区别
-
@Autowired 是spring框架提供的注解，而@Resource是JDK提供的注解
-
@Autowired 默认是按照类型注入，而@Resource是按照名称注入