SpringBoot 中 @SpringBootApplication注解背后的三体结构探秘

时间 2019-11-07

标签 springboot springbootapplication 注解背后三体结构探秘栏目 Spring 繁體版

原文原文链接

概述

SpringBoot 约定大于配置 的功力让咱们如沐春风，在我以前写的文章《从SpringBoot到SpringMVC》
也对比过 SpringBoot 和 SpringMVC 这两个框架，不过最终 SpringBoot 以超高的代码信噪比和易上手性让咱们映像颇深。spring

但归根结底，不论 SpringBoot 或者 SpringMVC 应用本质上依然是一个基于 Spring的应用，只不过在后者脸庞上蒙上了一层神秘的面纱而已！编程

回到 SpringBoot 的话题，咱们在开发基于 SpringBoot 的应用时，用到了一些新的注解和类，正式因为其存在，才让JavaEE的开发如鱼得水。这其中咱们用的最多的注解之一，当属 SpringBoot 应用启动类上的 @SpringBootApplication 注解了c#

本文就来看看它究竟是个啥！服务器

注：本文首发于 My 公众号 CodeSheep ，可长按或扫描下面的 当心心 来订阅 ↓ ↓ ↓

@SpringBootApplication 背后究竟是什么？

@SpringBootApplication注解其实是SpringBoot提供的一个复合注解，咱们来看一看其源码：框架

@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
@EnableAutoConfiguration
@ComponentScan

咱们不妨称其为 “ 三体结构 ” 吧！学习

若是咱们不怕麻烦，在 SpringBoot 应用的启动类上用这个三个注解代替@SpringBootApplication 注解发现也是没问题的：搜索引擎

@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan
public class TestSpringBootApplication {
    ...
}

下面分别剖析一下这三个注解的功效！编码

@SpringBootConfiguration

看代码吧，代码里是这样写的：spa

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {

}

这说明 @SpringBootConfiguration 也是来源于 @Configuration，两者功能都是将当前类标注为配置类，并将当前类里以 @Bean 注解标记的方法的实例注入到srping容器中，实例名即为方法名。

至于@Configuration，我想在非SpringBoot时代你们应该不陌生吧，做用是配置Spring容器，也即 JavaConfig 形式的 Spring IoC 容器的配置类所使用。

到目前来看，好像尚未什么新东西！！！

@EnableAutoConfiguration

再继续看代码，代码是这样的：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
    ...
}

@EnableAutoConfiguration 注解启用自动配置，其能够帮助 SpringBoot 应用将全部符合条件的 @Configuration 配置都加载到当前 IoC 容器之中，能够简要用图形示意以下：

接下来咱们对照源码，来解释一下这个流程：

@EnableAutoConfiguration 借助 AutoConfigurationImportSelector 的帮助，然后者经过实现 selectImports() 方法来导出 Configuration

AutoConfigurationImportSelector 类的 selectImports() 方法里面经过调用Spring Core 包里 SpringFactoriesLoader 类的 loadFactoryNames()方法

最终经过 SpringFactoriesLoader.loadFactoryNames() 读取了 ClassPath 下面的 META-INF/spring.factories 文件来获取全部导出类。

而spring.factories 文件里关于 EnableAutoConfiguration 的配置其实就是一个键值对结构，样子大概长下面这样：

说了这么多，若是从稍微宏观一点的角度 归纳总结 上述这一过程那就是：

从 ClassPath下扫描全部的 META-INF/spring.factories 配置文件，并将spring.factories 文件中的 EnableAutoConfiguration 对应的配置项经过反射机制实例化为对应标注了 @Configuration 的形式的IoC容器配置类，而后注入IoC容器。

@ComponentScan

@ComponentScan 对应于XML配置形式中的 <context:component-scan>，用于将一些标注了特定注解的bean定义批量采集注册到Spring的IoC容器之中，这些特定的注解大体包括：

@Controller
@Entity
@Component
@Service
@Repository

等等

对于该注解，还能够经过 basePackages 属性来更细粒度的控制该注解的自动扫描范围，好比：

@ComponentScan(basePackages = {"cn.codesheep.controller","cn.codesheep.entity"})

可见这个注解也并非什么新东西！

后记

因为能力有限，如有错误或者不当之处，还请你们批评指正，一块儿学习交流！

做者更多的SpringBt实践文章在此：

若是有兴趣，也能够抽点时间看看做者一些关于容器化、微服务化方面的文章：

可长按或扫描下面的 当心心 来订阅 CodeSheep，获取更多 务实、能看懂、可复现的 原创文 ↓↓↓

SpringBoot 中 @SpringBootApplication注解背后的三体结构探秘

概 述

@SpringBootApplication 背后究竟是什么？

@SpringBootConfiguration

@EnableAutoConfiguration

@ComponentScan

后 记

概述

后记