springboot自动配置springboot自动配置原理总结springboot自动配置原理详解




springboot自动配置springboot自动配置原理总结springboot自动配置原理详解

2022-07-21 2:25:32 网络知识 官方管理员

依赖管理

在我们的pom文件中最核心的依赖就一个:

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.4.4</version><relativePath/></parent>

它的父项目依赖,规定所有依赖的版本信息:

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-dependencies</artifactId><version>2.4.4</version></parent>

由此,我们发现springboot框架几乎声明了所有开发中常用的依赖的版本号,无需关注版本号,而且实现了自动版本仲裁机制,当然了我们也可以根据我们的需要,替换掉默认的依赖版本。

核心注解@SpringBootApplication

@SpringBootApplicationpublicclassBootApplication{publicstaticvoidmain(String[]args){SpringApplication.run(BootApplication.class,args);}}

在上面的启动类中我们发现了一个陌生的注解@SpringBootApplication,这个注解的是什么含义呢?我们点进去看一下。

@SpringBootConfiguration@EnableAutoConfiguration@ComponentScan(excludeFilters={@Filter(type=FilterType.CUSTOM,classes=TypeExcludeFilter.class),@Filter(type=FilterType.CUSTOM,classes=AutoConfigurationExcludeFilter.class)})

其实@SpringBootApplication是上面三个注解的组合体,我们对这三个注解理解清楚就可以了,下面逐个进行解释:

@SpringBootConfiguration

