当前位置： 首页 > news >正文

【Spring】Spring Boot 自动配置

news 2025/9/29 12:55:26

目录

一、前言

二、什么是 Spring Boot 自动配置？

三、Spring Boot 是如何实现自动配置的？

3.1 @EnableAutoConfiguration：实现自动配置的核心注解

3.2 AutoConfigurationImportSelector：加载自动配置类

第 1 步:

第 2 步：

第 3 步：

第 4 步：

四、如何实现一个 Starter

五、总结

每次问到 Spring Boot， 面试官非常喜欢问这个问题：“讲述一下 Spring Boot 的自动配置原理？”。

我觉得我们可以从以下几个方面回答：

  1. 什么是 Spring Boot 自动配置？
  2. Spring Boot 是如何实现自动配置的？如何实现按需加载？
  3. 如何实现一个 Starter？

由于篇幅问题，这篇文章并没有深入源码讲解，我会在后续的笔记中讲解Spring Boot 自动配置底层源代码。

一、前言

使用过 Spring 的小伙伴，一定有被 XML 配置统治的恐惧。即使 Spring 后面引入了基于注解的配置，我们在开启某些 Spring 特性或者引入第三方依赖的时候，还是需要用 XML 或 Java 进行显式配置。

举个例子。没有 Spring Boot 的时候，我们写一个 RestFul Web 服务，还首先需要进行如下配置。

@Configuration
public class RESTConfiguration {@Beanpublic View jsonTemplate() {MappingJackson2JsonView view = new MappingJackson2JsonView();view.setPrettyPrint(true);return view;}@Beanpublic ViewResolver viewResolver() {return new BeanNameViewResolver();}
}

 

spring-servlet.xml

<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"xmlns:mvc="http://www.springframework.org/schema/mvc"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsdhttp://www.springframework.org/schema/context/ http://www.springframework.org/schema/context/spring-context.xsdhttp://www.springframework.org/schema/mvc/ http://www.springframework.org/schema/mvc/spring-mvc.xsd"><context:component-scan base-package="com.howtodoinjava.demo" /><mvc:annotation-driven /><!-- JSON Support --><bean name="viewResolver" class="org.springframework.web.servlet.view.BeanNameViewResolver"/><bean name="jsonTemplate" class="org.springframework.web.servlet.view.json.MappingJackson2JsonView"/>
</beans>

但是，Spring Boot 项目，我们只需要添加相关依赖，无需配置，通过启动下面的 main 方法即可。

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

并且，我们通过 Spring Boot 的全局配置文件 application.properties或application.yml即可对项目进行设置比如更换端口号，配置 JPA 属性等等。

为什么 Spring Boot 使用起来这么酸爽呢？ 这是因为其使用便捷，开箱即用。能做到这点这得益于其自动配置。自动配置可以说是 Spring Boot 的核心，那究竟什么是自动配置呢？

二、什么是 Spring Boot 自动配置？

我们现在提到自动配置的时候，一般会和 Spring Boot 联系在一起。但是，实际上 Spring Framework 早就实现了这个功能。Spring Boot 只是在其基础上，通过 SPI 的方式，做了进一步优化。

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

自 Spring Boot 3.0 开始，自动配置包的路径从META-INF/spring.factories 修改为 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports。

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

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

引入 starter 之后，我们通过少量注解和一些简单的配置就能使用第三方组件提供的功能了。每个starter内部做了工作，比如Mybatis的启动器默认内置了可用的SqlSessionFactory。

在我看来，自动配置可以简单理解为：通过注解或者一些简单的配置就能在 Spring Boot 的帮助下实现某块功能。

🛈

信息

注意：千万不要把自动配置（AutoConfiguration）和自动装配（AutoWire）的概念搞混，自动装配是依赖注入。

三、Spring Boot 是如何实现自动配置的？

我们先看一下 Spring Boot 的核心注解 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) })
// AutoConfigurationExcludeFilter的作用是扫描到的配置类名字如果在自动配置类名集合中，就不解析
public @interface SpringBootApplication {
}@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration // 实际上它也是一个配置类
@Indexed
public @interface SpringBootConfiguration {
}

大概可以把 @SpringBootApplication看作是 @Configuration、@EnableAutoConfiguration、@ComponentScan 注解的集合。根据 Spring Boot 官网，这三个注解的作用分别是：

  • @EnableAutoConfiguration：启用 Spring Boot 的自动配置机制。
  • @Configuration：允许在上下文中注册额外的 bean 或导入其他配置类，其实就是将类声明成配置类。
  • @ComponentScan：扫描被@Component（@Service、@Controller）注解的 bean，注解默认会扫描启动类所在的包下所有的类 ，可以自定义不扫描某些 bean。如下图所示，容器中将排除TypeExcludeFilter和AutoConfigurationExcludeFilter。

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

