简单详细的SpringBoot自动配置原理解析

简介: 上一篇文章我们介绍了SpringFactoriesLoader,之所以介绍SpringFactoriesLoader是因为我们这篇文章要介绍的SpringBoot的自动配置会用到SpringFactoriesLoader的知识。闲话少叙,让我们直入主题。

前言

上一篇文章我们介绍了SpringFactoriesLoader,之所以介绍SpringFactoriesLoader是因为我们这篇文章要介绍的SpringBoot的自动配置会用到SpringFactoriesLoader的知识。闲话少叙,让我们直入主题。

环境

spring-boot 1.5.8.RELEASE

从启动类开始

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

如上,就是我们SpringBoot应用的启动类。让我们把眼光聚焦到@SpringBootApplication注解上面。这个注解是SpringBoot项目的主配置类。

@SpringBootApplication

//省略部分注解
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {
  @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
  @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {
}

根据前几篇的介绍,我们可以知道@SpringBootApplication注解是一个组合注解。

@SpringBootConfiguration注解 表示这是SpringBoot的配置类,

@ComponentScan 开启组件扫描

@EnableAutoConfiguration这个注解的作用就是让SpringBoot开启自动配置。自动配置的奥秘全都在这里:

@EnableAutoConfiguration

//省略部分注解
@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
}

如上我们可以看到EnableAutoConfiguration注解上有两个注解

1.@AutoConfigurationPackage 注解,

从字面意思上来看就是自动配置包。点进去可以看到就是⼀个 @Import 注解: @Import(AutoConfigurationPackages.Registrar.class) ,导⼊了⼀个

Registrar 的组件,这个注解的作用就是将主配置类(@SpringBootConfiguration标注的类)所在的包及其下面所有子包里面所有的组件扫描到IOC容器中。所以说,默认情况下主配置类所在包及其子包以外的组件,Spring IOC容器是扫描不到的。

2.@Import(AutoConfigurationImportSelector.class)

通过@Import导入了AutoConfigurationImportSelector类,而这个类的selectImports方法会通过SpringFactoriesLoader得到大量的配置类。而每个配置类则根据条件化配置类做出决策,以实现自动配置的功能。下面就让我们来看看selectImports方法。

AutoConfigurationImportSelector的selectImports方法

public String[] selectImports(AnnotationMetadata annotationMetadata) {
  //省略部分代码
  List<String> configurations = getCandidateConfigurations(annotationMetadata,
    attributes);
  return StringUtils.toStringArray(configurations);
  }
  protected List<String> getCandidateConfigurations(AnnotationMetadata metadata,
    AnnotationAttributes attributes) {
  List<String> configurations = SpringFactoriesLoader.loadFactoryNames(
    getSpringFactoriesLoaderFactoryClass(), getBeanClassLoader());
  return configurations;
  }
  protected Class<?> getSpringFactoriesLoaderFactoryClass() {
  return EnableAutoConfiguration.class;
  }

如上代码,自动配置核心的代码我都罗列出来了,最核心的就是loadFactoryNames方法,其主要有三步:

1.从classpath下获取所有META-INF/spring.factories这个文件下的信息。

2.将上面获取到的信息封装成Enumeration返回

3.遍历Enumeration,然后获取key为EnableAutoConfiguration下的所有值。

META-INF/spring.factories 这类⽂件是什么就不懵了。当然在很多第三⽅依赖中

都会有这个⽂件,⼀般每导⼊⼀个第三⽅的依赖,除了本⾝的jar包以外,还会有⼀个 xxx-spring-boot-autoConfigure,这个就

是第三⽅依赖⾃⼰编写的⾃动配置类。我们现在就以 spring-boot-autocongigure 这个依赖来说下,其下面的META-INF/spring.factories文件。

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\
org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\

配置类注册到IOC容器的流程图

然后就是实例化这些配置类注册到IOC容器中。流程如下:



以DataSourceAutoConfiguration进行说明

通过上面的方式,所有的自动配置类都被导进主配置类中,但是这么多的配置类,明显有很多我们平常是没有使用到的,没必要全部生效,下面我们以DataSourceAutoConfiguration配置类为例来看一下自动配置类是如何工作的:

@Configuration
@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({ Registrar.class, DataSourcePoolMetadataProvidersConfiguration.class })
public class DataSourceAutoConfiguration {
}

@Configuration 注解表明了DataSourceAutoConfiguration类是一个JavaConfig配置类。@ConditionalOnClass只有当classpath中存在DataSource类或者EmbeddedDatabaseType类时才启动这个配置。@EnableConfigurationProperties这个注解的作用是将将DataSource类注入到IOC容器中。@Import({ Registrar.class, DataSourcePoolMetadataProvidersConfiguration.class })是要导入额外的配置DataSourcePoolMetadataProvidersConfiguration。

DataSourceProperties 类

下面我们就来一个个看一下:首先是DataSourceProperties类:

@ConfigurationProperties(prefix = "spring.datasource")
public class DataSourceProperties
  implements BeanClassLoaderAware, EnvironmentAware, InitializingBean {
  private ClassLoader classLoader;
  private Environment environment;
  private String name = "testdb";
  private boolean generateUniqueName;
  private Class<? extends DataSource> type;
  private String driverClassName;
  private String url;
  }