@Configurationpublic@interfaceSpringBootConfiguration{

@Configuration我们并不陌生,它允许在上下文中注册额外的bean或导入其他配置类,@SpringBootConfiguration其实代表当前类是一个配置类。

@EnableAutoConfiguration

EnableAutoConfiguration的目的是启动SpringBoot的自动配置机制。

@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public@interfaceEnableAutoConfiguration{

1、AutoConfigurationPackage指定默认的包规则

@Import(AutoConfigurationPackages.Registrar.class)public@interfaceAutoConfigurationPackage{

AutoConfigurationPackage注解的作用是将添加该注解的类所在的package作为自动配置package进行管理。也就是说当SpringBoot应用启动时默认会将启动类所在的package作为自动配置的package。然后使用@Import注解将其注入到ioc容器中。这样,可以在容器中拿到该路径。

staticclassRegistrarimplementsImportBeanDefinitionRegistrar,DeterminableImports{@OverridepublicvoidregisterBeanDefinitions(AnnotationMetadatametadata,BeanDefinitionRegistryregistry){register(registry,newPackageImports(metadata).getPackageNames().toArray(newString[0]));}@OverridepublicSet<Object>determineImports(AnnotationMetadatametadata){returnCollections.singleton(newPackageImports(metadata));}}

重点看下registerBeanDefinitions方法。

方法的第二个参数通过newPackageImport(metadata).getPackageName()方法设置。

接着看下PackageImport的构造器方法。

PackageImports(AnnotationMetadatametadata){AnnotationAttributesattributes=AnnotationAttributes.fromMap(metadata.getAnnotationAttributes(AutoConfigurationPackage.class.getName(),false));List<String>packageNames=newArrayList<>(Arrays.asList(attributes.getStringArray("basePackages")));for(Class<?>basePackageClass:attributes.getClassArray("basePackageClasses")){packageNames.add(basePackageClass.getPackage().getName());}if(packageNames.isEmpty()){packageNames.add(ClassUtils.getPackageName(metadata.getClassName()));}this.packageNames=Collections.unmodifiableList(packageNames);}

ClassUtils.getPackageName(metadata.getClassName())获取标注@AutoConfigurationPackage注解的类的全限定名。

最后,利用Registrar给容器中导入一系列组件,将指定的包下的所有组件导入进来。

2、@Import(AutoConfigurationImportSelector.class)

使用Import自动导入所有符合自动配置条件的Bean定义并加载到IOC容器

@Overridepublicvoidprocess(AnnotationMetadataannotationMetadata,DeferredImportSelectordeferredImportSelector){Assert.state(deferredImportSelectorinstanceofAutoConfigurationImportSelector,()->String.format("Only%simplementationsaresupported,got%s",AutoConfigurationImportSelector.class.getSimpleName(),deferredImportSelector.getClass().getName()));AutoConfigurationEntryautoConfigurationEntry=((AutoConfigurationImportSelector)deferredImportSelector).getAutoConfigurationEntry(annotationMetadata);this.autoConfigurationEntries.add(autoConfigurationEntry);for(StringimportClassName:autoConfigurationEntry.getConfigurations()){this.entries.putIfAbsent(importClassName,annotationMetadata);}}

1、利用getAutoConfigurationEntry(annotationMetadata);给容器中批量导入一些组件

2、调用Listconfigurations=getCandidateConfigurations(annotationMetadata,attributes)获取到所有需要导入到容器中的配置类

3、利用工厂加载Map<String,List>loadSpringFactories(@NullableClassLoaderclassLoader);得到所有的组件

4、从META-INF/spring.factories位置来加载一个文件。

默认扫描我们当前系统里面所有META-INF/spring.factories位置的文件

spring-boot-autoconfigure-2.4.4.RELEASE.jar包里面也有META-INF/spring.factories

springboot自动配置(springboot自动配置原理总结)(1)

文件里面写死了spring-boot一启动就要给容器中加载的所有配置类spring-boot-autoconfigure-2.4.4.RELEASE.jar/META-INF/spring.factories,一共130个自动配置类。

130个场景的所有自动配置,会在springboot启动的时候默认全部加载。xxxxAutoConfiguration会按照条件装配规则(@Conditional),最终会按需配置。

小结:

SpringBoot为我们的应用程序启用了三个功能:自动配置,组件扫描,以及能够在"应用类"上定义额外的配置。

@ComponentScan

@Component在应用程序所在的软件包上启用扫描,指定扫描哪些Spring注解。

ServletWebServerFactoryAutoConfiguration为例

在130个场景有我们比较熟悉两个组件,ServletWebServerFactoryAutoConfiguration和WebMvcAutoConfiguration,我们以ServletWebServerFactoryAutoConfiguration为例,看一下SpringBoot是如何自动装配的webServer。

springboot自动配置(springboot自动配置原理总结)(2)

在注解中我们看到了大量以@Conditional开头的注解,即条件装配,满足Conditional指定的条件,则进行组件注入。@EnableConfigurationProperties(ServerProperties.class)+@ConfigurationProperties(prefix=“server”,ignoreUnknownFields=true),读取我们在配置文件编写的属性,并把它封装到JavaBean中,以供随时使用。

此时我们的Tomcat容器已经以Bean的形式被注入到了IOC容器中。

如何禁用特定的自动配置类

如果发现应用中不需要特定自动配置类,则可以使用exclude属性@SpringBootApplication来禁用它们,如以下示例所示:

<parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-dependencies</artifactId><version>2.4.4</version></parent>0

如果该类不在类路径中,则可以使用excludeName注释的属性,并指定完全限定的名称(全类名字符串)。定义排除项,即可以使用哪个注释级别也可以使用属性来定义。

总结

1、SpringBoot预先加载META-INF/spring.factories中所有的自动配置类,xxxxxAutoConfiguration

2、每个自动配置类按照条件进行生效,默认都会绑定配置文件指定的值。xxxxProperties里面拿。xxxProperties和配置文件进行了绑定

3、生效的配置类就会给容器中装配很多组件,只要容器中有这些组件,相当于有了这些功能

4、定制化配置

  • 用户直接自己@Bean替换底层的组件
  • 用户根据这个组件是获取的配置文件的什么值,可以自行修改。

EnableAutoConfiguration—>扫描xxxxxAutoConfiguration—>根据条件@Conditional装配组件—>根据xxxxProperties加载属性值---->application.properties


发表评论:

最近发表
网站分类
标签列表