3.1 @EnableAutoConfiguration：实现自动配置的核心注解

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

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage // 作用：将main包下的所有组件注册到容器中
@Import({AutoConfigurationImportSelector.class}) // 加载自动配置类 xxxAutoconfiguration。@Import注解的作用是将指定的类导入到当前类中，这里的作用是加载自动配置类。
public @interface EnableAutoConfiguration {// 是否启用自动配置，默认为trueString ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";// 排除的配置类，被排除的类将不会被自动配置Class<?>[] exclude() default {};// 排除的配置类名String[] excludeName() default {};
}

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

3.2 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>.获取所有需要装配的beanAutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(autoConfigurationMetadata, annotationMetadata);return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}
}

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

该方法调用链如下：

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

private static final AutoConfigurationEntry EMPTY_ENTRY = new AutoConfigurationEntry();AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata, AnnotationMetadata annotationMetadata) {// 第一步：判断自动配置是否启用if (!this.isEnabled(annotationMetadata)) {return EMPTY_ENTRY;} else {// 第二步：获取EnableAutoConfiguration注解中的 exclude 和 excludeName这两个属性，用于排除不需要的自动配置的类AnnotationAttributes attributes = this.getAttributes(annotationMetadata);// 第三步：获取所有需要的自动配置的类List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);// 第四步：过滤掉多余的自动配置类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。

第 3 步：

获取需要自动装配的所有配置类，即读取META-INF/spring.factories文件中的内容。

读取Spring Boot引入的一些依赖的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 中的所有条件都满足，该类才会生效。下面我们以RabbitMQ依赖中的RabbitAutoConfiguration自动配置类来讲解一下：

@Configuration
/** 这是一个条件装配注解，* 它表示只有当 classpath 中存在 RabbitTemplate 和 Channel 类时，才会加载该配置类。* 条件装配通常用于在特定条件下自动配置 Bean。*/
@ConditionalOnClass({ RabbitTemplate.class, Channel.class })
/** 该注解用来启用特定类型的配置属性类，即 RabbitProperties 类，以便在配置类中使用。* 这意味着可以通过注入 RabbitProperties 类来访问关于 RabbitMQ 的配置属性。*/
@EnableConfigurationProperties(RabbitProperties.class)
/** 这个注解用于导入额外的配置类，即 RabbitAnnotationDrivenConfiguration 类。* 通过导入其他配置类，可以将其里面定义的 Bean 注入到当前的配置类中。*/
@Import(RabbitAnnotationDrivenConfiguration.class)
public class RabbitAutoConfiguration {
}

这段代码定义了一个根据条件自动加载 RabbitMQ 相关配置的配置类。当 classpath 中存在 RabbitTemplate 和 Channel 类时，将加载并使用该配置类。同时，通过@EnableConfigurationProperties 注解启用了对 RabbitProperties 的配置属性支持，并导入了 RabbitAnnotationDrivenConfiguration 类的一些额外配置。

Spring Boot 提供的条件注解：

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

四、如何实现一个 Starter

光说不练假把式，现在就来撸一个 starter，实现自定义线程池。

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

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

第三步，创建ThreadPoolAutoConfiguration自动配置类

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

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

测试通过！！！

五、总结

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

相关文章：【Spring】Spring Boot启动过程源码解析_springboot 启动过程中的源码解析-CSDN博客

http://www.dtcms.com/a/420163.html

相关文章：

  • 青浦网站优化前程无忧做网站多少钱
  • 常熟港口建设费申报网站怎么网站建设
  • 文件的读写 二进制形式打开文件
  • 吴忠住房和城乡建设网站成都官网seo技术
  • 惠州建网站服务天津专业网站制作流程优势
  • 北京联通网站备案php 网站模板
  • 清河做网站哪里好齐河网站建设
  • CodeBuddy CLI工具深度测评：从零到一实现鸿蒙游戏开发实践
  • 网站前后台模板服务专业的网站建设服务
  • 资讯网站策划怎么写龙岗公司网站
  • fr后缀网站在线做logo
  • 茶楼 网站免费网站建设域名
  • NeRF+3DGS——提升渲染质量与压缩模型参数
  • Appcelerator打包ipa有哪些优势
  • 五华建设银行网站宁波seo网络推广优化价格
  • 网站目录结构说明上海网络建站模板
  • 佛山网站制作流程推广网站实例
  • 阿里云服务器做网站djangowordpress后台500错误
  • Nginx proxy_pass 末尾斜杠（/）
  • 【MySQL】图书管理系统
  • 1.简述网站建设流程网站内页做友链
  • 做淘宝客要自己的网站建设网站的简单编程语言
  • 数据结构 01 线性表
  • 为什么有的网站打不开WordPress京东自动转链插件
  • MySQL——数据库基础与库的操作
  • 网站建站上市公司国外论文类网站有哪些方面
  • 网站建设有哪些分工分建筑网站、
  • asp网站改php网站方法wordpress禁用修正版
  • 堆 动态内存 超级玛丽demo7
  • 空壳网站查询WordPress下拉菜单栏