JavaWeb：SpingBoot原理 --黑马笔记

1. 配置优先级

在我们前面的课程当中，我们已经讲解了SpringBoot项目当中支持的三类配置文件：

application.properties

application.yml

application.yaml

在SpringBoot项目当中，我们要想配置一个属性，可以通过这三种方式当中的任意一种来配置都可 以，那么如果项目中同时存在这三种配置文件，且都配置了同一个属性，如：Tomcat端口号，到底哪一 份配置文件生效呢？

启动SpringBoot程序，测试，得出结论：

properties、yaml、yml三种配置文件同时存在，优先级最高的是properties。

yaml、yml两种配置文件同时存在，优先级最高的是yml配置文件。

配置文件优先级排名（从高到低）： 1. properties配置文件 2. yml配置文件 3. yaml配置文件

注意事项：虽然springboot支持多种格式配置文件，但是在项目开发时，推荐统一使用一种格式的配置。（yml是主流） 

在SpringBoot项目当中除了以上3种配置文件外，SpringBoot为了增强程序的扩展性，除了支持配置 文件的配置方式以外，还支持另外两种常见的配置方式：

1. Java系统属性配置 （格式： -Dkey=value）

-Dserver.port=9000

2. 命令行参数 （格式：--key=value）

--server.port=10010

那在idea当中运行程序时，如何来指定Java系统属性和命令行参数呢？

编辑启动程序的配置信息：

 

重启服务，同时配置Tomcat端口(三种配置文件、系统属性、命令行参数)，测试哪个Tomcat端口号生效： 

优先级： 命令行参数 > 系统属性参数 > properties参数 > yml参数 > yaml参数

思考：如果项目已经打包上线了，这个时候我们又如何来设置Java系统属性和命令行参数呢？

java -Dserver.port=9000 -jar XXXXX.jar --server.port=10010 

下面我们来演示下打包程序运行时指定Java系统属性和命令行参数：

1. 执行maven打包指令package，把项目打成jar文件

2. 使用命令：java -jar 方式运行jar文件程序

右击jar包进入到目录，在这一级目录下打开命令行，然后：

注意事项： Springboot项目进行打包时，需要引入插件 spring-boot-maven-plugin (基于官网骨架创建项目，会自动添加该插件)。

2. Bean管理

在前面的课程当中，我们已经讲过了我们可以通过Spring当中提供的注解@Component以及它的三个衍生注解（@Controller、@Service、@Repository）来声明IOC容器中的bean对象，同时我们也学 习了如何为应用程序注入运行时所需要依赖的bean对象，也就是依赖注入DI。

我们今天主要学习IOC容器中Bean的其他使用细节，主要学习以下三方面： 1. 如何从IOC容器中手动的获取到bean对象 2. bean的作用域配置 3. 管理第三方的bean对象

2.1 获取Bean

在Spring容器中提供了一些方法，可以主动从IOC容器中获取到bean对象，下面介绍3种常用方式：

1. 根据name获取bean

Object getBean(String name)

2. 根据类型获取bean

T getBean(Class requiredType)  

3. 根据name获取bean（带类型转换）

T getBean(String name, Class requiredType)  

 思考：要从IOC容器当中来获取到bean对象，需要先拿到IOC容器对象，怎么样才能拿到IOC容器呢？ 想获取到IOC容器，直接将IOC容器对象注入进来就可以了。

测试代码：

程序运行后控制台日志：

问题：输出的bean对象地址值是一样的，说明IOC容器当中的bean对象有几个？ 答案：只有一个。 （默认情况下，IOC中的bean对象是单例） 那么能不能将bean对象设置为非单例的(每次获取的bean都是一个新对象)？ 可以，在下一个知识点(bean作用域)中讲解。

注意事项：

【Spring项目启动时，会把其中的bean都创建好】还会受到作用域及延迟初始化影响，这里主要针对于默认的单例非延迟加载的bean而言。 

2.2 Bean作用域

在前面我们提到的IOC容器当中，默认bean对象是单例模式(只有一个实例对象)。那么如何设置bean 对象为非单例呢？需要设置bean的作用域。 在Spring中支持五种作用域，后三种在web环境才生效：

知道了bean的5种作用域了，我们要怎么去设置一个bean的作用域呢？

可以借助Spring中的@Scope注解来进行配置作用域。

