0. SpringBoot启动类配置
SpringBoot 项目的一切都要从 @SpringBootApplication 这个注解开始说起。@SpringBootApplication是一个组合注解,用于快捷配置启动类(应用程序入口)。
@SpringBootApplication
public class SoJptSpringbootApplication {
public static void main(String[] args) {
SpringApplication springApplication = new SpringApplication(SoJptSpringbootApplication.class);
}
}
1. @SpringBootApplication注解简介
@SpringBootApplication 标注在某个类上说明:
- 这个类是 SpringBoot 的主配置类。
- SpringBoot 就应该运行这个类的 main 方法来启动 SpringBoot 应用。
@SpringBootApplication是一个组合注解,其注解定义如下:
@Target(ElementType.TYPE) - 标记这个注解只能适用于(类、接口或枚举)
@Retention(RetentionPolicy.RUNTIME) - 标记这个注解将被存储在class文件中,并且可以由JVM读入
@Documented - 标记这些注解是否包含在用户文档中。
@Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
@Filter(type = FilterType.CUSTOM,
classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}
2. @SpringBootApplication注解浅析
从上面可以看到@SpringBootAppplication注解主要有以下三个注解组成:
- @SpringBootConfiguration:该注解表示这是一个 SpringBoot 的配置类,其实它就是一个 @Configuration 注解而已。
- @ComponentScan:开启组件扫描。
- @EnableAutoConfiguration:开启自动配置的(自动配置的奥秘全都在这个注解里面)。
@SpringBootConfiguration注解
- @SpringBootConfiguration继承自@Configuration,二者功能也一致,标注当前类是配置类,并会将当前类内声明的一个或多个以@Bean注解标记的方法的实例纳入到spring容器中,并且实例名就是方法名。
@ComponentScan
- @ComponentScan 的作用就是根据定义的扫描路径,把符合扫描规则的类装配到spring容器中。
@EnableAutoConfiguration
- @EnableAutoConfiguration的作用主要有两个,第一是将主配置类(@SpringBootApplication标注的类)的所在包以及下面的子包里面所有的组件扫描到Spring容器中去,默认情况下主配置类包及子包以外的组件,Spring容器是扫描不到的。第二是将类路径下 META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。
2.1 @EnableAutoConfiguration浅析
@EnableAutoConfiguration见名知义,就是开启自动配置功能。该注解主要组成如下:
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
}
该注解主要由以下两部分组成:
- @AutoConfigurationPackage:自动配置包,就是将主配置类(@SpringBootApplication标注的类)的所在包以及下面的子包里面所有的组件扫描到Spring容器中去。
- @Import({AutoConfigurationImportSelector.class}):将类路径下 META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。
@AutoConfigurationPackage
该注解主要组成如下:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AutoConfigurationPackages.Registrar.class)
public @interface AutoConfigurationPackage {
}
其主要是有一个注解@Import注解:**@Import(AutoConfigurationPackages.Registrar.class)**组成。我们在 Registrar 类中的 registerBeanDefinitions 方法上打上断点,可以看到返回了一个包名,该包名其实就是主配置类所在的包。
一句话:@AutoConfigurationPackage 注解就是将主配置类(@SpringBootConfiguration标注的类)的所在包及下面所有子包里面的所有组件扫描到Spring容器中。所以说,默认情况下主配置类包及子包以外的组件,Spring 容器是扫描不到的。
@Import({AutoConfigurationImportSelector.class})
该注解给当前配置类导入另外的 N 个自动配置类。
我们在AutoConfigurationImportSelector类中可以发现,该类重写了DeferredImportSelector类中的selectImports方法。
在selectImports方法中我们会发现这样一个调用链:selectImports() -> getAutoConfigurationEntry() -> getCandidateConfigurations() -> loadFactoryNames() ->loadSpringFactories()。
在这里 loadFactoryNames() 方法传入了 EnableAutoConfiguration.class 这个参数。
loadFactoryNames() 中关键的三步:
- 从当前项目的类路径中获取所有 META-INF/spring.factories 这个文件下的信息。
- 将上面获取到的信息封装成一个 Map 返回。
- 从返回的 Map 中通过刚才传入的 EnableAutoConfiguration.class 参数,获取该 key 下的所有值。
META-INF/spring.factories:里面存放的都是需要待加载的类
一句话:将类路径下 META-INF/spring.factories 里面配置的所有 EnableAutoConfiguration 的值加入到 Spring 容器中。