SpringBoot-starter的原理

我会带着你远行 2024-04-19 00:42 58阅读 0赞

**目录**

一、前言

1.1 SpringBoot的优点

1.2 SpringBoot-starter的作用

二、SpringBoot-starter解析

2.1 SpringBoot搭建SSM

2.2 SpringBoot的诸多配置

2.3 SpringBoot-starter自动配置bean

--------------------

## 一、前言 ##

### 1.1 SpringBoot的优点 ###

SpringBoot是新一代流行的Spring应用开发框架，它具有更多的优点：

*  创建独立的Spring应用
 *  内嵌Tomcat、Jetty或Undertow（无需部署war包）
 *  提供自用的starter来简化构建配置
 *  提供指标监控、运行状况检查和外部化配置
 *  没有代码生成，也不需要XML配置（约定大于配置）

### 1.2 SpringBoot-starter的作用 ###

SpringBoot拥有很多方便使用的**starter**（Spring提供的starter命名规范spring-boot-starter-xxx.jar，第三方提供的starter命名规范xxx-spring-boot-starter.jar），比如spring-boot-starter-log4j、mybatis-spring-boot-starter.jar等，各自都代表了一个相对完整的功能模块。

SpringBoot-starter是一个集成接合器，完成两件事：

*  引入模块所需的相关jar包
 *  自动配置各自模块所需的属性

## 二、SpringBoot-starter解析 ##

### 2.1 SpringBoot搭建SSM ###

我们使用SpringBoot新建一个web工程（SSM），看看他的依赖都有哪些：

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
    </dependency>

可见，使用SpringBoot-starter来搭建web工程相当方便，不像以前搭建SSM，需要将那么多jar包依赖逐个加入到Maven工程，还需考虑jar包之间的版本兼容性等。另外，数据源所需的配置也仅需如下：

spring.datasource.url=jdbc:mysql://100.10.14.116:3306/szhtest2?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai
    spring.datasource.username=test
    spring.datasource.password=test

Mybatis的配置如下：

![20190915165241984.png][]

至此，不需要多余的配置，一个SpringBoot搭建的SSM工程就可以跑了。

### 2.2 SpringBoot的诸多配置 ###

得益于starter的作用，使用SpringBoot确实方便，但对刚刚上手SpringBoot的人来说，可能只知道配置属性是在application.xml或application.yml中添加，但他们各自的属性都有哪些，具体怎么配置，却无从下手。这里先解决SpringBoot-starter中各属性的配置问题。

以2.1中的示例来看，Mybatis的配置是怎么生效的？查看示例工程的pom依赖：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70][]

注意到mybatis-spring-boot-starter帮我们自动依赖了Mybatis所需jar包，其中有一个负责自动配置的**mybatis-spring-boot-autoconfigure.jar**，紧接着打开此jar，如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 1][]

META-INF/spring-configuration-metadata.json中便是Mybatis在SpringBoot中的所有配置属性和介绍。至此，第一个问题便得到解决。

### 2.3 SpringBoot-starter自动配置bean ###

现在已得知jar包是怎么样自动依赖进来，以及他们的配置属性，那么接下来该考虑Mybatis所需的bean（如必需的sqlSessionFactory、sqlSessionTemplate等）是如何被自动加载的？

理所应当地，我们继续去查看mybatis-spring-boot-autoconfigure.jar，注意到里面有一个自动配置的类**MybatisAutoConfiguration**：

![20190915174121365.png][]

（1）**@Configuration**：被挂上@Configuration注解，表明它是一个配置类，作用等同于xml配置，里面有被@Bean注解的方法，也等同于xml配置的各种<bean>。

（2）**@ConditionalOnClass/@ConditionalOnBean**：自动配置条件注解，用于在某一部分配置中，将另一模块部分的配置自动加载进来，因为随着系统越来越大，配置内容越来越多，我们应当将Mybatis的配置放在一处，将log4j的配置放在一处，将SpringBoot自身的配置放在一处，当他们需要互相依赖时，可通过这类注解进行自动配置，如下：

@ConditionalOnClass @ConditionalOnMissingClass
    @ConditionalOnBean @ConditionalOnMissingBean
    @ConditionalOnProperty
    @ConditionalOnResource
    @ConditionalOnWebApplication @ConditionalOnNotWebApplication
    @ConditionalOnExpression
    
    @AutoConfigureAfter @AutoConfigureBefore @AutoConfigureOrder（指定顺序）

（3）**@EnableConfigurationProperties**：启用对@ConfigurationProperties注解的bean的支持，这里对应了配置属性类MybatisProperties，它里面定义了Mybatis的所有配置。

（4）**@AutoConfigureAfter**：应在其他指定的自动配置类之后应用自动配置。即org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration被自动配置后，才会接着自动配置MybatisAutoConfiguration。这里也解释了为什么我们在application.xml中只配置了数据源，而没有配置Mybatis，但是Mybatis可以正常查库的原因，就是因为它们配置之间的依赖关系。

到这里，差不多明白了starter自动配置bean的方式，但是如若再去深究，**各种starter的bean是如何被自动加载的**，猜想会不会是项目启动后，SpringBoot自动扫描里面所有的jar包，再去扫描所有的类，从而将各个bean放置IOC容器中。从结果来看，肯定是SpringBoot在启动时确确实实地自动加载了数据源和Mybatis相关的bean，不然他们无法正常工作。

回想在我们启动示例工程时，SpringBoot会自动扫描启动类所在包下的所有类，而如果还去扫描所有的jar包的话，又是具体怎么做到的？不妨从入口类调试一把，在SpringApplication.run(DemoApplication.class, args)打断点，一直追踪到**getSpringFactoriesInstances**这块：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 2][]

查看**SpringFactoriesLoader.loadFactoryNames**的方法注释：

*使用给定的类加载器从META-INF / spring.factories加载给定类型的工厂实现的完全限定类名。*

有点眼熟，这里的*spring.factories*刚好也存在于mybatis-spring-boot-autoconfigure.jar中，

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 3][]

继续调试，进入**SpringFactoriesLoader.loadFactoryNames**，

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 4][]

这里用类加载器得到工程中所有jar包中的**META-INF/spring.factories**文件资源，进而通过此文件得到了一些包括自动配置相关的类的集合，有各种工厂类、监听器、处理器、过滤器、初始化器等等，如下：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 5][]

最后的org.springframework.boot.autoconfigure.EnableAutoConfiguration集合中当然包括了org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration和org.mybatis.spring.boot.autoconfigure.MybatisAutoConfiguration。接着必然是将实例化的各个bean放进IOC容器中。

至此我们便明白了SpringBoot是如何自动配置starter里面的bean的。

[点此传送][Link 1]至SpringBoot-starter原理之手写。

[20190915165241984.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/7e34cd4ad3e54481ad097ef3d88fc183.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/54f709e4349c4ec8a8ac1b623eb9ff6a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/faa77e6095604ffca875287f2ec55c80.png
[20190915174121365.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/188fc203350346dfb6e9240a657d11bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/154e8b0edf3e40c3bcc7ec4d074a6536.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/c67b56cf46634bc1b4d04a851cc18833.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/74e3c1c5071e4f7bacd9f5fc3631ba42.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Nvbmd6ZWhhbw_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/b9abadbc538146a0bf412b4dc763b803.png
[Link 1]: https://blog.csdn.net/songzehao/article/details/100865939