测试一

控制器：

测试类：

重启SpringBoot服务，运行测试方法，查看控制台打印的日志：

注意事项： IOC容器中的bean默认使用的作用域：singleton (单例)

默认singleton的bean，在容器启动时被创建，可以使用@Lazy注解来延迟初始化(延迟到第一次使用时)

测试二

修改控制器DeptController代码：

重启SpringBoot服务，再次执行测试方法，查看控制台打印的日志：

注意事项： prototype的bean，每一次使用该bean的时候都会创建一个新的实例

实际开发当中，绝大部分的Bean是单例的，也就是说绝大部分Bean不需要配置scope属性。

2.3 第三方Bean

之前我们所配置的bean，像controller、service，dao三层体系下编写的类，这些类都是我们在项 目当中自己定义的类(自定义类)。当我们要声明这些bean，也非常简单，我们只需要在类上加上 @Component以及它的这三个衍生注解（@Controller、@Service、@Repository），就可以来声 明这个bean对象了。 但是在我们项目开发当中，还有一种情况就是这个类它不是我们自己编写的，而是我们引入的第三方依赖当中提供的。

在pom.xml文件中，引入dom4j：

org.dom4j
dom4j
2.1.3

dom4j就是第三方组织提供的。 dom4j中的SAXReader类就是第三方编写的。

当我们需要使用到SAXReader对象时，直接进行依赖注入是不是就可以了呢？

按照我们之前的做法，需要在SAXReader类上添加一个注解@Component（将当前类交给IOC容器 管理）

结果是：第三方提供的类是只读的。无法在第三方类上添加@Component注解或衍生注解。

那么我们应该怎样使用并定义第三方的bean呢？

如果要管理的bean对象来自于第三方（不是自定义的），是无法用@Component 及衍生注解声明 bean的，就需要用到@Bean注解。

解决方案1：在启动类上添加@Bean标识的方法

xml文件：

测试类：

重启SpringBoot服务，执行测试方法后，控制台输出日志：

Tom : 18

说明：以上在启动类中声明第三方Bean的作法，不建议使用（项目中要保证启动类的纯粹性）。

解决方案2：在配置类中定义@Bean标识的方法

如果需要定义第三方Bean时， 通常会单独定义一个配置类

注释掉SpringBoot启动类中创建第三方bean对象的代码，重启服务，执行测试方法，查看控制台日志：

Tom : 18

注意事项 ：

通过@Bean注解的name或value属性可以声明bean的名称，如果不指定，默认bean的名称就是方法名。 如果第三方bean需要依赖其它bean对象，直接在bean定义方法中设置形参即可，容器会根 据类型自动装配。 

关于Bean大家只需要保持一个原则：

如果是在项目当中我们自己定义的类，想将这些类交给IOC容器管理，我们直接使用@Component 以及它的衍生注解来声明就可以。

如果这个类它不是我们自己定义的，而是引入的第三方依赖当中提供的类，而且我们还想将这个类 交给IOC容器管理。此时我们就需要在配置类中定义一个方法，在方法上加上一个@Bean注解，通过这种方式来声明第三方的bean对象。

3. SpringBoot原理

Spring是目前世界上最流行的Java框架，它可以帮助我们更加快速、更加容易的来构建Java项目。而在Spring家族当中提供了很多优秀的框架，而所有的框架都是基于一个基础框架SpringFramework(也就是Spring框架)。而前面我们也提到，如果我们直接基于Spring框架进行项目的开发，会比较繁琐。

 这个繁琐主要体现在两个地方：

1. 在pom.xml中依赖配置比较繁琐，在项目开发时，需要自己去找到对应的依赖，还需要找到依赖 它所配套的依赖以及对应版本，否则就会出现版本冲突问题。

2. 在使用Spring框架进行项目开发时，需要在Spring的配置文件中做大量的配置，这就造成Spring框架入门难度较大，学习成本较高。

基于Spring存在的问题，官方在Spring框架4.0版本之后，又推出了一个全新的框架： SpringBoot。通过 SpringBoot来简化Spring框架的开发(是简化不是替代)。

我们直接基于SpringBoot来 构建Java项目，会让我们的项目开发更加简单，更加快捷。

 SpringBoot框架之所以使用起来更简单更快捷，是因为SpringBoot框架底层提供了两个非常重要的功能：一个是起步依赖，一个是自动配置。

