写点什么

SpringBoot 自动装配原理

作者:周杰伦本人
  • 2022 年 7 月 15 日
  • 本文字数:2492 字

    阅读完需:约 8 分钟

SpringBoot 自动装配原理

SpringBoot 自动装配原理是怎么样的呢,不同的人可能有不同的理解,但作为程序员,最权威的就是看源码了,下面看下 springboot 相关的源码,理解一下 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 {}
复制代码


进入 SpringBootApplication 注解可以看到 EnableAutoConfiguration 注解


@Enable 注解的主要作用把相关组件的 Bean 装配到 IOC 容器中

EnableAutoConfiguration 注解

进入 EnableAutoConfiguration 注解 :


@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
/** * Exclude specific auto-configuration classes such that they will never be applied. * @return the classes to exclude */ Class<?>[] exclude() default {};
/** * Exclude specific auto-configuration class names such that they will never be * applied. * @return the class names to exclude * @since 1.3.0 */ String[] excludeName() default {};
}
复制代码


@AutoConfigurationPackage 的作用是把使用了该注解的类所在的包和子包下所有的组件扫描到 SpringIOC 容器中。@Import 注解导入了一个 AutoConfigurationImportSelector 类,AutoConfigurationImportSelector 实现配置类的导入

AutoConfigurationImportSelector

AutoConfigurationImportSelector 实现了 ImportSelector 接口 selectImports 方法返回一个 String 数组,数组中指定需要装配到 IOC 容器中


@Overridepublic String[] selectImports(AnnotationMetadata annotationMetadata) {   if (!isEnabled(annotationMetadata)) {      return NO_IMPORTS;   }   AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader         .loadMetadata(this.beanClassLoader);   AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(         autoConfigurationMetadata, annotationMetadata);   return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}
复制代码


  1. AutoConfigurationMetadataLoader.loadMetadata 从 META-INF/spring-autoconfigure-metadata.properties 中加载自动装配的条件元数据,就是只有满足条件的 Bean 才能够进行装配。

  2. 收集符合条件的配置类 autoConfigurationEntry.getConfigurations(),完成自动装配


AutoConfigurationImportSelector 中不执行 selectImports 方法,而是通过 ConfigurationClassPostProcessor 的 processConfigBeanDefinitions 方法进行扫描和注册所有配置类的 Bean。


protected AutoConfigurationEntry getAutoConfigurationEntry(      AutoConfigurationMetadata autoConfigurationMetadata,      AnnotationMetadata annotationMetadata) {   if (!isEnabled(annotationMetadata)) {      return EMPTY_ENTRY;   }   AnnotationAttributes attributes = getAttributes(annotationMetadata);   List<String> configurations = getCandidateConfigurations(annotationMetadata,         attributes);   configurations = removeDuplicates(configurations);   Set<String> exclusions = getExclusions(annotationMetadata, attributes);   checkExcludedClasses(configurations, exclusions);   configurations.removeAll(exclusions);   configurations = filter(configurations, autoConfigurationMetadata);   fireAutoConfigurationImportEvents(configurations, exclusions);   return new AutoConfigurationEntry(configurations, exclusions);}
复制代码


  1. getAttributes 获得 @EnableAutoConfiguration 注解中的属性 exclude excludeName 等

  2. getCandidateConfigurations()获得所有自动装配的配置类

  3. removeDuplicates()方法去除重复的配置项

  4. getExclusions 方法根据 @EnableAutoConfiguration 注解中配置的 exclude 属性,把不需要自动装配的配置类移除。

  5. fireAutoConfigurationImportEvents 方法广播事件

  6. 最后返回经过多层判断和过滤之后的配置类集合。

getCandidateConfigurations()方法

protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,      AnnotationAttributes attributes) {   List<String> configurations = SpringFactoriesLoader.loadFactoryNames(         getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());   Assert.notEmpty(configurations,         "No auto configuration classes found in META-INF/spring.factories. If you "               + "are using a custom packaging, make sure that file is correct.");   return configurations;}
复制代码


SpringFactoriesLoader 扫描 classpath 下的 META-INF/spring.factories 文件,根据 Key 得到对应的 value 值。

总结

  1. 通过 @Import 实现配置类的导入

  2. AutoConfigurationImportSelector 类实现 ImportSelector 接口,重写 selectImports 方法,用于实现选择性批量配置类的装配

  3. 通过 Spring 提供的 SpringFactoriesLoader 机制,扫描 classpath 路径下的 META-INF/spring.factories 文件,读取需要实现自动装配的配置类

  4. 通过条件筛选,把不符合条件的配置类移除,最终完成自动装配。


好了 这就是 SpringBoot 自动装配原理,给大家简简单单的分析了一下,如果你觉得还不错的话,欢迎给大家留言和点赞,大家的赞是对我最大的鼓励,我将继续更文,提升自己的同时分享更多的好文章。

发布于: 刚刚阅读数: 5
用户头像

还未添加个人签名 2020.02.29 加入

公众号《盼盼小课堂》,多平台优质博主

评论

发布
暂无评论
SpringBoot自动装配原理_7月月更_周杰伦本人_InfoQ写作社区