作为 Java 后端开发者我们每天都在享受 Spring Boot 带来的便利引入一个spring-boot-starter-web依赖就能直接写 Controller 接收 HTTP 请求引入spring-boot-starter-data-redis就能直接操作 Redis。不需要任何 XML 配置不需要手动注册 Bean一切都自动完成了。但很多人用了很多年 Spring Boot却始终没有搞懂一个最核心的问题为什么引入一个 starter 就能自动配置好所有东西Spring Boot 是怎么知道我需要哪些 Bean 的这就是 Spring Boot 的核心魔法 ——自动装配。它不仅是 Spring Boot 最成功的特性也是面试中 100% 会被深挖的考点Spring Boot 自动装配的底层原理是什么EnableAutoConfiguration注解到底做了什么Spring Boot 3.x 为什么废弃了spring.factories如何自定义一个自动配置类如何开发一个属于自己的 Spring Boot Starter这篇文章我们就从核心原理→执行流程→自定义自动配置→自定义 Starter 实战四个维度彻底搞懂 Spring Boot 自动装配。不仅会讲清楚理论更会提供可直接落地的代码示例和最佳实践让你看完既能轻松应对面试又能在实际项目中封装自己的通用组件。一、先搞懂什么是自动装配自动装配简单来说就是Spring Boot 根据我们引入的依赖自动将需要的 Bean 注册到 Spring 容器中。我们不需要手动编写任何配置代码只需要引入对应的 starter 依赖Spring Boot 就会自动完成所有的配置工作。举个最经典的例子当我们在项目中引入spring-boot-starter-web依赖后Spring Boot 会自动做以下事情自动配置DispatcherServlet自动配置Tomcat容器自动配置RequestMappingHandlerMapping和RequestMappingHandlerAdapter自动配置HttpMessageConverter自动配置静态资源映射等等...所有这些配置在传统的 Spring MVC 中需要我们手动编写大量的 XML 或 Java 配置但在 Spring Boot 中只需要引入一个依赖就全部搞定了。这就是自动装配的威力。自动装配的核心思想自动装配的核心思想是约定大于配置Convention over Configuration。Spring Boot 制定了一套默认的约定默认的配置文件是application.yml或application.properties默认的包扫描路径是主启动类所在的包及其子包默认的 Web 容器是 Tomcat默认的端口是 8080等等...只要我们遵循这些约定Spring Boot 就能自动完成大部分配置工作。只有当我们需要修改默认配置时才需要在配置文件中进行修改。这大大减少了配置代码提高了开发效率。二、自动装配的核心原理Spring Boot 自动装配的核心是 **EnableAutoConfiguration** 注解。这个注解开启了自动装配功能是整个自动装配机制的入口。1. EnableAutoConfiguration 注解我们先来看一下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) }) public interface SpringBootApplication { // ... }可以看到SpringBootApplication是一个组合注解它包含了三个核心注解SpringBootConfiguration标记这是一个 Spring Boot 配置类EnableAutoConfiguration开启自动装配功能ComponentScan开启组件扫描其中EnableAutoConfiguration是最关键的注解它通过Import注解导入了AutoConfigurationImportSelector类这个类负责加载所有的自动配置类。2. 重要更新Spring Boot 3.x 废弃了 spring.factories非常重要的一点spring.factories是 Spring Boot 2.x 及更早版本的 SPI 配置方式。从Spring Boot 2.7开始官方已经将其标记为废弃从Spring Boot 3.0开始已经完全移除了对spring.factories中自动配置项的支持改用了全新的配置方式。新旧配置方式对比特性Spring Boot 2.xSpring Boot 3.x配置文件META-INF/spring.factoriesMETA-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件格式键值对形式纯类名列表每行一个加载器SpringFactoriesLoaderImportCandidates模块化支持❌✅GraalVM 支持❌✅性能较低较高为什么要废弃 spring.factoriesSpring Boot 官方废弃 spring.factories 主要有以下几个原因性能优化新的 imports 文件机制是静态加载不需要运行时扫描所有 jar 包启动速度更快模块化支持与 Java 9 的模块系统module-info.java兼容性更好类型安全IDE 可以直接校验类名的正确性支持自动补全和导航GraalVM 原生支持新机制支持 AOT 提前编译是 Spring Boot 3.x 原生镜像支持的基础结构更清晰每个扩展点有自己独立的配置文件不再是所有配置都挤在一个 spring.factories 文件中3. 自动装配的完整执行流程Spring Boot 自动装配的完整执行流程可以分为以下 7 个步骤应用启动执行SpringApplication.run()方法启动 Spring Boot 应用加载主配置类解析主启动类上的SpringBootApplication注解开启自动装配EnableAutoConfiguration注解导入AutoConfigurationImportSelector类加载自动配置类AutoConfigurationImportSelector从配置文件中加载所有的自动配置类Spring Boot 2.x从META-INF/spring.factories文件中加载Spring Boot 3.x从META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中加载条件过滤根据条件注解Conditional系列注解过滤掉不符合条件的自动配置类注册 Bean将符合条件的自动配置类中的 Bean 注册到 Spring 容器中完成装配Spring 容器自动完成这些 Bean 的实例化、依赖注入和初始化应用启动完成4. 自动装配的灵魂条件注解条件注解是自动装配的灵魂它允许我们根据特定的条件来决定是否注册一个 Bean。Spring Boot 提供了大量的条件注解常用的有注解作用ConditionalOnClass当类路径下存在指定的类时注册 BeanConditionalOnMissingClass当类路径下不存在指定的类时注册 BeanConditionalOnBean当容器中存在指定的 Bean 时注册 BeanConditionalOnMissingBean当容器中不存在指定的 Bean 时注册 BeanConditionalOnProperty当配置文件中存在指定的属性时注册 BeanConditionalOnResource当类路径下存在指定的资源时注册 BeanConditionalOnWebApplication当是 Web 应用时注册 BeanConditionalOnNotWebApplication当不是 Web 应用时注册 BeanConditionalOnJava当 Java 版本符合要求时注册 Bean这些条件注解可以组合使用实现非常灵活的条件判断。例如ConditionalOnClassConditionalOnMissingBean的组合就是 当类路径下存在某个类并且容器中没有对应的 Bean 时才注册这个 Bean这是自动配置中最常用的组合。三、实战一自定义自动配置类理解了自动装配的原理我们先来实战一下自定义一个简单的自动配置类。我们要实现的功能是当类路径下存在HelloService类时自动将HelloService注册到 Spring 容器中并且可以通过配置文件自定义问候语。步骤 1创建 Maven 项目创建一个普通的 Maven 项目引入 Spring Boot 的依赖dependencies dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-autoconfigure/artifactId version3.2.5/version /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-configuration-processor/artifactId version3.2.5/version optionaltrue/optional /dependency /dependencies步骤 2编写配置属性类创建HelloProperties类用于绑定配置文件中的属性ConfigurationProperties(prefix hello) public class HelloProperties { /** * 问候语默认值为Hello, World! */ private String message Hello, World!; public String getMessage() { return message; } public void setMessage(String message) { this.message message; } }ConfigurationProperties注解会将配置文件中以hello为前缀的属性绑定到这个类的字段上。步骤 3编写服务类创建HelloService类这是我们要自动注册的 Beanpublic class HelloService { private final HelloProperties helloProperties; // 使用构造方法注入配置属性 public HelloService(HelloProperties helloProperties) { this.helloProperties helloProperties; } public String sayHello(String name) { return helloProperties.getMessage() name; } }步骤 4编写自动配置类创建HelloAutoConfiguration类这是自动配置的核心类// Spring Boot 3.x推荐使用AutoConfiguration替代Configuration AutoConfiguration // 当类路径下存在HelloService类时才启用这个自动配置 ConditionalOnClass(HelloService.class) // 启用HelloProperties的配置绑定 EnableConfigurationProperties(HelloProperties.class) public class HelloAutoConfiguration { // 当容器中不存在HelloService Bean时才注册这个Bean Bean ConditionalOnMissingBean public HelloService helloService(HelloProperties helloProperties) { return new HelloService(helloProperties); } }步骤 5配置自动配置类这是新旧版本差异最大的地方。Spring Boot 3.x 版本在src/main/resources/META-INF/spring目录下创建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件内容为自动配置类的全限定名com.example.hello.HelloAutoConfigurationSpring Boot 2.x 版本在src/main/resources/META-INF目录下创建spring.factories文件org.springframework.boot.autoconfigure.EnableAutoConfiguration\ com.example.hello.HelloAutoConfiguration步骤 6打包安装执行mvn install命令将项目安装到本地 Maven 仓库。步骤 7测试自动配置创建一个 Spring Boot 项目引入我们刚才打包的依赖dependency groupIdcom.example/groupId artifactIdhello-autoconfigure/artifactId version1.0.0/version /dependency在application.yml中配置问候语hello: message: 你好编写测试类SpringBootTest public class HelloTest { Autowired(required false) private HelloService helloService; Test public void testSayHello() { if (helloService ! null) { String result helloService.sayHello(Spring Boot); System.out.println(result); // 输出你好 Spring Boot } else { System.out.println(HelloService没有被自动注册); } } }运行测试成功输出结果说明我们的自定义自动配置已经生效了四、实战二自定义 Spring Boot Starter刚才我们实现了一个简单的自动配置类但在实际项目中我们通常会将自动配置和相关依赖打包成一个 Starter方便其他项目使用。1. 什么是 Spring Boot StarterSpring Boot Starter 本质上是一个依赖描述符它包含了一组相关的依赖和自动配置类。当我们引入一个 Starter 时它会自动引入所有需要的依赖并且自动完成配置。一个完整的 Spring Boot Starter 通常包含两个部分autoconfigure 模块包含自动配置类、配置属性类等starter 模块只包含 pom.xml用于引入 autoconfigure 模块和相关依赖这种分离的设计可以让自动配置和依赖管理分开更加灵活。2. 自定义 Starter 的命名规范Spring 官方的 Starter 命名格式是spring-boot-starter-xxx比如spring-boot-starter-web、spring-boot-starter-data-redis。第三方自定义的 Starter 命名格式是xxx-spring-boot-starter比如mybatis-spring-boot-starter、druid-spring-boot-starter。我们要实现的 Starter 命名为hello-spring-boot-starter。3. 项目结构我们的项目结构如下hello-spring-boot-starter ├── hello-spring-boot-autoconfigure │ ├── src │ │ ├── main │ │ │ ├── java │ │ │ │ └── com │ │ │ │ └── example │ │ │ │ └── hello │ │ │ │ ├── HelloAutoConfiguration.java │ │ │ │ ├── HelloProperties.java │ │ │ │ └── HelloService.java │ │ │ └── resources │ │ │ └── META-INF │ │ │ └── spring │ │ │ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports │ │ └── test │ └── pom.xml ├── hello-spring-boot-starter │ ├── src │ │ └── main │ │ └── resources │ │ └── META-INF │ │ └── spring │ │ └── additional-spring-configuration-metadata.json │ └── pom.xml └── pom.xml4. 实现 autoconfigure 模块autoconfigure 模块的内容和我们刚才实现的自动配置类完全一样这里就不再重复了。5. 实现 starter 模块starter 模块只需要一个 pom.xml 文件用于引入 autoconfigure 模块和相关依赖?xml version1.0 encodingUTF-8? project xmlnshttp://maven.apache.org/POM/4.0.0 xmlns:xsihttp://www.w3.org/2001/XMLSchema-instance xsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd parent groupIdcom.example/groupId artifactIdhello-spring-boot-starter-parent/artifactId version1.0.0/version /parent modelVersion4.0.0/modelVersion artifactIdhello-spring-boot-starter/artifactId nameHello Spring Boot Starter/name description自定义Spring Boot Starter示例/description dependencies !-- 引入autoconfigure模块 -- dependency groupIdcom.example/groupId artifactIdhello-spring-boot-autoconfigure/artifactId version1.0.0/version /dependency /dependencies /project6. 配置元数据可选为了让 IDE 能够识别我们的配置属性提供自动补全和提示功能我们可以在 starter 模块的src/main/resources/META-INF/spring目录下创建additional-spring-configuration-metadata.json文件{ properties: [ { name: hello.message, type: java.lang.String, description: 问候语, defaultValue: Hello, World! } ] }这样当用户在application.yml中输入hello.message时IDE 会自动提示这个属性的含义和默认值。7. 打包安装在根目录执行mvn install命令将两个模块都安装到本地 Maven 仓库。8. 测试使用创建一个 Spring Boot 项目引入我们自定义的 Starterdependency groupIdcom.example/groupId artifactIdhello-spring-boot-starter/artifactId version1.0.0/version /dependency然后就可以像使用官方 Starter 一样使用我们的自定义 Starter 了五、最佳实践与避坑指南1. 自动配置最佳实践使用 AutoConfiguration 注解Spring Boot 3.x 推荐使用AutoConfiguration替代Configuration来标记自动配置类合理使用条件注解使用ConditionalOnClass、ConditionalOnMissingBean等条件注解让自动配置更加灵活提供合理的默认值配置属性应该提供合理的默认值让用户不需要任何配置就能使用支持配置覆盖允许用户通过配置文件覆盖默认值避免硬编码所有可配置的参数都应该放到配置属性类中2. Starter 开发最佳实践遵循命名规范第三方 Starter 命名为xxx-spring-boot-starter分离 autoconfigure 和 starter 模块将自动配置和依赖管理分开更加灵活最小依赖原则只引入必要的依赖避免引入不必要的依赖提供配置元数据添加additional-spring-configuration-metadata.json文件提供 IDE 提示编写文档提供详细的使用文档说明如何配置和使用 Starter3. 常见坑与解决方案坑 1自动配置不生效常见原因Spring Boot 3.x 中仍然使用旧的spring.factories配置方式配置文件路径或文件名错误大小写敏感条件注解不满足比如类路径下缺少必要的依赖主配置类的包扫描范围不包含自动配置类解决方案Spring Boot 3.x 必须使用新的AutoConfiguration.imports文件检查配置文件的路径和文件名是否完全正确检查条件注解是否满足使用SpringBootApplication(scanBasePackages com.example)指定包扫描范围坑 2自定义 Bean 覆盖了自动配置的 Bean问题当我们自定义了一个和自动配置同名的 Bean 时会覆盖自动配置的 Bean。解决方案如果需要覆盖自动配置的 Bean明确使用Bean注解注册自己的 Bean如果不需要覆盖避免使用相同的 Bean 名称。坑 3条件注解使用错误常见错误ConditionalOnBean和ConditionalOnMissingBean的顺序搞反ConditionalOnProperty的属性名写错条件注解的位置放错比如放在方法上而不是类上解决方案仔细阅读条件注解的文档确保使用正确。六、高频面试题解答问Spring Boot 自动装配的底层原理是什么答Spring Boot 自动装配的核心是EnableAutoConfiguration注解。它通过 SPI 机制从配置文件中加载所有的自动配置类然后根据条件注解过滤掉不符合条件的类最后将符合条件的自动配置类中的 Bean 注册到 Spring 容器中。问Spring Boot 3.x 为什么废弃了 spring.factories答Spring Boot 3.x 废弃 spring.factories 主要是为了性能优化、模块化支持、类型安全和 GraalVM 原生支持。新的AutoConfiguration.imports文件机制是静态加载启动速度更快与 Java 模块系统兼容性更好。问spring.factories 和 AutoConfiguration.imports 有什么区别答spring.factories 是键值对形式支持多个扩展点AutoConfiguration.imports 是纯类名列表只用于自动配置。AutoConfiguration.imports 性能更好类型更安全是 Spring Boot 3.x 推荐的方式。问如何自定义一个 Spring Boot Starter答自定义 Spring Boot Starter 的步骤1. 创建 autoconfigure 模块编写自动配置类、配置属性类和服务类2. 创建 starter 模块引入 autoconfigure 模块和相关依赖3. 配置自动配置文件4. 打包安装。问ConditionalOnMissingBean 注解的作用是什么答ConditionalOnMissingBean注解的作用是当容器中不存在指定的 Bean 时才注册这个 Bean。它允许用户自定义 Bean 来覆盖自动配置的 Bean是自动配置中最常用的注解之一。问自动配置的执行顺序是怎样的答自动配置类的执行顺序可以通过AutoConfigureBefore、AutoConfigureAfter和AutoConfigureOrder注解来控制。默认情况下自动配置类的执行顺序是不确定的。七、总结Spring Boot 自动装配是 Spring Boot 最成功的特性之一它通过约定大于配置的思想大大简化了 Spring 应用的开发和配置。回顾一下全文的核心内容自动装配的核心是EnableAutoConfiguration注解Spring Boot 3.x 废弃了spring.factories改用了新的AutoConfiguration.imports文件格式条件注解是自动装配的灵魂允许我们根据特定条件决定是否注册 Bean自定义自动配置只需要编写自动配置类和配置文件自定义 Starter 需要分离 autoconfigure 和 starter 模块遵循命名规范理解了自动装配的原理你就不再是只会用 Spring Boot 的 API 调用者而是真正理解了 Spring Boot 的设计哲学能够自己开发通用组件提高团队的开发效率。
Spring Boot 自动装配深度解密：从原理到自定义 Starter 实战
作为 Java 后端开发者我们每天都在享受 Spring Boot 带来的便利引入一个spring-boot-starter-web依赖就能直接写 Controller 接收 HTTP 请求引入spring-boot-starter-data-redis就能直接操作 Redis。不需要任何 XML 配置不需要手动注册 Bean一切都自动完成了。但很多人用了很多年 Spring Boot却始终没有搞懂一个最核心的问题为什么引入一个 starter 就能自动配置好所有东西Spring Boot 是怎么知道我需要哪些 Bean 的这就是 Spring Boot 的核心魔法 ——自动装配。它不仅是 Spring Boot 最成功的特性也是面试中 100% 会被深挖的考点Spring Boot 自动装配的底层原理是什么EnableAutoConfiguration注解到底做了什么Spring Boot 3.x 为什么废弃了spring.factories如何自定义一个自动配置类如何开发一个属于自己的 Spring Boot Starter这篇文章我们就从核心原理→执行流程→自定义自动配置→自定义 Starter 实战四个维度彻底搞懂 Spring Boot 自动装配。不仅会讲清楚理论更会提供可直接落地的代码示例和最佳实践让你看完既能轻松应对面试又能在实际项目中封装自己的通用组件。一、先搞懂什么是自动装配自动装配简单来说就是Spring Boot 根据我们引入的依赖自动将需要的 Bean 注册到 Spring 容器中。我们不需要手动编写任何配置代码只需要引入对应的 starter 依赖Spring Boot 就会自动完成所有的配置工作。举个最经典的例子当我们在项目中引入spring-boot-starter-web依赖后Spring Boot 会自动做以下事情自动配置DispatcherServlet自动配置Tomcat容器自动配置RequestMappingHandlerMapping和RequestMappingHandlerAdapter自动配置HttpMessageConverter自动配置静态资源映射等等...所有这些配置在传统的 Spring MVC 中需要我们手动编写大量的 XML 或 Java 配置但在 Spring Boot 中只需要引入一个依赖就全部搞定了。这就是自动装配的威力。自动装配的核心思想自动装配的核心思想是约定大于配置Convention over Configuration。Spring Boot 制定了一套默认的约定默认的配置文件是application.yml或application.properties默认的包扫描路径是主启动类所在的包及其子包默认的 Web 容器是 Tomcat默认的端口是 8080等等...只要我们遵循这些约定Spring Boot 就能自动完成大部分配置工作。只有当我们需要修改默认配置时才需要在配置文件中进行修改。这大大减少了配置代码提高了开发效率。二、自动装配的核心原理Spring Boot 自动装配的核心是 **EnableAutoConfiguration** 注解。这个注解开启了自动装配功能是整个自动装配机制的入口。1. EnableAutoConfiguration 注解我们先来看一下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) }) public interface SpringBootApplication { // ... }可以看到SpringBootApplication是一个组合注解它包含了三个核心注解SpringBootConfiguration标记这是一个 Spring Boot 配置类EnableAutoConfiguration开启自动装配功能ComponentScan开启组件扫描其中EnableAutoConfiguration是最关键的注解它通过Import注解导入了AutoConfigurationImportSelector类这个类负责加载所有的自动配置类。2. 重要更新Spring Boot 3.x 废弃了 spring.factories非常重要的一点spring.factories是 Spring Boot 2.x 及更早版本的 SPI 配置方式。从Spring Boot 2.7开始官方已经将其标记为废弃从Spring Boot 3.0开始已经完全移除了对spring.factories中自动配置项的支持改用了全新的配置方式。新旧配置方式对比特性Spring Boot 2.xSpring Boot 3.x配置文件META-INF/spring.factoriesMETA-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件格式键值对形式纯类名列表每行一个加载器SpringFactoriesLoaderImportCandidates模块化支持❌✅GraalVM 支持❌✅性能较低较高为什么要废弃 spring.factoriesSpring Boot 官方废弃 spring.factories 主要有以下几个原因性能优化新的 imports 文件机制是静态加载不需要运行时扫描所有 jar 包启动速度更快模块化支持与 Java 9 的模块系统module-info.java兼容性更好类型安全IDE 可以直接校验类名的正确性支持自动补全和导航GraalVM 原生支持新机制支持 AOT 提前编译是 Spring Boot 3.x 原生镜像支持的基础结构更清晰每个扩展点有自己独立的配置文件不再是所有配置都挤在一个 spring.factories 文件中3. 自动装配的完整执行流程Spring Boot 自动装配的完整执行流程可以分为以下 7 个步骤应用启动执行SpringApplication.run()方法启动 Spring Boot 应用加载主配置类解析主启动类上的SpringBootApplication注解开启自动装配EnableAutoConfiguration注解导入AutoConfigurationImportSelector类加载自动配置类AutoConfigurationImportSelector从配置文件中加载所有的自动配置类Spring Boot 2.x从META-INF/spring.factories文件中加载Spring Boot 3.x从META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件中加载条件过滤根据条件注解Conditional系列注解过滤掉不符合条件的自动配置类注册 Bean将符合条件的自动配置类中的 Bean 注册到 Spring 容器中完成装配Spring 容器自动完成这些 Bean 的实例化、依赖注入和初始化应用启动完成4. 自动装配的灵魂条件注解条件注解是自动装配的灵魂它允许我们根据特定的条件来决定是否注册一个 Bean。Spring Boot 提供了大量的条件注解常用的有注解作用ConditionalOnClass当类路径下存在指定的类时注册 BeanConditionalOnMissingClass当类路径下不存在指定的类时注册 BeanConditionalOnBean当容器中存在指定的 Bean 时注册 BeanConditionalOnMissingBean当容器中不存在指定的 Bean 时注册 BeanConditionalOnProperty当配置文件中存在指定的属性时注册 BeanConditionalOnResource当类路径下存在指定的资源时注册 BeanConditionalOnWebApplication当是 Web 应用时注册 BeanConditionalOnNotWebApplication当不是 Web 应用时注册 BeanConditionalOnJava当 Java 版本符合要求时注册 Bean这些条件注解可以组合使用实现非常灵活的条件判断。例如ConditionalOnClassConditionalOnMissingBean的组合就是 当类路径下存在某个类并且容器中没有对应的 Bean 时才注册这个 Bean这是自动配置中最常用的组合。三、实战一自定义自动配置类理解了自动装配的原理我们先来实战一下自定义一个简单的自动配置类。我们要实现的功能是当类路径下存在HelloService类时自动将HelloService注册到 Spring 容器中并且可以通过配置文件自定义问候语。步骤 1创建 Maven 项目创建一个普通的 Maven 项目引入 Spring Boot 的依赖dependencies dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-autoconfigure/artifactId version3.2.5/version /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-configuration-processor/artifactId version3.2.5/version optionaltrue/optional /dependency /dependencies步骤 2编写配置属性类创建HelloProperties类用于绑定配置文件中的属性ConfigurationProperties(prefix hello) public class HelloProperties { /** * 问候语默认值为Hello, World! */ private String message Hello, World!; public String getMessage() { return message; } public void setMessage(String message) { this.message message; } }ConfigurationProperties注解会将配置文件中以hello为前缀的属性绑定到这个类的字段上。步骤 3编写服务类创建HelloService类这是我们要自动注册的 Beanpublic class HelloService { private final HelloProperties helloProperties; // 使用构造方法注入配置属性 public HelloService(HelloProperties helloProperties) { this.helloProperties helloProperties; } public String sayHello(String name) { return helloProperties.getMessage() name; } }步骤 4编写自动配置类创建HelloAutoConfiguration类这是自动配置的核心类// Spring Boot 3.x推荐使用AutoConfiguration替代Configuration AutoConfiguration // 当类路径下存在HelloService类时才启用这个自动配置 ConditionalOnClass(HelloService.class) // 启用HelloProperties的配置绑定 EnableConfigurationProperties(HelloProperties.class) public class HelloAutoConfiguration { // 当容器中不存在HelloService Bean时才注册这个Bean Bean ConditionalOnMissingBean public HelloService helloService(HelloProperties helloProperties) { return new HelloService(helloProperties); } }步骤 5配置自动配置类这是新旧版本差异最大的地方。Spring Boot 3.x 版本在src/main/resources/META-INF/spring目录下创建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件内容为自动配置类的全限定名com.example.hello.HelloAutoConfigurationSpring Boot 2.x 版本在src/main/resources/META-INF目录下创建spring.factories文件org.springframework.boot.autoconfigure.EnableAutoConfiguration\ com.example.hello.HelloAutoConfiguration步骤 6打包安装执行mvn install命令将项目安装到本地 Maven 仓库。步骤 7测试自动配置创建一个 Spring Boot 项目引入我们刚才打包的依赖dependency groupIdcom.example/groupId artifactIdhello-autoconfigure/artifactId version1.0.0/version /dependency在application.yml中配置问候语hello: message: 你好编写测试类SpringBootTest public class HelloTest { Autowired(required false) private HelloService helloService; Test public void testSayHello() { if (helloService ! null) { String result helloService.sayHello(Spring Boot); System.out.println(result); // 输出你好 Spring Boot } else { System.out.println(HelloService没有被自动注册); } } }运行测试成功输出结果说明我们的自定义自动配置已经生效了四、实战二自定义 Spring Boot Starter刚才我们实现了一个简单的自动配置类但在实际项目中我们通常会将自动配置和相关依赖打包成一个 Starter方便其他项目使用。1. 什么是 Spring Boot StarterSpring Boot Starter 本质上是一个依赖描述符它包含了一组相关的依赖和自动配置类。当我们引入一个 Starter 时它会自动引入所有需要的依赖并且自动完成配置。一个完整的 Spring Boot Starter 通常包含两个部分autoconfigure 模块包含自动配置类、配置属性类等starter 模块只包含 pom.xml用于引入 autoconfigure 模块和相关依赖这种分离的设计可以让自动配置和依赖管理分开更加灵活。2. 自定义 Starter 的命名规范Spring 官方的 Starter 命名格式是spring-boot-starter-xxx比如spring-boot-starter-web、spring-boot-starter-data-redis。第三方自定义的 Starter 命名格式是xxx-spring-boot-starter比如mybatis-spring-boot-starter、druid-spring-boot-starter。我们要实现的 Starter 命名为hello-spring-boot-starter。3. 项目结构我们的项目结构如下hello-spring-boot-starter ├── hello-spring-boot-autoconfigure │ ├── src │ │ ├── main │ │ │ ├── java │ │ │ │ └── com │ │ │ │ └── example │ │ │ │ └── hello │ │ │ │ ├── HelloAutoConfiguration.java │ │ │ │ ├── HelloProperties.java │ │ │ │ └── HelloService.java │ │ │ └── resources │ │ │ └── META-INF │ │ │ └── spring │ │ │ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports │ │ └── test │ └── pom.xml ├── hello-spring-boot-starter │ ├── src │ │ └── main │ │ └── resources │ │ └── META-INF │ │ └── spring │ │ └── additional-spring-configuration-metadata.json │ └── pom.xml └── pom.xml4. 实现 autoconfigure 模块autoconfigure 模块的内容和我们刚才实现的自动配置类完全一样这里就不再重复了。5. 实现 starter 模块starter 模块只需要一个 pom.xml 文件用于引入 autoconfigure 模块和相关依赖?xml version1.0 encodingUTF-8? project xmlnshttp://maven.apache.org/POM/4.0.0 xmlns:xsihttp://www.w3.org/2001/XMLSchema-instance xsi:schemaLocationhttp://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd parent groupIdcom.example/groupId artifactIdhello-spring-boot-starter-parent/artifactId version1.0.0/version /parent modelVersion4.0.0/modelVersion artifactIdhello-spring-boot-starter/artifactId nameHello Spring Boot Starter/name description自定义Spring Boot Starter示例/description dependencies !-- 引入autoconfigure模块 -- dependency groupIdcom.example/groupId artifactIdhello-spring-boot-autoconfigure/artifactId version1.0.0/version /dependency /dependencies /project6. 配置元数据可选为了让 IDE 能够识别我们的配置属性提供自动补全和提示功能我们可以在 starter 模块的src/main/resources/META-INF/spring目录下创建additional-spring-configuration-metadata.json文件{ properties: [ { name: hello.message, type: java.lang.String, description: 问候语, defaultValue: Hello, World! } ] }这样当用户在application.yml中输入hello.message时IDE 会自动提示这个属性的含义和默认值。7. 打包安装在根目录执行mvn install命令将两个模块都安装到本地 Maven 仓库。8. 测试使用创建一个 Spring Boot 项目引入我们自定义的 Starterdependency groupIdcom.example/groupId artifactIdhello-spring-boot-starter/artifactId version1.0.0/version /dependency然后就可以像使用官方 Starter 一样使用我们的自定义 Starter 了五、最佳实践与避坑指南1. 自动配置最佳实践使用 AutoConfiguration 注解Spring Boot 3.x 推荐使用AutoConfiguration替代Configuration来标记自动配置类合理使用条件注解使用ConditionalOnClass、ConditionalOnMissingBean等条件注解让自动配置更加灵活提供合理的默认值配置属性应该提供合理的默认值让用户不需要任何配置就能使用支持配置覆盖允许用户通过配置文件覆盖默认值避免硬编码所有可配置的参数都应该放到配置属性类中2. Starter 开发最佳实践遵循命名规范第三方 Starter 命名为xxx-spring-boot-starter分离 autoconfigure 和 starter 模块将自动配置和依赖管理分开更加灵活最小依赖原则只引入必要的依赖避免引入不必要的依赖提供配置元数据添加additional-spring-configuration-metadata.json文件提供 IDE 提示编写文档提供详细的使用文档说明如何配置和使用 Starter3. 常见坑与解决方案坑 1自动配置不生效常见原因Spring Boot 3.x 中仍然使用旧的spring.factories配置方式配置文件路径或文件名错误大小写敏感条件注解不满足比如类路径下缺少必要的依赖主配置类的包扫描范围不包含自动配置类解决方案Spring Boot 3.x 必须使用新的AutoConfiguration.imports文件检查配置文件的路径和文件名是否完全正确检查条件注解是否满足使用SpringBootApplication(scanBasePackages com.example)指定包扫描范围坑 2自定义 Bean 覆盖了自动配置的 Bean问题当我们自定义了一个和自动配置同名的 Bean 时会覆盖自动配置的 Bean。解决方案如果需要覆盖自动配置的 Bean明确使用Bean注解注册自己的 Bean如果不需要覆盖避免使用相同的 Bean 名称。坑 3条件注解使用错误常见错误ConditionalOnBean和ConditionalOnMissingBean的顺序搞反ConditionalOnProperty的属性名写错条件注解的位置放错比如放在方法上而不是类上解决方案仔细阅读条件注解的文档确保使用正确。六、高频面试题解答问Spring Boot 自动装配的底层原理是什么答Spring Boot 自动装配的核心是EnableAutoConfiguration注解。它通过 SPI 机制从配置文件中加载所有的自动配置类然后根据条件注解过滤掉不符合条件的类最后将符合条件的自动配置类中的 Bean 注册到 Spring 容器中。问Spring Boot 3.x 为什么废弃了 spring.factories答Spring Boot 3.x 废弃 spring.factories 主要是为了性能优化、模块化支持、类型安全和 GraalVM 原生支持。新的AutoConfiguration.imports文件机制是静态加载启动速度更快与 Java 模块系统兼容性更好。问spring.factories 和 AutoConfiguration.imports 有什么区别答spring.factories 是键值对形式支持多个扩展点AutoConfiguration.imports 是纯类名列表只用于自动配置。AutoConfiguration.imports 性能更好类型更安全是 Spring Boot 3.x 推荐的方式。问如何自定义一个 Spring Boot Starter答自定义 Spring Boot Starter 的步骤1. 创建 autoconfigure 模块编写自动配置类、配置属性类和服务类2. 创建 starter 模块引入 autoconfigure 模块和相关依赖3. 配置自动配置文件4. 打包安装。问ConditionalOnMissingBean 注解的作用是什么答ConditionalOnMissingBean注解的作用是当容器中不存在指定的 Bean 时才注册这个 Bean。它允许用户自定义 Bean 来覆盖自动配置的 Bean是自动配置中最常用的注解之一。问自动配置的执行顺序是怎样的答自动配置类的执行顺序可以通过AutoConfigureBefore、AutoConfigureAfter和AutoConfigureOrder注解来控制。默认情况下自动配置类的执行顺序是不确定的。七、总结Spring Boot 自动装配是 Spring Boot 最成功的特性之一它通过约定大于配置的思想大大简化了 Spring 应用的开发和配置。回顾一下全文的核心内容自动装配的核心是EnableAutoConfiguration注解Spring Boot 3.x 废弃了spring.factories改用了新的AutoConfiguration.imports文件格式条件注解是自动装配的灵魂允许我们根据特定条件决定是否注册 Bean自定义自动配置只需要编写自动配置类和配置文件自定义 Starter 需要分离 autoconfigure 和 starter 模块遵循命名规范理解了自动装配的原理你就不再是只会用 Spring Boot 的 API 调用者而是真正理解了 Spring Boot 的设计哲学能够自己开发通用组件提高团队的开发效率。