通过SpringBoot所提供的起步依赖，就可以大大的简化pom文件当中依赖的配置，从而解决了 Spring框架当中依赖配置繁琐的问题。

通过自动配置的功能就可以大大的简化框架在使用时bean的声明以及bean的配置。我们只需要引入程序开发时所需要的起步依赖，项目开发时所用到常见的配置都已经有了，我们直接使用就可以了。

3.1 起步依赖

假如我们没有使用SpringBoot，用的是Spring框架进行web程序的开发，此时我们就需要引入web程序开发所需要的一些依赖。

spring-webmvc依赖：这是Spring框架进行web程序开发所需要的依赖

servlet-api依赖：Servlet基础依赖

jackson-databind依赖：JSON处理工具包

如果要使用AOP，还需要引入aop依赖、aspect依赖

项目中所引入的这些依赖，还需要保证版本匹配，否则就可能会出现版本冲突问题。

我们使用了SpringBoot，我们只需要引入一个依赖就可以了，那就是web开发的起步依赖：springboot-starter-web

为什么我们只需要引入一个web开发的起步依赖，web开发所需要的所有的依赖都有了呢？

因为Maven的依赖传递。

比如：springboot-starter-web，这是web开发的起步依赖，在web开发的起步依赖当中，就集成了web开发中常见的依赖：json、web、webmvc、tomcat等。我们只需要引入这一个起步依赖，其他的依赖都会自动的通过Maven的依赖传递进来。

结论：起步依赖的原理就是Maven的依赖传递。

3.2 自动配置

我们讲解了SpringBoot当中起步依赖的原理，就是Maven的依赖传递。接下来我们解析下自动配置的原理，我们要分析自动配置的原理，首先要知道什么是自动配置。

3.2.1 概述

SpringBoot的自动配置就是当Spring容器启动后，一些配置类、bean对象就自动存入到了IOC容器 中，不需要我们手动去声明，从而简化了开发，省去了繁琐的配置操作。

比如：我们要进行事务管理、要进行AOP程序的开发，此时就不需要我们再去手动的声明这些bean对象了，我们直接使用就可以从而大大的简化程序的开发，省去了繁琐的配置操作。

3.2.2 常见方案

3.2.2.1 概述

我们知道了什么是自动配置之后，接下来我们就要来剖析自动配置的原理。解析自动配置的原理就是分 析在 SpringBoot项目当中，我们引入对应的依赖之后，是如何将依赖jar包当中所提供的bean以及配置类直接加载到当前项目的SpringIOC容器当中的。

接下来，我们就直接通过代码来分析自动配置原理。

准备工作：导入itheima-utils工程

1、在SpringBoot项目 spring-boot-web-config2 工程中，通过坐标引入itheima-utils依赖

2、在测试类中，添加测试方法：

3、执行测试方法：

异常信息描述：没有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组件扫描

重新执行测试方法，控制台日志输出：

大家可以想象一下，如果采用以上这种方式来完成自动配置，那我们进行项目开发时，当需要引入大量的第三方的依赖，就需要在启动类上配置N多要扫描的包，这种方式会很繁琐。而且这种大面积的扫描性能也比较低。

缺点：

1. 使用繁琐

2. 性能低

结论：SpringBoot中并没有采用以上这种方案。

 3.2.2.3 方案二

@Import导入，导入形式主要有以下几种：

1. 导入普通类

2. 导入配置类

3. 导入ImportSelector接口实现类

使用@Import导入普通类：

使用@Import导入配置类：

配置类：

启动类：

测试类：

执行测试方法：

 

使用@Import导入ImportSelector接口实现类：

ImportSelector接口实现类：

启动类：

执行测试方法：

我们使用@Import注解通过这三种方式都可以导入第三方依赖中所提供的bean或者是配置类。

思考：如果基于以上方式完成自动配置，当要引入一个第三方依赖时，是不是还要知道第三方依赖中有哪些配置类和哪些Bean对象？

答案：是的。 （对程序员来讲，很不友好，而且比较繁琐）

思考：当我们要使用第三方依赖，依赖中到底有哪些bean和配置类，谁最清楚？ 答案：第三方依赖自身最清楚。

怎么让第三方依赖自己指定bean对象和配置类？

