目录
[一、 配置优先级](#一、 配置优先级)
[3.2.1 概述:](#3.2.1 概述:)
前言:
在当今快节奏的开发时代,Spring Boot 作为一款极具影响力的框架,彻底改变了 Java 应用的构建方式。它凭借简洁的配置、强大的功能,为开发者节省大量精力。然而,多数人忙于使用,对其底层原理却一知半解。此刻,让我们停下匆忙的脚步,一同深入这篇博客,去探究 Spring Boot 是如何施展魔法,从启动初始化到运行时的精妙管控,层层剖析,挖掘那些隐藏在便捷背后的技术奥秘。
配置优先级:Springboot项目当中属性配置的常见方式以及配置的优先级
Bean的管理
剖析Springboot的底层原理
**一、**配置优先级
在我们前面的课程当中,我们已经讲解了SpringBoot项目当中支持的三类配置文件:
application.properties
application.yml
application.yaml
在SpringBoot项目当中,我们要想配置一个属性,可以通过这三种方式当中的任意一种来配置都可以,那么如果项目中同时存在这三种配置文件,且都配置了同一个属性,如:Tomcat端口号,到底哪一份配置文件生效呢?
aplication.propertiesp
java
server.port=8081
application.yml
java
server:
port: 8082
application.yaml
java
server:
port: 8082
我们启动SpringBoot程序,测试下三个配置文件中哪个Tomcat端口号生效:
properties、yaml、yml三种配置文件,优先级最高的是properties
yaml 、 yml 两种配置文件同时存在的情况
配置文件优先级排名(从高到低):
1. properties配置文件
2. yml配置文件
3. yaml配置文件
注意事项:虽然springboot支持多种格式配置文件,但是在项目开发时,推荐统一使用一种格式的配置。(yml是主流)
在SpringBoot项目当中除了以上3种配置文件外,SpringBoot为了增强程序的扩展性,除了支持配置
文件的配置方式以外,还支持另外两种常见的配置方式:
Java系统属性配置 (格式: -Dkey=value)
命令行参数 (格式:--key=value)
那在idea当中运行程序时,如何来指定Java系统属性和命令行参数呢?
编辑启动程序的配置信息
重启服务,同时配置 Tomcat 端口 ( 三种配置文件、系统属性、命令行参数 ) ,测试哪个 Tomcat 端口号生效:
优先级: 命令行参数 > 系统属性参数 > properties参数 > yml参数 > yaml参数
思考:如果项目已经打包上线了,这个时候我们又如何来设置Java系统属性和命令行参数呢?
java
1 java -Dserver.port=9000 -jar XXXXX.jar --server.port=10010
下面我们来演示下打包程序运行时指定Java系统属性和命令行参数:
- 执行maven打包指令package,把项目打成jar文件
- 使用命令:java -jar 方式运行jar文件程序
![](https://i-blog.csdnimg.cn/direct/5d737cba0b3e41cc87d434ae2aa5079b.png)
![](https://i-blog.csdnimg.cn/direct/b4c82cd52c5e441a9ad8016850ce1eaf.png)
运行jar程序:
同时设置Java系统属性和命令行参数
![](https://i-blog.csdnimg.cn/direct/d9aaff1117a9432194a8ceb09ed285a2.png)
仅设置Java系统属性
![](https://i-blog.csdnimg.cn/direct/2e4fa1242a3a45b0a7ba437a96c2326b.png)
Springboot项目进行打包时,需要引入插件 spring-boot-maven-plugin (基于官网骨架创建项目,会自动添加该插件)
在SpringBoot项目当中,常见的属性配置方式有5种, 3种配置文件,加上2种外部属性的配置(Java
系统属性、命令行参数)。通过以上的测试,我们也得出了优先级(从低到高):
application.yaml(忽略)
application.yml
application.properties
java系统属性(-Dxxx=xxx)
命令行参数(--xxx=xxx)
二、Bean 管理
在前面的课程当中,我们已经讲过了我们可以通过Spring当中提供的注解@Component以及它的三个衍生注解(@Controller、@Service、@Repository)来声明IOC容器中的bean对象,同时我们也学习了如何为应用程序注入运行时所需要依赖的bean对象,也就是依赖注入DI。
我们今天主要学习IOC容器中Bean的其他使用细节,主要学习以下三方面:
- 如何从IOC容器中手动的获取到bean对象
- bean的作用域配置
- 管理第三方的bean对象
接下来我们先来学习第一方面,从IOC容器中获取bean对象。
2.1:获取 Bean
默认情况下,SpringBoot项目在启动的时候会自动的创建IOC容器(也称为Spring容器),并且在启动的过程当中会自动的将bean对象都创建好,存放在IOC容器当中。应用程序在运行时需要依赖什么bean对象,就直接进行依赖注入就可以了。
而在Spring容器中提供了一些方法,可以主动从IOC容器中获取到bean对象,下面介绍3种常用方式:
1、根据name获取bean
java
1 Object getBean(String name)
- 根据类型获取bean
java
1 <T> T getBean(Class<T> requiredType)
根据name获取bean(带类型转换)
java
1 <T> T getBean(String name, Class<T> requiredType)
思考:要从IOC容器当中来获取到bean对象,需要先拿到IOC容器对象,怎么样才能拿到IOC容器呢?
想获取到IOC容器,直接将IOC容器对象注入进来就可以了
控制器:DeptController
![](https://i-blog.csdnimg.cn/direct/6808070b714e4f1ab16d61a78050e569.png)
业务实现类:DeptServiceImpl
![](https://i-blog.csdnimg.cn/direct/6cd4ed9b6fe440439f8a0f0e344a7cf2.png)
Mapper接口:
![](https://i-blog.csdnimg.cn/direct/3bdeaeaab02b4e4e9bb253705f18a8bf.png)
测试类
![](https://i-blog.csdnimg.cn/direct/4960ffcacc474cc193cdcd988e1a8c4c.png)
2.2:Bean 作用域
在前面我们提到的IOC容器当中,默认bean对象是单例模式(只有一个实例对象)。那么如何设置bean对象为非单例呢?需要设置bean的作用域。
在Spring中支持五种作用域,后三种在web环境才生效:
![](https://i-blog.csdnimg.cn/direct/41ebd3cdd76147f08ceaef6875d59fc4.png)
2.3:第三方 Bean
学习完bean的获取、bean的作用域之后,接下来我们再来学习第三方bean的配置。
之前我们所配置的bean,像controller、service,dao三层体系下编写的类,这些类都是我们在项目当中自己定义的类(自定义类)。当我们要声明这些bean,也非常简单,我们只需要在类上加上 @Component以及它的这三个衍生注解(@Controller、@Service、@Repository),就可以来声明这个bean对象了。
但是在我们项目开发当中,还有一种情况就是这个类它不是我们自己编写的,而是我们引入的第三方依赖当中提供的。
在pom.xml文件中,引入dom4j:
![](https://i-blog.csdnimg.cn/direct/55e66e6715ce442a9186b99c9eb0ea67.png)
三、Springboot底层原理
3.1:起步依赖
假如我们没有使用 SpringBoot ,用的是 Spring 框架进行 web 程序的开发,此时我们就需要引入 web 程序开发所需要的一些依赖。
spring-webmvc依赖:这是Spring框架进行web程序开发所需要的依赖
servlet-api依赖:Servlet基础依赖
jackson-databind依赖:JSON处理工具包
如果要使用AOP,还需要引入aop依赖、aspect依赖
项目中所引入的这些依赖,还需要保证版本匹配,否则就可能会出现版本冲突问题。
如果我们使用了SpringBoot,就不需要像上面这么繁琐的引入依赖了。我们只需要引入一个依赖就可以了,那就是web开发的起步依赖:springboot-starter-web。
3.1.1:maven的依赖传递:
假设a依赖了b,b依赖了c,c依赖了d,只需要引入a依赖,b,c,d依赖就都引入进来了
![](https://i-blog.csdnimg.cn/direct/300ce09772a248029745e07c71933ac8.png)
为什么我们只需要引入一个web开发的起步依赖,web开发所需要的所有的依赖都有了呢?
因为Maven的依赖传递。
在SpringBoot给我们提供的这些起步依赖当中,已提供了当前程序开发所需要的所有的常
见依赖(官网地址:https://docs.spring.io/spring-boot/docs/2.7.7/referen
ce/htmlsingle/#using.build-systems.starters)。
比如:springboot-starter-web,这是web开发的起步依赖,在web开发的起步依赖当
中,就集成了web开发中常见的依赖:json、web、webmvc、tomcat等。我们只需要引入
这一个起步依赖,其他的依赖都会自动的通过Maven的依赖传递进来。
结论:起步依赖的原理就是Maven的依赖传递。
3.2:自动配置(重点):
springboot原理就是自动配置的原理
3.2.1****概述:
SpringBoot的自动配置就是当Spring容器启动后,一些配置类、bean对象就自动存入到了IOC容器
中,不需要我们手动去声明,从而简化了开发,省去了繁琐的配置操作。
比如:我们要进行事务管理、要进行AOP 程序的开发,此时就不需要我们再去手动的声明这些bean对象了,我们直接使用就可以从而大大的简化程序的开发,省去了繁琐的配置操作。
下面我们打开idea,一起来看下自动配置的效果:
运行SpringBoot启动类:
我们会发现,出现了很多没有见过的bean对象,也被加载进来了,这些就是springboot的自动配置的bean对象。
![](https://i-blog.csdnimg.cn/direct/e7aa8b2b7d0d49df87a51106b985eaf8.png)
大家会看到有两个CommonConfig,在第一个CommonConfig类中定义了一个bean对象,bean对象的名字叫reader。
在第二个CommonConfig中它的bean名字叫commonConfig,为什么还会有这样一个bean对象呢?原因是在CommonConfig配置类上添加了一个注解**@Configuration** ,而**@Configuration** 底层就是**@Component**
![](https://i-blog.csdnimg.cn/direct/b7e3bced627d4cd695f15a069cb280ec.png)
所以配置类最终也是SpringIOC容器当中的一个bean对象
在IOC容器中除了我们自己定义的bean以外,还有很多配置类,这些配置类都是SpringBoot在启动的时候加载进来的配置类。这些配置类加载进来之后,它也会生成很多的bean对象。
![](https://i-blog.csdnimg.cn/direct/204cf30a0caf48d880784c95f3debd9d.png)
比如:配置类GsonAutoConfiguration里面有一个bean,bean的名字叫gson,它的类型是
Gson。
com.google.gson.Gson是谷歌包中提供的用来处理JSON格式数据的
3.2.2:常见方案
3.2.2.1: 概述
我们知道了什么是自动配置之后,接下来我们就要来剖析自动配置的原理。解析自动配置的原理就是分析在 SpringBoot项目当中,我们引入对应的依赖之后,是如何将依赖jar包当中所提供的bean以及配置类直接加载到当前项目的SpringIOC容器当中的。
接下来,我们就直接通过代码来分析自动配置原理。
准备工作:在Idea中导入"资料\03. 自动配置原理"下的itheima-utils工程
1、在SpringBoot项目 spring-boot-web-config2 工程中,通过坐标引入itheima-utils依赖
2、在测试类中,添加测试方法
![](https://i-blog.csdnimg.cn/direct/b3c6f61078674223873eaa2a79f78d89.png)
3、执行测试方法
![](https://i-blog.csdnimg.cn/direct/4d16086a119a46e08ff630fc4a83b0e6.png)
异常信息描述: 没有com.example.TokenParse类型的bean
说明:在Spring容器中没有找到com.example.TokenParse类型的bean对象
思考:引入进来的第三方依赖当中的bean以及配置类为什么没有生效?
原因在我们之前讲解IOC的时候有提到过,在类上添加@Component注解来声明bean对象时,还需要保证@Component注解能被Spring的组件扫描到。
SpringBoot项目中的@SpringBootApplication注解,具有包扫描的作用,但是它只会扫描启动类所在的当前包以及子包。
当前包:com.itheima, 第三方依赖中提供的包:com.example(扫描不到)
那么如何解决以上问题的呢?
方案1:@ComponentScan 组件扫描
方案2:@Import 导入(使用@Import导入的类会被Spring加载到IOC容器中)
3.2.2.2:方案一
@ComponentScan组件扫描
重新执行测试方法,控制台日志输出:
3.2.2.3:方案二
@Import导入
导入形式主要有以下几种:
- 导入普通类
- 导入ImportSelector接口实现类
- 导入配置类
1、导入普通类
![](https://i-blog.csdnimg.cn/direct/6e57071ab9bb4d428356cb44d56bfb21.png)
2、使用@Import导入配置类:
配置类
![](https://i-blog.csdnimg.cn/direct/74c5c5ac71054b6eb97add387c3b5dbe.png)
![](https://i-blog.csdnimg.cn/direct/60410f39d025482f9fa733b463a6bdea.png)
3、使用@Import导入ImportSelector接口实现类:
ImportSelector接口实现类
![](https://i-blog.csdnimg.cn/direct/43c50025ac044165b425dcd1777d03a9.png)
我们使用@Import注解通过这三种方式都可以导入第三方依赖中所提供的bean或者是配置类。
思考:如果基于以上方式完成自动配置,当要引入一个第三方依赖时,是不是还要知道第三方依赖中有哪些配置类和哪些Bean对象?
答案:是的。 (对程序员来讲,很不友好,而且比较繁琐)
思考:当我们要使用第三方依赖,依赖中到底有哪些bean和配置类,谁最清楚?
答案:第三方依赖自身最清楚。
怎么让第三方依赖自己指定bean对象和配置类?
比较常见的方案就是第三方依赖给我们提供一个注解,这个注解一般都以@EnableXxxx开头的注解,注解中封装的就是@Import注解
使用第三方依赖提供的 @EnableXxxxx注解
第三方依赖中提供的注解
![](https://i-blog.csdnimg.cn/direct/b71f8485397b4ea6a3593a78bf1e4940.png)
在使用时只需在启动类上加上@EnableXxxxx注解即可
![](https://i-blog.csdnimg.cn/direct/9a7da4a87cfc41da9e05593a88f29e3f.png)
以上四种方式都可以完成导入操作,但是第4种方式会更方便更优雅,而这种方式也是SpringBoot当中所采用的方式。
3.2.3:原理分析
源码跟踪
前面我们讲解了在项目当中引入第三方依赖之后,如何加载第三方依赖中定义好的bean对象以及配置类,从而完成自动配置操作。那下面我们通过源码跟踪的形式来剖析下SpringBoot底层到底是如何完成自动配置的。
源码跟踪技巧:
在跟踪框架源码的时候,一定要抓住关键点,找到核心流程。一定不要从头到尾一行代码去看,一个方法的去研究,一定要找到关键流程,抓住关键点,先在宏观上对整个流程或者整个原理有一个认识,有精力再去研究其中的细节。
要搞清楚SpringBoot的自动配置原理,要从SpringBoot启动类上使用的核心注解
@SpringBootApplication开始分析:
![](https://i-blog.csdnimg.cn/direct/d758204162aa4f5a9b2716c04dc51f32.png)
ConpoentScan 翻译:组件扫描
Configuration:配置
在@SpringBootApplication注解中包含了:
元注解(不再解释)
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
我们先来看第一个注解:@SpringBootConfiguration
![](https://i-blog.csdnimg.cn/direct/52ade92871df47ad9e27e4adda1b8917.png)
@SpringBootConfiguration注解上使用了@Configuration,表明SpringBoot启动类就是一个配置类。
@Indexed注解,是用来加速应用启动的(不用关心)。
接下来再先看@ComponentScan注解:
![](https://i-blog.csdnimg.cn/direct/1eeb41fb22ae42b4bf82d9e030537241.png)
@ComponentScan注解是用来进行组件扫描的,扫描启动类所在的包及其子包下所有被 @Component及其衍生注解声明的类。
SpringBoot启动类,之所以具备扫描包功能,就是因为包含了@ComponentScan注解。
最后我们来看看@EnableAutoConfiguration注解(自动配置核心注解):
![](https://i-blog.csdnimg.cn/direct/38a84587c12e43d28a9b76ee86cde91c.png)
使用@Import注解,导入了实现ImportSelector接口的实现类。
AutoConfigurationImportSelector类是ImportSelector接口的实现类。
AutoConfigurationImportSelector类中重写了ImportSelector接口的selectImports()方法:
![](https://i-blog.csdnimg.cn/direct/32c50ae880c54d39b74a2d653504f344.png)
selectImports()方法底层调用getAutoConfigurationEntry()方法,获取可自动配置的配置类信息集合
![](https://i-blog.csdnimg.cn/direct/4fa711cabc1e4046bb92337d82308ffd.png)
getAutoConfigurationEntry()方法通过调用 getCandidateConfigurations(annotationMetadata, attributes)方法获取在配置文件中配置的所有自动配置类的集合
![](https://i-blog.csdnimg.cn/direct/ef10411437bb4603bf4c8e139014d5fd.png)
getCandidateConfigurations方法的功能:
获取所有基于META- INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imp orts文件、META-INF/spring.factories文件中配置类的集合
META-
INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
文件和META-INF/spring.factories文件这两个文件在哪里呢?
通常在引入的起步依赖中,都有包含以上两个文件
![](https://i-blog.csdnimg.cn/direct/461ad89244b94a75b45e2fa84315e266.png)
![](https://i-blog.csdnimg.cn/direct/0a7b8efde8ce4e75b29403ca97a71205.png)
在前面在给大家演示自动配置的时候,我们直接在测试类当中注入了一个叫gson的bean对象,进行 JSON格式转换。虽然我们没有配置bean对象,但是我们是可以直接注入使用的。原因就是因为在自动配置类当中做了自动配置。到底是在哪个自动配置类当中做的自动配置呢?我们通过搜索来查询一下。
在META-
INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports
配置文件中指定了第三方依赖Gson的配置类:GsonAutoConfiguration
![](https://i-blog.csdnimg.cn/direct/ef1bc1a2c7794e3d8bc9df3d669f8b98.png)
第三方依赖中提供的GsonAutoConfiguration类:
在GsonAutoConfiguration类上,添加了注解@AutoConfiguration,通过查看源码,可以明确:GsonAutoConfiguration类是一个配置。
看到这里,大家就应该明白为什么可以完成自动配置了,原理就是在配置类中定义一个@Bean标识的方法,而Spring会自动调用配置类中使用@Bean标识的方法,并把方法的返回值注册到IOC容器中。
3.2.4:自动配置源码小结
自动配置原理源码入口就是@SpringBootApplication注解,在这个注解中封装了3个注解,分别是:
|------------------------------|------------------------------------------------------|
| @SpringBootConfiguration | 声明当前类是一个配置类 |
| @ComponentScan | 进行组件扫描(SpringBoot中默认扫描的是启动类所在的当前 |
| @EnableAutoConfiguration | 封装了@Import注解(Import注解中指定了一个ImportSelector接口的实现类) |
在实现类重写的selectImports()方法,读取当前项目下所有依赖jar包中META- INF/spring.factories、META-
INF/spring/org.springframework.boot.autoconfigure.AutoConfigurat ion.imports两个文件里面定义的配置类(配置类中定义了@Bean注解标识的方法)。
当SpringBoot程序启动时,就会加载配置文件当中所定义的配置类,并将这些配置类信息(类的全限定名)封装到String类型的数组中,最终通过@Import注解将这些配置类全部加载到Spring的IOC容器中,交给IOC容器管理。
最后呢给大家抛出一个问题:在META- INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imp orts文件中定义的配置类非常多,而且每个配置类中又可以定义很多的bean,那这些bean都会注册到Spring的IOC容器中吗?
答案:并不是。 在声明bean对象时,上面有加一个以@Conditional开头的注解,这种注解的作用就是按照条件进行装配,只有满足条件之后,才会将bean注册到Spring的IOC容器中(下面会详细来讲解)
@Conditional
我们在跟踪SpringBoot自动配置的源码的时候,在自动配置类声明bean的时候,除了在方法上加了一个@Bean注解以外,还会经常用到一个注解,就是以Conditional开头的这一类的注解。以 Conditional开头的这些注解都是条件装配的注解。下面我们就来介绍下条件装配注解。
@Conditional注解:
作用:按照一定的条件进行判断,在满足给定条件后才会注册对应的bean对象到Spring的IOC容器中。
位置:方法、类
@Conditional本身是一个父注解,派生出大量的子注解:@ConditionalOnClass:判断环境中有对应字节码文件,才注册bean到IOC容器。
@ConditionalOnMissingBean:判断环境中没有对应的bean(类型或名称),才注册 bean到 IOC容器。
@ConditionalOnProperty:判断配置文件中有对应属性和值,才注册bean到IOC容器。
下面我们通过代码来演示下Conditional注解的使用:
@ConditionalOnClass注解
![](https://i-blog.csdnimg.cn/direct/2f287168675241e58f90dc53c14bd1f7.png)
测试类:
![](https://i-blog.csdnimg.cn/direct/bfec1853cac84f38a5cfafe7b2d7360f.png)
@ConditionalOnMissingBean注解
![](https://i-blog.csdnimg.cn/direct/fe2ab16a4eab4496a103928f4786bafa.png)
再次修改@ConditionalOnMissingBean注解:
![](https://i-blog.csdnimg.cn/direct/5bae71f894ec4bd48225dfe69f5ea81c.png)
再次修改@ConditionalOnMissingBean注解:
![](https://i-blog.csdnimg.cn/direct/9acec07016504fbb8b3123b279402dcf.png)
@ConditionalOnProperty注解(这个注解和配置文件当中配置的属性有关系)
先在application.yml配置文件中添加如下的键值对:
![](https://i-blog.csdnimg.cn/direct/04ddfdbaefe94e50a25030614b3137ea.png)
修改@ConditionalOnProperty注解: havingValue的值修改为"itheima2"
![](https://i-blog.csdnimg.cn/direct/db10b896dc1040f0b98530b585972698.png)
我们再回头看看之前讲解SpringBoot源码时提到的一个配置类:GsonAutoConfiguration
![](https://i-blog.csdnimg.cn/direct/a422e5fd73e04946a87a5d3fa115c70b.png)
最后再给大家梳理一下自动配置原理:
![](https://i-blog.csdnimg.cn/direct/82ae7532e041468588d0b2e92a45e058.png)
自动配置的核心就在@SpringBootApplication注解上,SpringBootApplication这个注解底层包含了3个注解,分别是:
@SpringBootConfiguration
@ComponentScan
@EnableAutoConfiguration
@EnableAutoConfiguration这个注解才是自动配置的核心。
它封装了一个@Import注解,Import注解里面指定了一个ImportSelector接口的实现类。
在这个实现类中,重写了ImportSelector接口中的selectImports()方法。
而selectImports()方法中会去读取两份配置文件,并将配置文件中定义的配置类做为 selectImports()方法的返回值返回,返回值代表的就是需要将哪些类交给Spring的IOC容器进行管理。
那么所有自动配置类的中声明的bean都会加载到Spring的IOC容器中吗? 其实并不会,因为这些配置类中在声明bean时,通常都会添加@Conditional开头的注解,这个注解就是进行条件装配。而Spring会根据Conditional注解有选择性的进行bean的创建。
@Enable 开头的注解底层,它就封装了一个注解 import 注解,它里面指定了一个类,是 ImportSelector 接口的实现类。在实现类当中,我们需要去实现 ImportSelector 接口当中的一个方法 selectImports 这个方法。这个方法的返回值代表的就是我需要将哪些类交给 spring 的 IOC容器进行管理。
此时它会去读取两份配置文件,一份儿是 spring.factories,另外一份儿是 autoConfiguration.imports。而在 autoConfiguration.imports 这份儿文件当中,它就会去配置大量的自动配置的类。
而前面我们也提到过这些所有的自动配置类当中,所有的 bean都会加载到 spring 的 IOC 容器当中吗?其实并不会,因为这些配置类当中,在声明 bean 的时候,通常会加上这么一类@Conditional 开头的注解。这个注解就是进行条件装配。所以SpringBoot非常的智能,它会根据 @Conditional 注解来进行条件装配。只有条件成立,它才会声明这个bean,才会将这个 bean 交给 IOC 容器管理。
3.2.4:案例
3.2.4.1:自定义 starter 分析
前面我们解析了SpringBoot中自动配置的原理,下面我们就通过一个自定义starter案例来加深大家对于自动配置原理的理解。首先介绍一下自定义starter的业务场景,再来分析一下具体的操作步骤。
所谓starter指的就是SpringBoot当中的起步依赖。在SpringBoot当中已经给我们提供了很多的起步依赖了,我们为什么还需要自定义 starter 起步依赖?这是因为在实际的项目开发当中,我们可能会用到很多第三方的技术,并不是所有的第三方的技术官方都给我们提供了与SpringBoot整合的 starter起步依赖,但是这些技术又非常的通用,在很多项目组当中都在使用。
业务场景:
我们前面案例当中所使用的阿里云OSS对象存储服务,现在阿里云的官方是没有给我们提供对应的起步依赖的,这个时候使用起来就会比较繁琐,我们需要引入对应的依赖。我们还需要在配置文件当中进行配置,还需要基于官方SDK示例来改造对应的工具类,我们在项目当中才可以进行使用。
大家想在我们当前项目当中使用了阿里云OSS,我们需要进行这么多步的操作。在别的项目组当中要想使用阿里云OSS,是不是也需要进行这么多步的操作,所以这个时候我们就可以自定义一些公共组件,在这些公共组件当中,我就可以提前把需要配置的bean都提前配置好。将来在项目当
中,我要想使用这个技术,我直接将组件对应的坐标直接引入进来,就已经自动配置好了,就可以直接使用了。我们也可以把公共组件提供给别的项目组进行使用,这样就可以大大的简化我们的开发。
在SpringBoot项目中,一般都会将这些公共组件封装为SpringBoot当中的starter,也就是我们所说的起步依赖。
![](https://i-blog.csdnimg.cn/direct/c1f44b77f2a54bc1b6bedcd65d0ddcb0.png)
SpringBoot官方starter命名: spring-boot-starter-xxxx
第三组织提供的starter命名: xxxx-spring-boot-starter
![](https://i-blog.csdnimg.cn/direct/ed554e1b31e347a1a57780a68df33acf.png)
Mybatis提供了配置类,并且也提供了springboot会自动读取的配置文件。当SpringBoot项目启动时,会读取到spring.factories配置文件中的配置类并加载配置类,生成相关bean对象注册到IOC容器中。
结果:我们可以直接在SpringBoot程序中使用Mybatis自动配置的bean对象。
在自定义一个起步依赖starter的时候,按照规范需要定义两个模块:
starter模块(进行依赖管理[把程序开发所需要的依赖都定义在starter起步依赖中)
autoconfigure模块(自动配置)
将来在项目当中进行相关功能开发时,只需要引入一个起步依赖就可以了,因为它会将
autoconfigure自动配置的依赖给传递下来。
上面我们简单介绍了自定义starter的场景,以及自定义starter时涉及到的模块之后,接下来我们就来完成一个自定义starter的案例。
需求:自定义aliyun-oss-spring-boot-starter,完成阿里云OSS操作工具类AliyunOSSUtils的自动配置。
目标:引入起步依赖引入之后,要想使用阿里云OSS,注入AliyunOSSUtils直接使用即可。
之前阿里云OSS的使用:
配置文件
![](https://i-blog.csdnimg.cn/direct/1c40ed9b8fbe42bfac55cfc0f6405dc5.png)
![](https://i-blog.csdnimg.cn/direct/d9e4d097c392476498ea86520832c09c.png)
![](https://i-blog.csdnimg.cn/direct/7e9ddd96064a468396b22019a785401d.png)
当我们在项目当中要使用阿里云OSS,就可以注入AliOSSUtils工具类来进行文件上传。但这种方式其实是比较繁琐的。
大家再思考,现在我们使用阿里云OSS,需要做这么几步,将来大家在开发其他的项目的时候,你使用阿里云OSS,这几步你要不要做?当团队中其他小伙伴也在使用阿里云OSS的时候,步骤 不也是一样的。
所以这个时候我们就可以制作一个公共组件(自定义starter)。starter定义好之后,将来要使用阿里云OSS进行文件上传,只需要将起步依赖引入进来之后,就可以直接注入AliOSSUtils使用了。
需求明确了,接下来我们再来分析一下具体的实现步骤:
第1步:创建自定义starter模块(进行依赖管理)
把阿里云OSS所有的依赖统一管理起来
第2步:创建autoconfigure模块
在starter中引入autoconfigure (我们使用时只需要引入starter起步依赖即可)
第3步:在autoconfigure中完成自动配置
- 定义一个自动配置类,在自动配置类中将所要配置的bean都提前配置好
- 定义配置文件,把自动配置类的全类名定义在配置文件中
我们分析完自定义阿里云OSS自动配置的操作步骤了,下面我们就按照分析的步骤来实现自定义
starter。
-
-
-
- 自定义 starter 实现
-
-
自定义starter的步骤我们刚才已经分析了,接下来我们就按照分析的步骤来完成自定义starter的开发。
首先我们先来创建两个Maven模块:
- aliyun-oss-spring-boot-starter模块
![](https://i-blog.csdnimg.cn/direct/2f21ad2ee9204a0f8a10a3465640e0c7.png)
![](https://i-blog.csdnimg.cn/direct/152b4b4000cc4e67a58cb7668a64a1ac.png)
创建完starter模块后,删除多余的文件,最终保留内容如下:
![](https://i-blog.csdnimg.cn/direct/2be034c016bc4af78c72656c4e89e2e1.png)
删除pom.xml文件中多余的内容后:
![](https://i-blog.csdnimg.cn/direct/c3eb8acf75a14e7d9e62999fdb95cb35.png)
- aliyun-oss-spring-boot-autoconfigure模块
![](https://i-blog.csdnimg.cn/direct/73ba6623d10249cb831f4dc141fc2188.png)
![](https://i-blog.csdnimg.cn/direct/aba96027a9b54f17bd719d78919b9af2.png)
创建完starter模块后,删除多余的文件,最终保留内容如下:
删除pom.xml文件中多余的内容后:
![](https://i-blog.csdnimg.cn/direct/e9167f2f46d9465ea632da88a7425e5c.png)
按照我们之前的分析,是需要在starter模块中来引入autoconfigure这个模块的。打开starter模块中的pom文件:
![](https://i-blog.csdnimg.cn/direct/94fec54d17294043905929d1316748b6.png)
在autoconfigure模块当中来完成自动配置操作。
我们将之前案例中所使用的阿里云OSS部分的代码直接拷贝到autoconfigure模块下,然后进行改造就行了。
![](https://i-blog.csdnimg.cn/direct/dc5709fd0b1f4def81ca66d1fd721b7d.png)
拷贝过来后,还缺失一些相关的依赖,需要把相关依赖也拷贝过来:
![](https://i-blog.csdnimg.cn/direct/99f55e8741d4493783ad2322c4daa27b.png)
![](https://i-blog.csdnimg.cn/direct/8a74984cbb69406284ac79b9bc784489.png)
现在大家思考下,在类上添加的@Component注解还有用吗?
![](https://i-blog.csdnimg.cn/direct/377273e6b848424c8f2581d1ac91c50a.png)
答案:没用了。 在SpringBoot项目中,并不会去扫描com.aliyun.oss这个包,不扫描这个包那类上的注解也就失去了作用。
![](https://i-blog.csdnimg.cn/direct/64dd7b772d5947a0942418ae3ebf2b68.png)
下面我们就要定义一个自动配置类了,在自动配置类当中来声明AliOSSUtils的bean对象。
AliOSSAutoConfiguration类:
![](https://i-blog.csdnimg.cn/direct/4c4ca80e65e74372970f3f8083440391.png)
AliOSSProperties类:
![](https://i-blog.csdnimg.cn/direct/d4955ecb3ff3435b9b5051cce1fdf345.png)
AliOSSUtils类:
![](https://i-blog.csdnimg.cn/direct/810f10915e3d48be937296f371d8a1d1.png)
![](https://i-blog.csdnimg.cn/direct/a6efcbe9ab3d4927b9ad98b6970b72e2.png)
在aliyun-oss-spring-boot-autoconfigure模块中的resources下,新建自动配置文件:
META-
INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.impo rts
1 com.aliyun.oss.AliOSSAutoConfiguration
![](https://i-blog.csdnimg.cn/direct/e51a375256324219a5d99bf61b7a0cd3.png)
-
-
-
- 自定义 starter 测试
-
-
阿里云OSS的starter我们刚才已经定义好了,接下来我们就来做一个测试。
今天的课程资料当中,提供了一个自定义starter的测试工程。我们直接打开文件夹,里面有一个测试工程。测试工程就是springboot-autoconfiguration-test,我们只需要将测试工程直接导入到Idea当中即可。
![](https://i-blog.csdnimg.cn/direct/7747ceac36cd4e848e36119562a5912c.png)
测试前准备:
在test工程中引入阿里云starter依赖
通过依赖传递,会把autoconfigure依赖也引入了
![](https://i-blog.csdnimg.cn/direct/08503896676046fa837d31ab0540a8c3.png)
在test工程中的application.yml文件中,配置阿里云OSS配置参数信息(从以前的工程中拷贝即可)
![](https://i-blog.csdnimg.cn/direct/9c4c8006cda042f19d1c1162b19c13bc.png)
- 在test工程中的UploadController类编写代码
![](https://i-blog.csdnimg.cn/direct/986cba8f1d024ad1945c4d5e03c71e22.png)
编写完代码后,我们启动当前的SpringBoot测试工程:
随着SpringBoot项目启动,自动配置会把AliOSSUtils的bean对象装配到IOC容器中
![](https://i-blog.csdnimg.cn/direct/732f0a63aaab49d88af153273ecf4c20.png)
用postman工具进行文件上传:
![](https://i-blog.csdnimg.cn/direct/4daf6e6ca05e42a193772621de868718.png)
通过断点可以看到自动注入AliOSSUtils的bean对象:
![](https://i-blog.csdnimg.cn/direct/2aa571f1a61d451da4dfd33db2292cf0.png)
4.Web 后端开发总结
到此基于SpringBoot进行web后端开发的相关知识我们已经学习完毕了。下面我们一起针对这段web课程做一个总结。
我们来回顾一下关于web后端开发,我们都学习了哪些内容,以及每一块知识,具体是属于哪个框架的。
web后端开发现在基本上都是基于标准的三层架构进行开发的,在三层架构当中,Controller控制器层负责接收请求响应数据,Service业务层负责具体的业务逻辑处理,而Dao数据访问层也叫持久层,就是用来处理数据访问操作的,来完成数据库当中数据的增删改查操作。
![](https://i-blog.csdnimg.cn/direct/bc86b11f905444c992f5e6c9def338f3.png)
在三层架构当中,前端发起请求首先会到达Controller(不进行逻辑处理),然后Controller会直接调用Service 进行逻辑处理, Service再调用Dao完成数据访问操作。
如果我们在执行具体的业务处理之前,需要去做一些通用的业务处理,比如:我们要进行统一的登录校验,我们要进行统一的字符编码等这些操作时,我们就可以借助于Javaweb当中三大组件之一的过滤器 Filter或者是Spring当中提供的拦截器Interceptor来实现。
![](https://i-blog.csdnimg.cn/direct/a824dc2d85b8427e9819080d927db1f1.png)
而为了实现三层架构层与层之间的解耦,我们学习了Spring框架当中的第一大核心:IOC控制反转与DI依赖注入。
所谓控制反转,指的是将对象创建的控制权由应用程序自身交给外部容器,这个容器就是我们常说的IOC容器或Spring容器。
而DI依赖注入指的是容器为程序提供运行时所需要的资源。
除了IOC与DI我们还讲到了AOP面向切面编程,还有Spring中的事务管理、全局异常处理器,以及传递会话技术Cookie、Session以及新的会话跟踪解决方案JWT令牌,阿里云OSS对象存储服务,以及通过 Mybatis持久层架构操作数据库等技术。
![](https://i-blog.csdnimg.cn/direct/fe3715b69be640dcb6a28a9677757082.png)
我们在学习这些web后端开发技术的时候,我们都是基于主流的SpringBoot进行整合使用的。而 SpringBoot又是用来简化开发,提高开发效率的。像过滤器、拦截器、IOC、DI、AOP、事务管理等这些技术到底是哪个框架提供的核心功能?
![](https://i-blog.csdnimg.cn/direct/282769fb55b242499f8ab560fb895c47.png)
Filter过滤器、Cookie、 Session这些都是传统的JavaWeb提供的技术。 JWT令牌、阿里云OSS对象存储服务,是现在企业项目中常见的一些解决方案。
IOC控制反转、DI依赖注入、AOP面向切面编程、事务管理、全局异常处理、拦截器等,这些技术
都是 Spring Framework框架当中提供的核心功能。 Mybatis就是一个持久层的框架,是用来操作数据库的。
在Spring框架的生态中,对web程序开发提供了很好的支持,如:全局异常处理器、拦截器这些都是Spring框架中web开发模块所提供的功能,而Spring框架的web开发模块,我们也称为:SpringMVC
![](https://i-blog.csdnimg.cn/direct/6d2af2ed2e1d465495d75878ed6489db.png)
SpringMVC不是一个单独的框架,它是Spring框架的一部分,是Spring框架中的web开发模块,是用来简化原始的Servlet程序开发的。
外界俗称的SSM,就是由:SpringMVC、Spring Framework、Mybatis三块组成。
基于传统的SSM框架进行整合开发项目会比较繁琐,而且效率也比较低,所以在现在的企业项目开发当中,基本上都是直接基于SpringBoot整合SSM进行项目开发的。
结尾:
至此,我们已沿着 Spring Boot 的原理脉络游历一番,从依赖注入的巧思,到自动化配置的便捷,再到内嵌服务器的高效整合,无一不让人折服。希望这篇博客不仅为你答疑解惑,更如同一束光,照亮你后续深入学习、优化项目乃至自主创新的技术之路,愿你在编程的浩瀚星空中持续闪耀。