源码剖析-启动注解@springBootApplication

发布于 2021-12-07  135 次阅读


Spring Boot 并不是用来替代 Spring 的解决方案,而是和 Spring 框架紧密结合用于提升 Spring 开发者体验的工具。同时它集成了大量常用的第三方库配置,Spring Boot应用中这些第三方库几乎可以是零配置的开箱即用(out-of-the-box),大部分的 Spring Boot 应用都只需要非常少量的配置代码(基于 Java 的配置),开发者能够更加专注于业务逻辑。

Spring Boot的约定大于配置的功力让我们如沐春风,自动配置、开箱即用,繁杂的XML配置也省了,简直不要太爽。而且前一段时间JetBrains公司发布的Java 2020调查也显示Spring Boot的使用占61%

我们在开发基于 Spring Boot的应用时,用到了一些新的注解和类,其中我们见得最多的注解之一,当属 Spring Boot 应用启动类上所加的 @SpringBootApplication 注解:

让我们看看@SpringBootApplication 注解背后都隐藏了哪些功能?

  • @SpringBootApplication注解实际上是Spring Boot提供的一个复合注解,我们来看一看其源码:

里面有三个核心的注解组成,让我们分别剖析下各自的作用:

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

   @AliasFor(annotation = Configuration.class)
   boolean proxyBeanMethods() default true;

}

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

至于@Configuration,我想在非Spring Boot时代大家应该就不陌生,作用是配置Spring容器,也即 JavaConfig 形式的 Spring IoC 容器的配置类所使用。

到目前来看,好像还没有什么新东西。

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

   String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

   Class<?>[] exclude() default {};

   String[] excludeName() default {};

}

@EnableAutoConfiguration 注解启用自动配置,其可以帮助 Spring Boot 应用将所有符合条件的 @Configuration 配置都加载到当前 IoC 容器之中,可以简要用图形示意如下:

Springboot揭秘 快速构建微服务体系中的插图

接下来我们对照源码,来解释一下这个流程:

@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容器

  • @ConponentScan

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

  • @Controller
  • @Entity
  • @Component
  • @Service
  • @Repository
  • 等等

对于该注解,还可以通过 basePackages 属性来更细粒度的控制该注解的自动扫描范围,比如:

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

可见这个注解也并不是什么新东西

说了这么多,总结而来就是,加载各种配置类,注入到ioc容器中

该文参考了扒一扒 @SpringBootApplication 注解背后的奥秘! (qq.com)