SpringBoot 中 @SpringBootApplication注解

结合SpringBoot的源码,来看看SpringBoot中@SpringBootApplication注解背后的奥秘

概 述

平时如果我们需要搭建一个spring web项目的时候需要怎么做呢?
1)配置web.xml,加载spring和spring mvc
2)配置数据库连接、配置spring事务
3)配置加载配置文件的读取,开启注解
4)配置日志文件
...
配置完成之后部署tomcat 调试

但是如果使用spring boot呢?
很简单,我仅仅只需要非常少的几个配置就可以迅速方便的搭建起来一套web项目或者是构建一个微服务!

SpringBoot 最大的特点是约定大于配置
不论 SpringBoot 或者 SpringMVC 应用本质上依然是一个基于 Spring的应用,只不过在后者脸庞上蒙上了一层神秘的面纱而已!

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

本文就来看看它到底是个啥!

@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

看代码吧,代码里是这样写的:

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

}

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

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

}

至于@Configuration,实际上是对@Component的再次封装,作用是配置Spring容器,即以JavaConfig 形式的 配置需要Spirng IOC 容器管理的类。

@EnableAutoConfiguration

再继续看代码,代码是这样的:

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

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

@EnableAutoConfiguration 幕后的组件调用关系

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

  • @EnableAutoConfiguration 借助 AutoConfigurationImportSelector 的帮助,而后者通过实现 selectImports() 方法来导出 Configuration
    selectImports()
  • AutoConfigurationImportSelector 类的 selectImports() 方法里面通过调用Spring Core 包里 SpringFactoriesLoader 类的 loadFactoryNames()方法
    SpringFactoriesLoader.loadFactoryNames()
  • 最终通过 SpringFactoriesLoader.loadFactoryNames() 读取了 ClassPath 下面的 META-INF/spring.factories 文件来获取所有导出类
    而spring.factories 文件里关于 EnableAutoConfiguration 的配置其实就是一个键值对结构,样子大概长下面这样:spring.factories

    说了这么多,如果从稍微宏观一点的角度 概括总结 上述这一过程那就是:

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

    @ComponentScan

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

    • @Controller
    • @Entity
    • @Component
  • 等等

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

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

     


版权声明:本文为baidu_41669919原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。