跳至主要內容

自动装配

一杯面包大约 5 分钟技术后端笔记收集SpringBoot

自动装配

SpringBoot 定义了一套接口规范,这套规范规定:SpringBoot 在启动时会扫描外部引用 jar 包中的META-INF/spring.factories​文件,将文件中配置的类型信息加载到 Spring 容器(此处涉及到 JVM 类加载机制与 Spring 的容器知识),并执行类中定义的各种操作。对于外部 jar 来说,只需要按照 SpringBoot 定义的标准,就能将自己的功能装置进 SpringBoot。

SpringBoot 是如何实现自动装配的?

我们先看一下 SpringBoot 的核心注解 SpringBootApplication​ 。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@ComponentScan
@EnableAutoConfiguration
public @interface SpringBootApplication {

}

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration //实际上它也是一个配置类
public @interface SpringBootConfiguration {
}

大概可以把 @SpringBootApplication​看作是 @Configuration​、@EnableAutoConfiguration​、@ComponentScan​ 注解的集合。根据 SpringBoot 官网,这三个注解的作用分别是:

  • @EnableAutoConfiguration​:启用 SpringBoot 的自动配置机制
  • @Configuration​:允许在上下文中注册额外的 bean 或导入其他配置类
  • @ComponentScan​:扫描被@Component​ (@Service​,@Controller​)注解的 bean,注解默认会扫描启动类所在的包下所有的类 ,可以自定义不扫描某些 bean。如下图所示,容器中将排除TypeExcludeFilter​和AutoConfigurationExcludeFilter​。

image

@EnableAutoConfiguration​​ 是实现自动装配的重要注解,我们以这个注解入手。

@EnableAutoConfiguration:实现自动装配的核心注解

@EnableAutoConfiguration​ 只是一个简单地注解,自动装配核心功能的实现实际是通过 AutoConfigurationImportSelector​类。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage //作用:将main包下的所有组件注册到容器中
@Import({AutoConfigurationImportSelector.class}) //加载自动装配类 xxxAutoconfiguration
public @interface EnableAutoConfiguration {
    String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";

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

    String[] excludeName() default {};
}

我们现在重点分析下AutoConfigurationImportSelector​ 类到底做了什么?

AutoConfigurationImportSelector:加载自动装配类

AutoConfigurationImportSelector​类的继承体系如下:

public class AutoConfigurationImportSelector implements DeferredImportSelector, BeanClassLoaderAware, ResourceLoaderAware, BeanFactoryAware, EnvironmentAware, Ordered {

}

public interface DeferredImportSelector extends ImportSelector {

}

public interface ImportSelector {
    String[] selectImports(AnnotationMetadata var1);
}

可以看出,AutoConfigurationImportSelector​ 类实现了 ImportSelector​接口,也就实现了这个接口中的 selectImports​方法,该方法主要用于获取所有符合条件的类的全限定类名,这些类需要被加载到 IoC 容器中

private static final String[] NO_IMPORTS = new String[0];

public String[] selectImports(AnnotationMetadata annotationMetadata) {
        // <1>.判断自动装配开关是否打开
        if (!this.isEnabled(annotationMetadata)) {
            return NO_IMPORTS;
        } else {
          //<2>.获取所有需要装配的bean
            AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);
            AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata);
            return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
        }
    }

这里我们需要重点关注一下getAutoConfigurationEntry()​方法,这个方法主要负责加载自动配置类的。

该方法调用链如下:

​​net-img-3c1200712655443ca4b38500d615bb70~tplv-k3u1fbpfcp-watermark​​​​​​

现在我们结合getAutoConfigurationEntry()​的源码来详细分析一下:

private static final AutoConfigurationEntry EMPTY_ENTRY = new AutoConfigurationEntry();

AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {
        //<1>.
        if (!this.isEnabled(annotationMetadata)) {
            return EMPTY_ENTRY;
        } else {
            //<2>.
            AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
            //<3>.
            List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
            //<4>.
            configurations = this.removeDuplicates(configurations);
            Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
            this.checkExcludedClasses(configurations, exclusions);
            configurations.removeAll(exclusions);
            configurations = this.filter(configurations, autoConfigurationMetadata);
            this.fireAutoConfigurationImportEvents(configurations, exclusions);
            return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
        }
    }

第 1 步:

判断自动装配开关是否打开。默认spring.boot.enableautoconfiguration=true​,可在 application.properties​ 或 application.yml​ 中设置

第 2 步

用于获取EnableAutoConfiguration​注解中的 exclude​ 和 excludeName​。

image

第 3 步

获取需要自动装配的所有配置类,读取META-INF/spring.factories

spring-boot/spring-boot-project/spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

从下图可以看到这个文件的配置内容都被我们读取到了。XXXAutoConfiguration​的作用就是按需加载组件。

不光是这个依赖下的META-INF/spring.factories​被读取到,所有 Spring Boot Starter 下的META-INF/spring.factories​都会被读取到。

所以,你可以清楚滴看到, druid 数据库连接池的 Spring Boot Starter 就创建了META-INF/spring.factories​文件。

如果,我们自己要创建一个 Spring Boot Starter,这一步是必不可少的。

第 4 步

到这里可能面试官会问你:“spring.factories​中这么多配置,每次启动都要全部加载么?”。

很明显,这是不现实的。我们 debug 到后面你会发现,configurations​ 的值变小了。

因为,这一步有经历了一遍筛选,@ConditionalOnXXX​ 中的所有条件都满足,该类才会生效。

@Configuration
// 检查相关的类:RabbitTemplate 和 Channel是否存在
// 存在才会加载
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
@EnableConfigurationProperties(RabbitProperties.class)
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
}

有兴趣的童鞋可以详细了解下 Spring Boot 提供的条件注解

  • @ConditionalOnBean​:当容器里有指定 Bean 的条件下
  • @ConditionalOnMissingBean​:当容器里没有指定 Bean 的情况下
  • @ConditionalOnSingleCandidate​:当指定 Bean 在容器中只有一个,或者虽然有多个但是指定首选 Bean
  • @ConditionalOnClass​:当类路径下有指定类的条件下
  • @ConditionalOnMissingClass​:当类路径下没有指定类的条件下
  • @ConditionalOnProperty​:指定的属性是否有指定的值
  • @ConditionalOnResource​:类路径是否有指定的值
  • @ConditionalOnExpression​:基于 SpEL 表达式作为判断条件
  • @ConditionalOnJava​:基于 Java 版本作为判断条件
  • @ConditionalOnJndi​:在 JNDI 存在的条件下差在指定的位置
  • @ConditionalOnNotWebApplication​:当前项目不是 Web 项目的条件下
  • @ConditionalOnWebApplication​:当前项目是 Web 项 目的条件下

总结

Spring Boot 通过@EnableAutoConfiguration​开启自动装配,通过 SpringFactoriesLoader 最终加载META-INF/spring.factories​中的自动配置类实现自动装配,自动配置类其实就是通过@Conditional​按需加载的配置类,想要其生效必须引入spring-boot-starter-xxx​包实现起步依赖---

上次编辑于:
贡献者: Toby Ye