比较常见的方案就是第三方依赖给我们提供一个注解，这个注解一般都以@EnableXxxx开头的注 解，注解中封装的就是@Import注解

使用第三方依赖提供的 @EnableXxxxx注解

第三方依赖中提供的注解：

在使用时只需在启动类上加上@EnableXxxxx注解即可：

以上四种方式都可以完成导入操作，但是第4种方式会更方便更优雅，而这种方式也是SpringBoot当中所采用的方式。

3.2.3 原理分析

3.2.3.1 源码跟踪

那下面我们通过源码跟踪的形式来剖析下SpringBoot底层到底是如何完成自动配置的。

源码跟踪技巧： 在跟踪框架源码的时候，一定要抓住关键点，找到核心流程。一定不要从头到尾一行代码去看，一个方法的去研究，一定要找到关键流程，抓住关键点，先在宏观上对整个流程或者整个原理有一个认识，有精力再去研究其中的细节。

要搞清楚SpringBoot的自动配置原理，要从SpringBoot启动类上使用的核心注解 @SpringBootApplication开始分析：

在@SpringBootApplication注解中包含了：

我们先来看第一个注解：@SpringBootConfiguration：

@SpringBootConfiguration注解上使用了@Configuration，表明SpringBoot启动类就是 一个配置类。

@Indexed注解，是用来加速应用启动的（不用关心）。

接下来再先看@ComponentScan注解：

 @ComponentScan注解是用来进行组件扫描的，扫描启动类所在的包及其子包下所有被 @Component及其衍生注解声明的类。

SpringBoot启动类，之所以具备扫描包功能，就是因为包含了@ComponentScan注解。

 最后我们来看看@EnableAutoConfiguration注解（自动配置核心注解）：

使用@Import注解，导入了实现ImportSelector接口的实现类。

AutoConfigurationImportSelector类是ImportSelector接口的实现类：

AutoConfigurationImportSelector类中重写了ImportSelector接口的selectImports()方法：

selectImports()方法底层调用getAutoConfigurationEntry()方法，获取可自动配置的配置类信息集合：

getAutoConfigurationEntry()方法通过调用getCandidateConfigurations(annotationMetadata, attributes)方法获取在配置文件中配置的所有自动配置类的集合

getCandidateConfigurations方法的功能：

获取所有基于META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件、META-INF/spring.factories文件中配置类的集合 

META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件和META-INF/spring.factories文件这两个文件在哪里呢？ 

通常在引入的起步依赖中，都有包含以上两个文件：

看到这里，大家就应该明白为什么可以完成自动配置了，原理就是在配置类中定义一个@Bean标识的方法，而Spring会自动调用配置类中使用@Bean标识的方法，并把方法的返回值注册到IOC容器中。

自动配置源码小结

自动配置原理源码入口就是@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容器中（下面会详细来讲解）

3.2.3.2 @Conditional 

我们在跟踪SpringBoot自动配置的源码的时候，在自动配置类声明bean的时候，除了在方法上加了一 个@Bean注解以外，还会经常用到一个注解，就是以Conditional开头的这一类的注解。

以 Conditional开头的这些注解都是条件装配的注解。下面我们就来介绍下条件装配注解。 @Conditional注解：

作用：按照一定的条件进行判断，在满足给定条件后才会注册对应的bean对象到Spring的IOC容 器中。

位置：方法、类

@Conditional本身是一个父注解，派生出大量的子注解：

@ConditionalOnClass：判断环境中有对应字节码文件，才注册bean到IOC容器。 @ConditionalOnMissingBean：判断环境中没有对应的bean(类型或名称)，才注册 bean到IOC容器。

@ConditionalOnProperty：判断配置文件中有对应属性和值，才注册bean到IOC容器。

下面我们通过代码来演示下Conditional注解的使用：

@ConditionalOnClass注解

pom.xml：

io.jsonwebtoken
jjwt
0.9.1

测试类：

执行testHeaderParser()测试方法：

@ConditionalOnMissingBean同理。---可以没有形参，也可以有

@ConditionalOnMissingBean //不存在该类型的bean，才会将该bean加入IOC
容器

@ConditionalOnMissingBean(name="deptController2")//不存在指定名称
的bean，才会将该bean加入IOC容器

@ConditionalOnProperty注解（这个注解和配置文件当中配置的属性有关系）

