Spring Boot的自动装配原理

每次问到springboot,面试官都非常喜欢问这个问题:“讲述一下springboot自动装配原理?

我觉得可以从一下几个方面来讲解:

1.什么是springboot自动装配?

2.springboot是如何实现自动装配的?如何实现按需加载?

3.如何实现一个starter?

1.什么是springboot自动装配?

自动装配是springboot的核心,一般提到自动装配就会和springboot联系在一起。实际上 Spring Framework 早就实现了这个功能。Spring Boot 只是在其基础上,通过 SPI 的方式,做了进一步优化。

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

没有 Spring Boot 的情况下,如果我们需要引入第三方依赖,需要手动配置,非常麻烦。但是,Spring Boot 中,我们直接引入一个 starter 即可。比如你想要在项目中使用 redis 的话,直接在项目中引入对应的 starter 即可。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

引入 starter 之后,我们通过少量注解和一些简单的配置就能使用第三方组件提供的功能了。

所以说,其实自动装配可以简单的理解为:通过注解或者一些简单的配置就能在spring boot的帮助下实现某款功能。

2.springboot是如何实现自动装配的?如何实现按需加载?

首先我们先来看一些springboot的核心注解@SpringBootApplication的类:

image-20220719142858661

image-20220719143331096

点击@SpringBootConfiguration注解,发现这个注解其实就是一个配置注解,SpringBoot 把 @Configuration 注解做一个包装。

image-20220719143438081

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

  • @EnableAutoConfiguration:启用 SpringBoot 的自动配置机制。

  • @Configuration:允许在上下文中注册额外的 bean 或导入其他配置类,作用与 applicationContext.xml 的功能相同。

  • @ComponentScan: 扫描包下的类中添加了@Component (@Service@Controller@Repostory@RestController)注解的类 ,并添加的到spring的容器中,可以自定义不扫描某些 bean。如下图所示,容器中将排除TypeExcludeFilterAutoConfigurationExcludeFilter

    image-20220719144558551

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

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

image-20220719145506125

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

AutoConfigurationImportSelector:加载自动装配类

AutoConfigurationImportSelector类的继承体系如下:

image-20220719145903801

image-20220719145928010

image-20220719145944885

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

image-20220719150300598

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

该方法调用链如下:

image-20220719172654775

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

image-20220719150617096

protected AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
    //第1步:判断自动装配开关是否打开
   if (!isEnabled(annotationMetadata)) {
      return EMPTY_ENTRY;
   }
    //第2步:用于获取注解中的exclude和excludeName。
    //获取注解属性
   AnnotationAttributes attributes = getAttributes(annotationMetadata); 
    //第3步:获取需要自动装配的所有配置类,读取META-INF/spring.factories
    //读取所有预配置类
   List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);
    //第4步:符合条件加载
    //去掉重复的配置类
   configurations = removeDuplicates(configurations);
    //执行
   Set<String> exclusions = getExclusions(annotationMetadata, attributes);
    //校验
   checkExcludedClasses(configurations, exclusions);
    //删除
   configurations.removeAll(exclusions);
    //过滤
   configurations = getConfigurationClassFilter().filter(configurations);
   fireAutoConfigurationImportEvents(configurations, exclusions);
    //创建自动配置的对象
   return new AutoConfigurationEntry(configurations, exclusions);
}

第 1 步:

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

image-20220719151217854

image-20220719151401488

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-1r3OBNlK-1658315426459)(https://typroa-cos-1304737216.cos.ap-beijing.myqcloud.com//x_img/77aa6a3727ea4392870f5cccd09844ab~tplv-k3u1fbpfcp-watermark.image)]

第 2 步

用于获取EnableAutoConfiguration注解中的 excludeexcludeName

image-20220719151602397

第 3 步

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

先进入 getCandidateConfigurations() 方法中:

image-20220719151900359

进入 loadFactoryNames() 方法中:

image-20220719152324590

再进入 loadSpringFactories() 方法中:

image-20220719152349248

image-20220719152145261

从下图可以看到这个文件的配置内容都被我们读取到了。

image-20220719152633820

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

第 4 步

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

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

image-20220719153400098

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

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包实现起步依赖。

3.如何实现一个starter?

便于自己理解,这里自己可以实现一个 starter,实现自定义线程池:

第一步,创建threadpool-spring-boot-starter工程

image-20220719160935789

第二步,引入 Spring Boot 相关依赖

image-20220719161019151

第三步,创建ThreadPoolAutoConfiguration

image-20220719161106748

第四步,在threadpool-spring-boot-starter工程的 resources 包下创建META-INF/spring.factories文件

image-20220719161133476

最后新建工程引入threadpool-spring-boot-starter

image-20220719161226273

进行测试

image-20220719161347997

image-20220719161411335

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