目录
2.3 案例:获取员工数据,返回统一响应结果,在页面渲染展示
问题:我们要声明一个Bean可以通过这四个注解,这四个注解声明的Bean就一定会生效吗?
提问:那如果在IOC容器中,存在多个相同类型的bean对象,会出现什么情况呢?
前面介绍到在Web应用程序的请求响应的整个流程当中,我们需要重点关注的就是Controller程序,而Controller程序的核心职责就是接收请求,然后设置响应。
前面我们学习过HTTP协议的交互方式:请求响应模式(有请求就有响应)。
那么Controller程序呢,除了接收请求外,还可以进行响应。
学习完请求参数的接收{接收请求参数},接下来进入到设置响应数据。
1. @ResponseBody
前面所编写的所有Controller方法当中,我们都已经设置了响应数据,比如浏览器地址栏发起一个请求之后,会请求到Controller程序当中的请求处理方法,即Controller方法,在Controller方法当中最终return返回了一个字符串,而这个返回值就会作为响应数据直接响应给客户端浏览器,那其实这些都需要依赖一个比较核心的注解:@ResponseBody。
controller方法中的return的结果,怎么就可以响应给浏览器呢?
- 答案:使用@ResponseBody注解
- @ResponseBody注解可以作用在Controller方法上,也可以作用在Controller类上,它的主要作用就是将方法的返回值直接作为响应数据响应给客户端浏览器,而如果方法的返回值是一个对象或者是一个集合,它会先将这个对象或者是集合转为JSON格式的数据,然后再响应给客户端浏览器。
@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它是两个注解的组合注解,一个是@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当中主要封装了两个注解,一个是@Controller,另一个是@ResponseBody。
- 一旦在类上面加了@RestController注解 或@ResponseBody注解,就代表当前类下所有的方法它的返回值都会作为响应数据,而如果方法的返回值是一个POJO实体类对象或者是一个集合,它会先将这个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;
}
}
- 这个Hello World~字符串是在响应体当中返回回去的。
- 直接将这个字符串作为响应体的内容响应回来。
在服务端响应了一个对象或者集合,那前端获取到的数据是什么样子的呢?
我们使用postman发送请求来测试下。测试效果如下:
- 集合它会转化成JSON格式的数组,外层是一对[ ]代表它是一个数组,里面每一对大括号{}代表的是一个对象。
2. 统一响应结果
我们在Controller程序当中所定义的每一个对外暴露的方法,我们都称之为一个功能接口。
- @RequestMapping注解上面的这个("\xxxxx")路径就是这个接口的访问路径。
- 比如上面的这个方法,它就是用来获取一个地址信息,它就是一个功能接口,而下面的这个方法,就是用来获取所有的地址列表信息,那它也是一个功能接口。
- 而项目开发当中所需要的开发文档就是来描述这个功能接口它的请求路径是什么,它的请求参数是什么,以及它响应的数据是什么。
- 我们会发现我们所编写的这些Controller方法中每一个接口响应回去的数据很随意,想怎么返回就怎么返回,没有任何的规范而言,如果我们开发的是一个大型项目,所涉及到的功能可能成百上千甚至成千上万,如果没有一套统一的项目规范,前端人员发起请求之后访问到我们所开发的这个接口,最终我们响应回去的数据各式各样的都有,那此时前端人员就需要拿到这个结果进行解析,并且需要针对不同的响应数据使用不同的解析方式来解析,那这个时候前后端开发的成本就会增加,最终导致我们的项目不方便管理而且很难维护。
如果我们开发一个大型项目,项目中controller方法将成千上万,使用上述方式将造成整个项目难以维护。那在真实的项目开发中是什么样子的呢?
- 所以在项目开发当中,我们一般都会给所有的功能接口设置一个统一的响应结果。
- 既然是一个统一的响应结果,那这个结果就需要做到通用性,基本上要能够满足所有的业务场景。
- 在真实的项目开发中,无论是哪种方法,我们都会定义一个统一的返回结果。方案如下:
- 前端:只需要按照统一格式的返回结果进行解析(仅一种解析方案),就可以拿到数据。
- Result统一响应结果类
这个统一的响应结果我们可以考虑使用一个实体类 / 对象Result来进行接收,里面主要包含三个属性:
- 第一个是Integer类型的code,代表的是响应码,我们可以和前端进行一个约定,1就代表成功,0就代表失败。
- 第二个是一个字符串类型的提示信息。
- 第三个部分是返回的数据,它的类型是Object,特别是对于一些查询的请求,它是需要返回查询的数据的,我们就可以将查询的数据封装在data这个属性当中,这样,我们在Controller方法当中返回这样一个Result对象,最终经过@ResponseBody的处理之后,就会响应这么一个JSON格式的数据。
- 既然是统一的响应结果,也就意味着所有的Controller方法,都要返回一个Result对象,最终前端拿到的就只是这一种格式的数据,它只需要根据这一种格式来进行解析就可以了(仅一种解析方案)。
- 这样使得我们的项目的管理以及项目的维护就会更加容易,更加方便。
- 统一响应结果指的是不管你执行的是什么样的业务操作,最终我们响应给前端的数据格式只有一种是统一的,便于项目的管理以及维护。
定义在一个实体类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测试:
总结:
- 不管是哪个方法,最终响应给前端的数据格式是统一固定的,有了统一的响应结果之后,我们的项目就会变得更加容易管理,容易维护。
- 统一响应结果指的是不管你执行的是增删改查什么样的业务操作,最终,我们响应给前端的数据格式只有一种是统一的,便于项目的管理以及维护。
2.3 案例:获取员工数据,返回统一响应结果,在页面渲染展示
通过一个案例,来加强对请求响应的学习。
2.3.1 需求说明
需求:加载并解析xml文件中的数据,完成数据处理,并在页面展示
- 获取员工数据,返回统一响应结果,在页面渲染展示
2.3.2 准备工作
案例准备:
-
XML文件
-
已经准备好(emp.xml),直接导入进来,放在 src/main/resources目录下
-
-
工具类
-
已经准备好解析XML文件的工具类,无需自己实现
-
直接在创建一个包 com.itheima.utils ,然后将工具类拷贝进来
-
-
前端页面资源
-
已经准备好,直接拷贝进来,放在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下。
- Java目录下只存放java代码
- resources这个目录下存放的是一些其他的资源文件
对于SpringBoot项目来说,我们是可以在项目当中来添加前端页面的,但是它的存储目录是有规范的,默认情况下SpringBoot项目的这些前端静态页面要存放在以下三个目录下:
- classpath下的static目录:classpath指的是类路径,对于Maven项目来说,这个resources目录就是一个类路径,所以可以存放在resources这个下面的static目录下。
- 第二个目录,classpath下的public目录:也就是说可以在resources下面再建一个目录就叫public来存放前端页面。
- classpath下面的resources目录:也就是说可以在resources目录下再来建一个目录,就叫resources来存放。
- 我们推荐使用static目录,因为我们基于SpringBoot官方骨架创建出来的项目,static目录已经自动给我们创建好了,这个目录并不需要我们创建。
- static目录就是用来存储前端静态页面的。
我们就需要编写一个Controller程序,然后在里面定义一个方法,在方法当中来处理请求,设置响应数据。
2.3.3 实现步骤
1. 在pom.xml文件中引入dom4j的依赖,用于解析XML文件
<dependency>
<groupId>org.dom4j</groupId>
<artifactId>dom4j</artifactId>
<version>2.1.3</version>
</dependency>
2. 引入资料中提供的:解析XML的工具类XMLParserUtils、实体类Emp、XML文件emp.xml
3. 引入资料中提供的静态页面文件,放在resources下的static目录下
4. 创建EmpController类,编写Controller程序,处理请求,响应数据
2.3.4 代码实现
Controller代码:
package com.gch.controller;
import com.gch.pojo.Emp;
import com.gch.pojo.Result;
import com.gch.utils.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") // @RequestMapping来指定这个方法的请求路径
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);
}
}
2.3.5 测试
代码编写完毕之后,我们就可以运行引导类,启动服务进行测试了。
使用Postman测试:
打开浏览器,在浏览器地址栏输入: http://localhost:8080/emp.html
2.3.6 问题分析
上述案例的功能,我们虽然已经实现,但是呢,我们会发现案例中:解析XML数据,获取数据的代码,处理数据的逻辑的代码,给页面响应数据的代码全部都堆积在一起了,全部都写在controller方法中了。
当前程序的这个业务逻辑还是比较简单的,如果业务逻辑再稍微复杂一点,我们会看到Controller方法的代码量就很大了。
-
当我们要修改操作数据部分的代码,需要改动Controller
-
当我们要完善逻辑处理部分的代码,需要改动Controller
-
当我们需要修改数据响应的代码,还是需要改动Controller
这样呢,就会造成我们整个工程代码的复用性比较差,而且代码难以维护。 那如何解决这个问题呢?其实在现在的开发中,有非常成熟的解决思路,那就是分层开发。
3. 分层解耦
分层解耦的思想
Spring当中的解决方案:要讲解Spring当中非常重要的两块知识:一个是IOC控制反转,一个是DI依赖注入。
然后再对IOC、DI进行详细的讲解
3.1 三层架构
3.1.1 介绍{单一职责原则} => 获取数据、处理数据、响应数据
- 解析XML文件获取数据的代码,也就是数据访问或者数据操作的代码
- 对我们解析后的数据进行转换处理的代码,也就是逻辑处理的代码
- 接收请求以及响应数据的代码
- 这三部分代码全部都写在Controller这一个方法当中了,而我们在进行软件设计以及软件开发的时候,需要尽量让每一个接口、类或者是方法,它的职责更加单一。
- 也就是说,一个类或者是一个方法,它就只做一件事情,就只管一块功能,这就是所谓的单一职责原则。这样就能够使我们的接口、类以及方法的复杂度更低,可读性更强,扩展性更好,也更利于后期的维护。
我们之前开发的程序呢,并不满足单一职责原则。下面我们来分析下之前的程序:
那其实我们上述案例的处理逻辑呢,从组成上看可以分为三个部分:
-
数据访问:负责业务数据的维护操作,包括增、删、改、查等操作。
-
逻辑处理:负责业务逻辑处理的代码。
-
请求处理、响应数据:负责,接收页面的请求,给页面响应数据。
按照上述的三个组成部分,在我们项目开发中呢,可以将代码分为三层(web开发的三层架构):
- Controller:控制层 / 表示层{接收并处理请求、响应数据}。也就是我们前面所编写的Controller 程序,所以这个Controller我们也叫控制器。接收前端发送的请求,对请求进行处 理,并响应数据。
- Service:业务逻辑层。处理具体的业务逻辑。
- Dao:数据访问层(Data Access Object),也称为持久层。负责数据访问操作,包括数据的增、 删、改、查。
基于三层架构的程序执行流程:
-
前端发起的请求,由Controller层接收(Controller响应数据给前端)
-
Controller层接收到请求之后调用Service层来进行逻辑处理,而逻辑处理的前提是你得先拿到数据(Service层处理完后,把处理结果返回给Controller层)
-
Serivce层调用Dao层(逻辑处理过程中需要用到的一些数据要从Dao层获取)
-
Dao层操作文件中的数据(Dao拿到的数据后会返回给Service层)
-
Service层拿到数据之后再进行逻辑的处理,再将逻辑处理之后的结果再返回给Controller层
-
Controller层再来响应数据给前端
- 这样就能够使我们的接口、类以及方法的复杂度更低,可读性更强,扩展性更好,也更利于后期的维护。
思考:按照三层架构的思想,如何要对业务逻辑(Service层)进行变更,会影响到Controller层 和Dao层吗?
答案:不会影响。 (程序的扩展性、维护性变得更好了)
3.1.2 代码拆分
分析:
Dao层的代码最终是要被Service层调用的,而数据访问Dao层的实现方式可能有很多:
- 比如我们访问的可能是文件当中的数据
- 也可能访问的是数据库当中的数据
- 也有可能访问的是别人给我们提供的一个接口获取到的数据。
Dao层实现的方式有很多,而我们要想能够灵活的去切换这各种实现,我们在se阶段学习过,可以通过面向接口的方式进行编程,所以,在编写Dao层的具体实现之前,我先需要定一个Dao的接口,来增强程序的灵活性以及拓展性。
我们使用三层架构思想,来改造下之前的程序:
-
控制层包名:com.xxx.controller
-
业务逻辑层包名:com.xxx.service
-
数据访问层包名:com.xxx.dao
数据访问层 / 持久层(Dao层):负责数据的访问操作,包含数据的增、删、改、查
- 数据访问接口
package com.gch.dao;
import com.gch.pojo.Emp;
import java.util.List;
/**
数据访问层接口(制定标准)
*/
public interface EmpDao {
/**
获取员工列表数据
*/
public List<Emp> listEmp();
}
-
数据访问实现类
package com.gch.dao.impl;
import com.gch.dao.EmpDao;
import com.gch.pojo.Emp;
import com.gch.utils.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;
}
}
业务逻辑层(Service层):处理具体的业务逻辑
- 业务接口
package com.gch.service;
import com.gch.pojo.Emp;
import java.util.List;
/**
业务逻辑接口(制定业务标准)
*/
public interface EmpService {
/**
获取员工列表
*/
public List<Emp> listEmp();
}
-
业务实现类
package com.gch.service.impl;
import com.gch.dao.EmpDao;
import com.gch.dao.impl.EmpDaoA;
import com.gch.pojo.Emp;
import com.gch.service.EmpService;
import java.util.List;
/**
业务逻辑实现类(按照业务标准实现)
*/
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;
}
}
控制层(Controller层):接收前端发送的请求,对请求进行处理,并响应数据
package com.gch.controller;
import com.gch.pojo.Emp;
import com.gch.pojo.Result;
import com.gch.service.EmpService;
import com.gch.service.impl.EmpServiceA;
import com.gch.utils.XmlParserUtils;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class EmpController {
// 面向接口编程
// 业务层对象
private EmpService empService = new EmpServiceA();
@RequestMapping("/listEmp") // @RequestMapping来指定这个方法的请求路径
public Result list(){
// 1.调用Service,获取数据
List<Emp> empList = empService.listEmp();
// 3.响应数据
return Result.success(empList);
}
}
![](https://i-blog.csdnimg.cn/blog_migrate/d54d21117a8bd3e2946aea32ae752d13.png)
三层架构的好处:
-
复用性强
-
可读性强
-
便于维护
-
利用扩展
3.2 分层解耦
刚才我们学习过程序分层思想了,接下来呢,我们来学习下程序的解耦思想。
解耦:解除耦合。 解耦的意思就是解除耦合
3.2.1 耦合问题
首先需要了解软件开发涉及到的两个概念:内聚和耦合。
-
内聚:软件中各个功能模块内部的功能联系。
-
耦合:衡量软件中各个层/模块之间的依赖、关联的程度。
软件设计原则:高内聚低耦合
- 高内聚指的是:一个模块中各个元素之间的联系的紧密程度,如果各个元素(语句、程序段)之间的联系程度越高,则内聚性越高,即 "高内聚"。
- 低耦合指的是:软件中各个层/模块之间的依赖关联程度越低越好。
- 这个类的内聚程序比较高,也叫高内聚
- 依赖程度越高,耦合度就越高
- 所谓高内聚指的是模块内部的功能联系越紧密越好。
- 低耦合指的就是尽可能地去降低层与层之间或者模块与模块之间的依赖关联,最好是能够做到解除耦合,解除耦合之后,层与层之间就没有依赖了。这样使得我们程序的灵活性及可扩展性就更好了。
程序中高内聚的体现:
-
EmpServiceA类中只编写了和员工相关的逻辑处理代码
程序中耦合代码的体现:
-
把业务类变为EmpServiceB时,需要修改controller层中的代码
-
Controller层与Service层之间的代码耦合了。
高内聚、低耦合的目的是使程序模块的可重用性、移植性大大增强。
3.2.2 解耦思路
之前我们在编写代码时,需要什么对象,就直接new一个就可以了。 这种做法呢,层与层之间代码就耦合了,当service层的实现变了之后, 我们还需要修改controller层的代码。
那应该怎么解耦呢?
注意:如果把new对象这一块代码直接删掉,那么去运行方法的时候是会报错的,原因是因为你 声明了这样一个变量,但是这个变量没有复制,那它的值就是null,在运行的时候就会报 空指针异常。
此时,就存在另一个问题了,不能new,就意味着没有业务层对象(程序运行就报错),怎么办呢?
- 实现解耦:首先第一步要把new实现类对象这一块儿的代码直接删掉。
-
首先不能在EmpController中使用new对象。代码如下:
-
我们的解决思路是:
-
提供一个容器,容器中存储一些对象(例:EmpService对象)
-
容器就是用来存东西的,那这里我们可以去存储一些对象。
-
controller程序从容器中获取EmpService类型的对象
-
使用容器来完成解耦存在两个问题:
- 这个对象怎么样来交给这个容器来管理
- 容器怎么样为我们的程序提供它所依赖的这个资源
我们想要实现上述解耦操作,就涉及到Spring中的两个核心概念(Spring当中非常重要的两个概念):
- 一个叫控制反转:Inversion Of Control,简称IOC
- 一个叫依赖注入:Dependency Injection,简称DI
控制反转: Inversion Of Control,简称IOC。对象的创建控制权由程序自身转移到外部(容 器),这种思想称为控制反转。--- 把new对象的权限从开发者手中交给了Spring框 架。
- 对象的创建控制权由程序员主动创建转移到容器(由容器创建、管理对象)。这个容器称 为:IOC容器或Spring容器。
- IOC控制反转是Spring框架的第一大核心。
- 控制反转指的是对象创建的控制权由应用程序转移到了外部容器当中。原来在应用程 序当中我需要什么对象,我直接new什么对象,而现在不是了,现在是把所有对象都 交给了容器来管理,这个就叫做控制反转。反转之前是由应用程序自身来控制对象的 创建,反转之后是由容器来控制,而这个容器,我们也叫IOC容器或者叫Spring容器。
-
依赖注入:Dependency Injection,简称DI。容器为应用程序提供运行时所依赖的资源, 称之为依赖注入。
程序运行时需要某个资源,此时容器就为其提供这个资源。
例:EmpController程序运行时需要EmpService对象,Spring容器就为其提供并注入 EmpService对象
- Bean对象:IOC/Spring容器中创建、管理的对象,称之为:bean对象。
3.3 IOC&DI
上面我们引出了Spring中IOC和DI的基本概念,下面我们就来具体学习下IOC和DI的代码实现。
通过IOC以及DI来完成分层解耦的具体实现
3.3.1 IOC&DI入门
任务:完成Controller层、Service层、Dao层的代码解耦
-
思路:
-
删除Controller层、Service层中new对象的代码
-
Service层及Dao层的实现类,交给IOC容器管理
-
为Controller及Service注入运行时依赖的对象
-
Controller程序中注入依赖的Service层对象
-
Service程序中注入依赖的Dao层对象
-
-
第1步:删除Controller层、Service层中new对象的代码
第2步:Service层及Dao层的实现类,交给IOC容器管理
- 要想将实现类对象交给IOC容器来管理,需要使用Spring当中提供的注解:@Component,在实现类上面添加该注解,就可以将实现类对象交给IOC容器管理,这样就完成了控制反转的操作。
第3步:为Controller及Service注入运行时依赖的对象
- 注入运行时所需要依赖的对象,IOC容器就需要为其提供这个类型的Bean对象,我们只需要在这个成员变量加上一个注解@Autowired,这样就完成了依赖注入的操作。
- 加上@Autowired,程序在运行的时候,IOC容器就会自动的为其提供该类型的bean对象并且赋值给该变量。
-
使用Spring提供的注解:@Autowired ,就可以实现程序运行时IOC容器自动注入需要的依赖对象
完整的三层代码:
-
Controller层:
package com.gch.controller;
import com.gch.pojo.Emp;
import com.gch.pojo.Result;
import com.gch.service.EmpService;
import com.gch.service.impl.EmpServiceA;
import com.gch.utils.XmlParserUtils;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.List;
@RestController
public class EmpController {
// 面向接口编程
// 业务层对象
@Autowired // 代表程序在运行时,IOC容器会提供该类型的bean对象,并赋值给该变量 --- 依赖注入
private EmpService empService;
@RequestMapping("/listEmp") // @RequestMapping来指定这个方法的请求路径
public Result list(){
// 1.调用Service,获取数据
List<Emp> empList = empService.listEmp();
// 3.响应数据
return Result.success(empList);
}
}
-
Service层:
package com.gch.service.impl;
import com.gch.dao.EmpDao;
import com.gch.dao.impl.EmpDaoA;
import com.gch.pojo.Emp;
import com.gch.service.EmpService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import java.util.List;
/**
业务逻辑实现类(按照业务标准实现)
*/
@Component // 代表将当前类交给IOC容器管理,成为IOC容器中的bean
public class EmpServiceA implements EmpService {
// Dao层对象
@Autowired // 代表程序在运行时,IOC容器会提供该类型的bean对象,并赋值给该变量 --- 依赖注入
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;
}
}
-
Dao层:
package com.gch.dao.impl;
import com.gch.dao.EmpDao;
import com.gch.pojo.Emp;
import com.gch.utils.XmlParserUtils;
import org.springframework.stereotype.Component;
import java.util.List;
/**
数据访问实现类
*/
@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;
}
}
运行测试:
- 启动SpringBoot引导类,打开浏览器,输入:http://localhost:8080/emp.html
3.3.2 IOC详解
通过IOC和DI的入门程序呢,我们已经基本了解了IOC和DI的基础操作。
接下来呢,我们学习下IOC控制反转和DI依赖注入的细节。
3.3.2.1 bean的声明
IOC控制反转:所谓IOC控制反转指的就是将创建对象/new对象的控制权交给Spring的IOC容器, 由IOC容器来创建及管理这些对象,而IOC容器当中的创建的这些对象也称为Bean 对象。
在之前的入门案例中,要把某个类对象交给IOC容器管理,需要在类上添加一个注解:@Component ,我们直接在类上加了一个注解@Component,就可以来声明一个Bean对象。
在Spring框架当中,除了这个@Component注解以外,Spring框架为了更好的标识Web应用程序开发当中,bean对象到底归属于哪一层,又提供了@Component的三个衍生注解:
-
@Controller (标注在控制层类上)用来标识Controller层的Bean对象,将一个类标记为Spring Web MVC控制器
-
@Service (标注在业务层类上)用来标识Service层的Bean对象
-
@Repository (标注在数据访问层类上)用来标识Dao层的Bean对象
- 这三个注解分别用来标识Controller层的Bean对象、Service层的Bean对象、Dao层的Bean对象。
- 在Web程序的开发当中,推荐使用这三个衍生注解来标识Controller层、Service层以及Dao层的Bean对象。
问题:那这个@Component注解现在什么时候会用呢?
回答:如果在项目开发当中,某一个类你不能归到这三层里面,我们还想将这个类交给IOC容器 管理,我们就可以使用@Component注解。最典型的就是一些工具类。
注意:在Controller程序当中我们不用加@Controller注解,因为@RestController是@Response Body注解和@Controller注解的组合注解,所以我们之前所开发的Controller程序其实已经交给了IOC容器管理,所以@Controller注解我们就不用再加了。
看源码会发现,@Controller、@Service、@Repository底层其实就封装了一个注解:@Compoment,上面三个是元注解,所以我们把@Controller、@Service、@Repository注解叫做@Component注解的衍生注解。
- 注意看这三个注解的源码当中有个value属性,可以用来指定一个Bean的名字。
现在我们声明一个Bean就可以通过四个注解来声明。
要把某个类对象交给IOC容器管理,需要在对应的类上加上如下注解之一:
注解 | 说明 | 位置 |
---|---|---|
@Controller | @Component的衍生注解 | 标注在控制器类上 |
@Service | @Component的衍生注解 | 标注在业务类上 |
@Repository | @Component的衍生注解 | 标注在数据访问类上(由于与mybatis整合,用的少) |
@Component | 声明bean的基础注解 | 不属于以上三类时,用此注解 |
注:@Repository注解我们以后很少会用,因为在后面讲解MyBatis框架之后,会通过另外一个 注解来替代。
修改入门案例代码:
-
Controller层:
package com.gch.controller;
@RestController
public class EmpController {
// 面向接口编程
// 业务层对象
@Autowired // 代表程序在运行时,IOC容器会提供该类型的bean对象,并赋值给该变量 --- 依赖注入
private EmpService empService;
@RequestMapping("/listEmp") // @RequestMapping来指定这个方法的请求路径
public Result list(){
// 1.调用Service,获取数据
List<Emp> empList = empService.listEmp();
// 3.响应数据
return Result.success(empList);
}
}
- Service层:
package com.gch.service.impl;
import java.util.List;
/**
业务逻辑实现类(按照业务标准实现)
*/
//@Component // 代表将当前类交给IOC容器管理,成为IOC容器中的bean
@Service
public class EmpServiceA implements EmpService {
// Dao层对象
@Autowired // 代表程序在运行时,IOC容器会提供该类型的bean对象,并赋值给该变量 --- 依赖注入
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;
}
}
- Dao层:
package com.gch.dao.impl;
import java.util.List;
/**
数据访问实现类
*/
//@Component // 代表将当前类交给IOC容器管理,成为IOC容器中的bean
@Repository
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;
}
}
- 在IOC容器当中,每一个Bean它都有一个标识,也就是Bean的名字。
- 在声明Bean的时候,我们可以通过注解当中的value属性来指定一个Bean的名字。
- 如果我们没有指定value属性,这个Bean也是有名字的,默认它的名字是类名首字母小写。
注意:如果是value属性,属性名可以忽略,可写可不写。
在IOC容器中,每一个Bean都有一个属于自己的名字,可以通过注解的value属性指定bean的名字。如果没有指定,默认为类名首字母小写。
我们直接打开控制台,在IDEA当中给我们提供的有这样一个面板,叫做Actuator / Endpoints,点击进来第一栏有个Beans,展示的就是当前这个应用下所有的Bean对象,点击application,右侧就展示出来了很多的Bean对象,这里我们只看白色背景的,就是我们自己定义的,点击某一个Bean对象,右侧展示就是这个Bean的名字。
Bean的名字我们一般不用指定,就采用默认值即可。
注意事项:
-
声明bean的时候,可以通过value属性指定bean的名字,如果没有指定,默认Bean的名字为类名首字母小写。
-
使用以上四个注解都可以声明bean,但是在springboot集成web开发中,声明控制器bean只能用@Controller注解。
3.3.2.2 组件扫描
问题:我们要声明一个Bean可以通过这四个注解,这四个注解声明的Bean就一定会生效吗?
- 其实不一定,还涉及到一个Bean的组件扫描问题。
- bean想要生效,还需要被组件扫描。
下面我们通过修改项目工程的目录结构,来测试bean对象是否生效:
运行程序后,报错:
为什么没有找到bean对象呢?
-
使用四大注解声明的bean,要想生效,还需要被组件扫描注解@ComponentScan扫描。
- @ComponentScan注解是Spring框架当中提供的,用来扫描上面的四个注解的
- @ComponentScan注解虽然没有显式的配置,但是在我们创建的Spring Boot项目当中,在启动类当中已经自动的加了一个注解:@SpringBootApplication,在这个注解当中就已经包含了@ComponentScan的功能,而且它默认扫描的范围是启动类所在包及其子包。
- 点击看@SpringBootApplication的源码:在@SpringBootApplication的源码当中就已经包含了@ComponentScan注解。
总结:@SpringBootApplication具有包扫描作用,默认扫描当前包及其子包。这就要求我们在开发SpringBoot项目的时候,我们需要把我们的代码放在启动类所在包以及它的子包下面。
@ComponentScan注解虽然没有显式配置,但是实际上已经包含在了启动类 / 引导类声明注解 @SpringBootApplication 中,默认扫描的范围是SpringBoot启动类所在包及其子包:
解决方案:手动添加@ComponentScan注解,指定要扫描的包 (==仅做了解,不推荐==)
- 通过属性来指定要扫描哪个包,可以通过两个属性,一个是value属性,一个是basePackage
- 从源码当中可以看到这两个属性它的类型都是一个数组
- 一旦显示的声明了@ComponentScan注解,就相当于把默认扫描的这个操作已经覆盖掉了。
推荐做法(如下图):
-
将我们定义的controller,service,dao这些包,都放在启动类 / 引导类所在包com.xxx的子包下,这样SpringBoot项目在启动的时候我们定义的bean对象就会被自动的扫描到。
3.3.3 DI详解
上一小节我们讲解了控制反转IOC的细节,接下来呢,我们学习依赖注解DI的细节。
DI依赖注入:是指IOC容器要为应用程序去提供运行时所依赖的资源,而资源指的就是对象。
在入门程序案例中,我们使用了@Autowired这个注解,完成了依赖注入的操作,而这个Autowired翻译过来叫:自动装配。
@Autowired注解,默认是按照类型进行自动装配的(去IOC容器中找某个类型的对象,然后完成注入操作),也就是说要去IOC容器当中去找这个类型的Bean对象,然后完成注入。
入门程序举例:在EmpController运行的时候,就要到IOC容器当中去查找EmpService这个类型的对象,而我们的IOC容器中刚好有一个EmpService这个类型的对象,所以就找到了这个类型的对象完成注入操作。
提问:那如果在IOC容器中,存在多个相同类型的bean对象,会出现什么情况呢?
现在EmpService的Bean对象就有了两个,一个是EmpServiceA,一个是EmpServiceB,现在程序 运行的时候到底注入的是A还是B呢?
-
启动应用,程序运行会报错
如何解决上述问题呢?Spring提供了以下几种解决方案:
@Primary{主要,首要的} --- Spring框架提供的
@Qualifier{修饰符} --- Spring框架提供的
@Resource --- JDK提供提供的
1. 通过@Primary注解来设置Bean的优先级,我们要想让哪个Bean生效,我们就可以在哪个 Bean上面再加上一个注解@Primary。
使用@Primary注解:当存在多个相同类型的Bean注入时,在类上加上@Primary注解,来确 定默认的实现。
2. 使用@Qualifier注解:指定当前要注入的bean对象。
- 在@Qualifier的value属性中,指定注入的bean的名称。
- 通过@Autowired注解配合着@Qualifier注解来指定我们要注入的是哪个Bean。只需要在 @Autowired注解上面再加上一个注解@Qualifier,然后在里面可以去指定一个属性,就是这个value属性,这个value属性就是用来指定Bean的名字,指定当前要注入的Bean对象。
-
@Qualifier注解不能单独使用,必须配合@Autowired使用。
-
注:@Qualifier注解也是Spring框架当中提供的。
-
@Autowired + @Qualifier("bean的名称")
3. 使用@Resource注解:此时就不要使用@Autowired这个注解来注入了,使用另外一种注入形 式:@Resource注解来指定我要注入的是哪个Bean,@Resource注解是按照bean的名称进 行注入,通过name属性指定要注入的bean的名称。
- @Autowired注解默认是按照类型进行注入的,而@Resource注解是按照名称进行注入的。
- @Resource(name = "bean的名称")
注:@Autowired注解与@Qualifier注解都是Spring框架当中提供的,而@Resource注解是 JDK提供的。
面试题 : @Autowird 与 @Resource的区别
-
@Autowired 是Spring框架提供的注解,而@Resource是JDK提供的注解
-
@Autowired 默认是按照类型注入,而@Resource是按照名称注入