DataSourceProperties 通过@ConfigurationProperties注解将配置文件的前缀为(spring.datasource)的配置信息与自身的属性绑定。所有在配置⽂件中能配置的属性都是在 xxxProperties 类中封装着;配置⽂件能配置什么就可以参照某个功能对应的这个属性

类。

DataSourcePoolMetadataProvidersConfiguration 类

@Configuration
public class DataSourcePoolMetadataProvidersConfiguration {
  @Configuration
  @ConditionalOnClass(org.apache.tomcat.jdbc.pool.DataSource.class)
  static class TomcatDataSourcePoolMetadataProviderConfiguration {
  }
  @Configuration
  @ConditionalOnClass(HikariDataSource.class)
  static class HikariPoolDataSourceMetadataProviderConfiguration {

DataSourcePoolMetadataProvidersConfiguration 类是数据库连接池提供者的一个配置类。即classpath中存在org.apache.tomcat.jdbc.pool.DataSource.class则使⽤tomcat-jdbc连接池,如果classpath中存在 HikariDataSource.class则使⽤ Hikari连接池,如果存在org.apache.commons.dbcp.BasicDataSource.class则启用dbcp 连接池。

总结

1.SpringBoot启动时会扫描项目所依赖的JAR包,寻找包含spring.factories文件的JAR包。

2.根据spring.factories配置加载EnableAutoConfiguration

其中给容器中自动配置添加组件的时候,会从propeties类中获取配置文件中指定这些属性的值。xxxAutoConfiguration:⾃动配置类给容器中添加组件。xxxProperties:封装配置⽂件中相关属性。

3.根据@Conditional注解的条件,进行自动配置并将Bean注入Spring容器


相关文章
|
21天前
|
人工智能 Java 开发者
【Spring】原理解析:Spring Boot 自动配置
Spring Boot通过“约定优于配置”的设计理念,自动检测项目依赖并根据这些依赖自动装配相应的Bean,从而解放开发者从繁琐的配置工作中解脱出来,专注于业务逻辑实现。
|
3月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
744 0
|
3月前
|
Java Spring
Spring Boot配置的优先级?
在Spring Boot项目中,配置可通过配置文件和外部配置实现。支持的配置文件包括application.properties、application.yml和application.yaml,优先级依次降低。外部配置常用方式有Java系统属性(如-Dserver.port=9001)和命令行参数(如--server.port=10010),其中命令行参数优先级高于系统属性。整体优先级顺序为:命令行参数 &gt; Java系统属性 &gt; application.properties &gt; application.yml &gt; application.yaml。
583 0
|
14天前
|
缓存 Java 应用服务中间件
Spring Boot配置优化:Tomcat+数据库+缓存+日志,全场景教程
本文详解Spring Boot十大核心配置优化技巧,涵盖Tomcat连接池、数据库连接池、Jackson时区、日志管理、缓存策略、异步线程池等关键配置,结合代码示例与通俗解释,助你轻松掌握高并发场景下的性能调优方法,适用于实际项目落地。
203 4
|
21天前
|
传感器 Java 数据库
探索Spring Boot的@Conditional注解的上下文配置
Spring Boot 的 `@Conditional` 注解可根据不同条件动态控制 Bean 的加载,提升应用的灵活性与可配置性。本文深入解析其用法与优势,并结合实例展示如何通过自定义条件类实现环境适配的智能配置。
探索Spring Boot的@Conditional注解的上下文配置
|
14天前
|
Java 数据库 数据安全/隐私保护
Spring Boot四层架构深度解析
本文详解Spring Boot四层架构(Controller-Service-DAO-Database)的核心思想与实战应用,涵盖职责划分、代码结构、依赖注入、事务管理及常见问题解决方案,助力构建高内聚、低耦合的企业级应用。
262 0
|
2月前
|
安全 算法 Java
在Spring Boot中应用Jasypt以加密配置信息。
通过以上步骤,可以在Spring Boot应用中有效地利用Jasypt对配置信息进行加密,这样即使配置文件被泄露,其中的敏感信息也不会直接暴露给攻击者。这是一种在不牺牲操作复杂度的情况下提升应用安全性的简便方法。
709 10
|
3月前
|
前端开发 Java 数据库连接
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
SpringBoot参数校验底层原理和实操。深度历险、深度解析(图解+秒懂+史上最全)
|
3月前
|
机器学习/深度学习 XML Java
【spring boot logback】日志logback格式解析
在 Spring Boot 中,Logback 是默认的日志框架,它支持灵活的日志格式配置。通过配置 logback.xml 文件,可以定义日志的输出格式、日志级别、日志文件路径等。
499 5
|
3月前
|
Java 关系型数据库 数据库连接
Spring Boot项目集成MyBatis Plus操作PostgreSQL全解析
集成 Spring Boot、PostgreSQL 和 MyBatis Plus 的步骤与 MyBatis 类似,只不过在 MyBatis Plus 中提供了更多的便利功能,如自动生成 SQL、分页查询、Wrapper 查询等。
277 3

推荐镜像

更多
  • DNS