先在application.yml配置文件中添加如下的键值对：

name: itheima

在声明bean的时候就可以指定一个条件@ConditionalOnProperty：

 

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，也就是我们所说的起步依赖。

SpringBoot官方starter命名： spring-boot-starter-xxxx

第三组织提供的starter命名： xxxx-spring-boot-starter

在自定义一个起步依赖starter的时候，按照规范需要定义两个模块：

1. starter模块（进行依赖管理[把程序开发所需要的依赖都定义在starter起步依赖中]）

2. autoconfigure模块（自动配置）

将来在项目当中进行相关功能开发时，只需要引入一个起步依赖就可以了，因为它会将 autoconfigure自动配置的依赖给传递下来。

上面我们简单介绍了自定义starter的场景，以及自定义starter时涉及到的模块之后，接下来我们就 来完成一个自定义starter的案例。

需求：自定义aliyun-oss-spring-boot-starter，完成阿里云OSS操作工具类AliyunOSSUtils 的自动配置。 目标：引入起步依赖引入之后，要想使用阿里云OSS，注入AliyunOSSUtils直接使用即可。

之前阿里云OSS的使用：

配置文件

AliOSSProperties类

AliOSSUtils工具类

当我们在项目当中要使用阿里云OSS，就可以注入AliOSSUtils工具类来进行文件上传。但这种方式其实是比较繁琐的。

大家再思考，现在我们使用阿里云OSS，需要做这么几步，将来大家在开发其他的项目的时候，你使用 阿里云OSS，这几步你要不要做？当团队中其他小伙伴也在使用阿里云OSS的时候，步骤不也是一样的。

所以这个时候我们就可以制作一个公共组件(自定义starter)。starter定义好之后，将来要使用阿里 云OSS进行文件上传，只需要将起步依赖引入进来之后，就可以直接注入AliOSSUtils使用了。

需求明确了，接下来我们再来分析一下具体的实现步骤：

第1步：创建自定义starter模块（进行依赖管理）

把阿里云OSS所有的依赖统一管理起来

第2步：创建autoconfigure模块

在starter中引入autoconfigure （我们使用时只需要引入starter起步依赖即可）

第3步：在autoconfigure中完成自动配置

定义一个自动配置类，在自动配置类中将所要配置的bean都提前配置好

定义配置文件，把自动配置类的全类名定义在配置文件中

我们分析完自定义阿里云OSS自动配置的操作步骤了，下面我们就按照分析的步骤来实现自定义 starter。

3.2.4.2 自定义starter实现

首先我们先来创建两个Maven模块：

aliyun-oss-spring-boot-starter模块：

这里Spring Boot我用的是3.2.2，黑马讲解的是用2.7.7，但是我用的版本暂时没有出现任何不适。

创建完starter模块后，删除多余的文件，最终保留内容如下：

删除pom.xml文件中多余的内容后：

aliyun-oss-spring-boot-autoconfigure模块：

这里Spring Boot我用的是3.2.2，黑马讲解的是用2.7.7，但是我用的版本暂时没有出现任何不适。

创建完starter模块后，删除多余的文件，最终保留内容如下：

删除pom.xml文件中多余的内容后：

按照我们之前的分析，是需要在starter模块中来引入autoconfigure这个模块的。打开starter模块中的pom文件：

前两步已经完成了，接下来是最关键的就是第三步：

在autoconfigure模块当中来完成自动配置操作。

我们将之前案例中所使用的阿里云OSS部分的代码直接拷贝到autoconfigure模块下，然后进行改造就行了。

拷贝过来后，还缺失一些相关的依赖，需要把相关依赖也拷贝过来。

现在大家思考下，在类上添加的@Component注解还有用吗？

答案：没用了。 在SpringBoot项目中，并不会去扫描com.aliyun.oss这个包，不扫描这个包那类上的注解也就失去了作用。

@Component注解不需要使用了，可以从类上删除了。 删除后报红色错误，暂时不理会，后面再来处理。

下面我们就要定义一个自动配置类了，在自动配置类当中来声明AliOSSUtils的bean对象。

AliOSSAutoConfiguration类：

AliOSSProperties类：

AliOSSUtils类：

在aliyun-oss-spring-boot-autoconfigure模块中的resources下，新建自动配置文件：

META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports