Spring Boot自动配置源码实例解析_Java

spring-boot-starter

一、准备配置类和 bean 对象

spring boot 提供了两个注解：

@configuration：spring 提供的配置类注解，作用在类上，代表整个类是个 spring 配置类，对照传统的 spring xml 配置文件
@bean：作用于方法上，代表此方法的返回值（对象）将会被 spring 容器所管理，从而完成 bean 的自动注册。

这两个组合起来搭配可以完美的代替传统的 spring xml 配置文件，并给 spring boot 的自动配置提供基本数据体。

二、自动配置条件依赖

有些情况下自动配置类并不是在任何条件下都能生效的，此时我们需要制定自动配置生效的条件，可以使用 spring boot 提供的注解来指定生效条件。

这些注解是 spring boot 特有的，常见的条件依赖注解有：

注解功能说明

@conditionalonbean 仅在当前上下文中存在某个 bean 时，才会实例化这个 bean
@conditionalonclass 某个 class 位于类路径上，才会实例化这个 bean
@conditionalonexpression 当表达式为 true 的时候，才会实例化这个 bean
@conditionalonmissingbean 仅在当前上下文中不存在某个 bean 时，才会实例化这个 bean
@conditionalonmissingclass 某个 class 在类路径上不存在的时候，才会实例化这个 bean
@conditionalonnotwebapplication 不是 web 应用时才会实例化这个 bean
@autoconfigureafter 在某个 bean 完成自动配置后实例化这个 bean
@autoconfigurebefore 在某个 bean 完成自动配置前实例化这个 bean

三、bean 的参数获取

举个例子，例如在 spring boot web 项目中，我们经常会导入 mybatis 相关的依赖，帮助我们与数据库打交道，那么在传统的 spring 项目中，我们一般会在 spring 容器配置 xml 文件中去使用标签生成相关数据源（datasource），那么这个 datasource 需要我们提供数据库连接参数：driver、url、username、password 这四个最基本的参数，这些数据可能放在一个叫做 db.properties 文件中，这种文件我们称为外部数据源文件，在 spring 配置文件中声明：<context:property-placeholder location=“classpath:db.properties”/>

这样就可以引入文件中的配置参数了，从而赋值给 datasource 这个 bean 所需要的属性参数。最后完成对象初始化。

这个过程在传统 spring 开发，无疑是略显繁琐，如果在某些我们需要自定义类和大量参数属性从外部文件引入，这个时候 properties 文件格式也比较复杂，文件可能较多，在初始化 bean 时，需要手写大量的属性赋值。

那么 spring boot 提供了注解帮助我们减小开发量，更加规范 bean 参数的获取方式。

默认情况下我们 bean 的参数配置在 application.yml 文件中，使用 yaml 文件格式定义，比 properties 文件更有层级感，更简约。

搭配 @enableconfigurationproperties、@configurationproperties 这两个注解可以直接实现自动配置类的 bean 参数获取。

3.1 @enableconfigurationproperties 注解

这个注解使用情况：自动配置类中需要从外部文件获取参数，来进行初始化。

在注解中指定一个类，这个时候可以配置类可以在这个类中获取到外部文件的参数，交给配置类中的 bean 进行初始化。

3.2 @configurationproperties 注解

注解使用情况：从外部文件获取参数信息，加载到自身类属性中，给 spring 配置类提供外部数据来源，外部数据文件通常指的是 application.yml。

在注解中指定从 application.yml 文件获取的前缀，例如 @configurationproperties(prefix=“spring.datasource”)，会获取以这个字符串为前缀的所有参数进行自动匹配赋值。

所以可以看出两个注解的关系是：

@enableconfigurationproperties 注解作用在配置类中，并且使得该注解指定的数据文件类中的 @configurationproperties 注解生效。

四. bean 的发现

4.1 自己项目的 bean 扫描

在写 spring boot 项目时，一般在项目的代码的根目录会有一个 spring boot 启动类：xxxapplication.java，这个类被 @springbootapplication 注解修饰标记成 spring boot 项目的启动类。

@springbootapplication
public class springbootstarterapplication {
    public static void main(string[] args) {
        springapplication.run(springbootstarterapplication.class, args);
    }
}

此时再来看看如何完成 bean 扫描，我们需要查看 @springbootapplication 注解源码：

@target({elementtype.type})
@retention(retentionpolicy.runtime)
@documented
@inherited
@springbootconfiguration
@enableautoconfiguration
@componentscan(
    excludefilters = {@filter(
    type = filtertype.custom,
    classes = {typeexcludefilter.class}
), @filter(
    type = filtertype.custom,
    classes = {autoconfigurationexcludefilter.class}
)}
)
public @interface springbootapplication {
    //...
}

我们重点查看 @springbootconfiguration 注解：

@target({elementtype.type})
@retention(retentionpolicy.runtime)
@documented
@configuration
@indexed
public @interface springbootconfiguration {
    @aliasfor(
        annotation = configuration.class
    )
    boolean proxybeanmethods() default true;
}

可以看到这个注解被熟悉的 @configuration 注解修饰。@springbootconfiguration 应用标注在某个类上说明这个类是springboot 的主配置类，springboot 需要运行这个类的 main 方法来启动 springboot 应用。

底层 spring boot 会帮我们将启动类的当前路径包以及子包的所有 spring 组件（可能需要 @componentscan注解去做组件扫描）以及 bean 扫描初始化。暂时只说浅层的流程，后续会深入 spring 源码学习。

4.2 jar 包的 bean 扫描

那么前面聊了自己项目的 bean 扫描，且 spring boot 默认扫描启动类所在包下的主类与子类的所有组件，其中并没有包括项目依赖包中的类，那么这些类是如何被 spring boot 发现的呢？

这就是第二个主要注解：@enableautoconfiguration，开启自动配置：

这里引入其他博客的理解，觉得这几句话简单易懂：

@enableautoconfiguration 的作用
简单点说就是 spring boot 根据依赖中的 jar 包，自动选择实例化某些配置，配置类必须有 @configuration 注解。

说白了，还是实例化对象，只是实例化的是依赖包中的类。

另外，我们也可以按照自动装配的规范自己定义装配的类。

接下来查看一下注解源码：

@target({elementtype.type})
@retention(retentionpolicy.runtime)
@documented
@inherited
@autoconfigurationpackage
@import({autoconfigurationimportselector.class})
public @interface enableautoconfiguration {
    //...
}

主要看 @import({autoconfigurationimportselector.class})，这个注解导autoconfigurationimportselector.class 这个类（如果是其他版本，可能会是 @enableautoconfigurationimportselector 这个是子类）。

我们找到 getcandidateconfigurations() 方法，这个方法就是用来加载依赖所需要的自动配置相关。

看到 springfactoriesloader.loadfactorynames() 的源码：

其他版本可能是只有 loadfactorynames() 方法，但是我们主要关注 classloader.getresources() 方法中的常量：

很明显这个方法是用来加载资源文件，而这个 spring 工厂资源的路径就是依赖中自动配置的相关路径，根据这个路径找到需要自动配置的类，最后完成依赖的自动配置。我们导入 mybatis-spring-boot-starter 依赖看看这个 meta-inf/spring.factories 里边是怎么样的：

# auto configure
org.springframework.boot.autoconfigure.enableautoconfiguration=\
org.mybatis.spring.boot.autoconfigure.mybatislanguagedriverautoconfiguration,\
org.mybatis.spring.boot.autoconfigure.mybatisautoconfiguration

简单概括的流程：spring boot 会根据 jar 包的 meta-inf/spring.factories 文件的配置进行自动装配，装配的流程是 springfactoriesloader.loadfactorynames() 方法顶层实现的（底层实现需深入源码），而开始外部自动装配的注解是：@springbootapplication 注解中的 @import({autoconfigurationimportselector.class})

主导整个过程。

五. bean 的加载

在 spring boot 中将一个普通类交给 spring 容器管理，通常有以下几个方法：

使用 @configuration 配合 @bean 注解使用（配置类）。

使用 @controller、@service、@repository、@component 注解标注类并且使用 @componentscan 自动扫描（组件扫描）。

使用 @import 方法（加载外部依赖的类）。

在上面可以看到 spring boot 实现自动配置使用的是 @import 注解这种方式。

autoconfigurationimportselector 类的 selectimports() 方法（其中调用了 getautoconfigurationentry() 方法主要过程）返回一组从 meta-inf/spring.factories 文件中读取的 bean 的全限定名，这样 spring boot 就可以加载到这些 bean 并完成实例的初始化工作。