likes
comments
collection
share

SpringBoot自动装配过程

作者站长头像
站长
· 阅读数 23

Spring和SpringBoot最大的区别就在于：SpringBoot自动注册Bean以及初始化组件，简化我们的开发，实现真正的自动装配。本文主要详细剖析SpringBoot自动装配的实现过程。

SpringBoot自动装配的实现过程

SpringBoot 启动时会自动帮我们配置程序运行需要的使用的 Bean 对象放到 IOC 容器中，我们在其他类需要使用时只需要使用 @Autowire 或者 @Resource 注解进行依赖注入即可。

@SpringBootApplication注解

每一个SpringBoot都有一个启动类，启动类上都有一个@SpringBootApplication注解。

@SpringBootApplication
public class TxworkSeataApplication {

    public static void main(String[] args) {
        SpringApplication.run(TxworkSeataApplication.class, args);
    }

}

我们来看一看@SpringBootApplication注解它的组成部分：

@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 {

  @AliasFor(annotation = EnableAutoConfiguration.class)
  Class<?>[] exclude() default {};
  
  @AliasFor(annotation = EnableAutoConfiguration.class)
  String[] excludeName() default {};
  
  @AliasFor(annotation = ComponentScan.class, attribute = "basePackages")
  String[] scanBasePackages() default {};
  
  @AliasFor(annotation = ComponentScan.class, attribute = "basePackageClasses")
  Class<?>[] scanBasePackageClasses() default {};
}

可以看到@SpringBootApplication注解实际上是由@SpringBootConfiguration，@EnableAutoConfiguration，@ComponentScan这三个注解组成的。

  • @SpringBootConfiguration：它里面标注了 @Configuration 注解，表明这是个配置类，功能与 @Configuration相同。

  • @EnableAutoConfiguration：实现自动装配的核心注解，是用来激活自动装配的，其中默认路径扫描以及组件装配、排除等都通过它来实现。

  • @ComponentScan：用来扫描被 @Component标注的类 ，只不过这里是用来过滤 Bean 的，指定哪些类不进行扫描，而且用的是自定义规则。

@EnableAutoConfiguration注解

@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注解由两部分组成：

  • @AutoConfigurationPackage：用来将启动类所在包，以及下面所有子包里面的所有组件扫描到Spring容器中，这里的组件是指被 @Component或其派生注解标注的类。

  • @Import(AutoConfigurationImportSelector.class)：用于将一个或多个类导入到 Spring 容器中，以便于在应用程序中使用。

@Import注解的作用

  • 导入@Configuration类下所有的@bean方法中创建的bean对象。
  • 导入import指定的bean
  • 导入实现了ImportSelector和ImportBeanDefinitionRegistrar的接口类

AutoConfigurationImportSelector

@EnableAutoConfiguration注解基于内部的@Import({AutoConfigurationImportSelector.class})注解将AutoConfigurationImportSelector导入容器中，Spring就会调用其selectImports方法获取需要导入的类，并将这些类导入容器中。

@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
 if (!isEnabled(annotationMetadata)) {
    return NO_IMPORTS;
 }
 AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(annotationMetadata);
 return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}

selectImports通过getAutoConfigurationEntry方法获取需要装配的类，然后通过StringUtils.toStringArray切割返回。

重点看一下getAutoConfigurationEntry方法

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
   if (!isEnabled(annotationMetadata)) {
      return EMPTY_ENTRY;
   }
   // 获取 @EnableAutoConfigoration 标注类的元信息，也就是获取该注解 exclude 和 excludeName 属性值
   AnnotationAttributes attributes = getAttributes(annotationMetadata);
   
   // 获取所有xxxxAutoConfigure
   List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
   
   // 去除重复的自动装配组件，就是将List转为Set进行去重
   configurations = removeDuplicates(configurations);
   // 根据exclude 及 excludeName 属性值，排除指定的类
   Set<String> exclusions = getExclusions(annotationMetadata, attributes);
   checkExcludedClasses(configurations, exclusions);
   configurations.removeAll(exclusions);
   
   // 这里是过滤那些依赖不满足的自动装配 Class
   configurations = getConfigurationClassFilter().filter(configurations);
   fireAutoConfigurationImportEvents(configurations, exclusions);
   
   // 返回经过去重、排除、过滤等操作后的自动装配组件
   return new AutoConfigurationEntry(configurations, exclusions);
}

getCandidateConfigurations方法实际会通过一个loadSpringFactories方法，如下所示遍历获取所有含有META-INF/spring.factories的jar包

private static Map<String, List<String>> loadSpringFactories(ClassLoader classLoader) {
        Map<String, List<String>> result = (Map)cache.get(classLoader);
        if (result != null) {
            return result;
        } else {
            HashMap result = new HashMap();

            try {
            //解析这个配置文件获取所有配置类然后返回
                Enumeration urls = classLoader.getResources("META-INF/spring.factories");

              .....
                return result;
            } catch (IOException var14) {
                throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var14);
            }
        }
    }

上述代码主要逻辑：搜索classpath路径下以及所有外部jar包下的META-INF文件夹中的spring.factories文件，获取工厂类型和对应的实现类名，然后将它们存储在一个 Map 中。

SpringFactories 机制的实现过程如下：

  • 在类路径下的 META-INF/spring.factories 文件中定义一些扩展类的全限定类名。
  • 在应用程序启动时，使用 ClassLoader 加载 META-INF/spring.factories 文件，并解析其中定义的扩展类名。
  • 根据扩展类名使用反射机制动态创建扩展类的实例，并将其注册到相应的容器中。例如，在 Spring Boot 应用程序中，自动配置类会被注册到 Spring 容器中，并在应用程序启动时自动配置。

总结

SpringBoot 自动配置就是基于 SpringFactories 机制获取对应依赖 META-INF 目录下的 spring.factories 文件中的需要自动配置的类的全限定名信息，然后根据这些信息将我们需要的使用的 Bean 对象放到 IOC 容器中。

转载自:https://juejin.cn/post/7382495575398809609
评论
请登录