Spring Boot中的自动配置原理是什么

embedded/2025/1/18 1:53:15/

Spring Boot 自动配置原理

Spring Boot 的自动配置机制基于 条件化配置,通过 @EnableAutoConfiguration 注解来启用。自动配置的核心原理是 基于类路径和环境条件来推断所需要的配置,Spring Boot 会根据项目中引入的依赖和当前环境来自动装配相关的配置项,而不需要开发者手动配置。

自动配置原理简述
  1. @EnableAutoConfiguration:这个注解会触发 Spring Boot 的自动配置功能。它会让 Spring Boot 从 META-INF/spring.factories 文件中读取自动配置类,并根据当前项目的依赖来加载相关配置。
  2. 条件注解(@Conditional 系列注解):Spring Boot 会根据项目中存在的类、依赖、配置等条件,判断是否应用某些配置。例如:@ConditionalOnClass@ConditionalOnProperty 等注解,它们会根据类路径上的依赖和配置项来决定是否加载某些配置。
  3. spring.factories 文件:Spring Boot 使用 spring.factories 文件来定义自动配置类,通常在 META-INF/spring.factories 目录下。这个文件包含了需要自动配置的类,当 Spring Boot 启动时,会读取这些配置类并应用。

Spring Boot 自动配置的示例

假设你使用的是 Spring Boot Web Starter,在你的项目中引入了 spring-boot-starter-web 依赖时,Spring Boot 会自动配置一个嵌入式的 Tomcat 服务器以及相关的 Web 配置。

示例:自动配置 DataSource 连接池

假设你引入了 mybatis-spring-boot-starter 依赖,Spring Boot 会自动配置 DataSource 连接池、mybatis配置等。你无需手动配置 DataSource,Spring Boot 会根据 加载yml中的数据库连接配置,可以初始化连接数据库。

示例代码:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@MapperScan("com.hk.mapper")
@SpringBootApplication
public class MyApplication {public static void main(String[] args) {SpringApplication.run(MyApplication.class, args);}
}

在这个例子中,@SpringBootApplication 会自动启用 @EnableAutoConfiguration 注解,Spring Boot 会根据类路径中是否存在 mybatis-spring-boot-starter 或数据库驱动来自动配置数据源和 创建Mapper代理对象添加到IOC容器中。

自定义自动配置案例

Spring Boot 允许开发者创建自己的自动配置类,满足项目特定需求。

1. 创建一个自定义的自动配置类

假设我们希望在应用启动时自动配置一个自定义的 MyService,并通过 @ConfigurationProperties 来配置其属性。

步骤:

  1. 创建自动配置类:自定义自动配置类,负责提供具体的配置逻辑。
  2. 使用 @Conditional 注解:使用条件注解来判断是否自动配置。
  3. 创建 spring.factories 文件:将自动配置类注册到 spring.factories 文件中。

示例代码:

1. 创建自定义的 MyService
@Data
public class MyService {private String msg= "Hello, World!";
}
2. 创建自动配置类
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
@ConditionalOnProperty(name = "my.enabled",havingValue = "true")
public class MyServiceServiceAutoConfiguration {@Beanpublic MyService myService() {return new MyService();}
}

这里,我们通过 @ConditionalOnProperty 注解来确保 MyService 仅在 my.enabled 属性为 true 时才被加载。如果没有配置该属性,则默认启用。

3. 创建 spring.factories 文件

src/main/resources/META-INF/spring.factories 目录下,创建一个 spring.factories 文件,注册自动配置类。

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.hk.MyServiceServiceAutoConfiguration
4. 使用自定义的自动配置

application.properties 中,你可以通过配置 my.enabled 来控制是否启用自动配置的 MyService

my.enabled=true
my.message=Hello, Custom World!
5. 在应用中使用 MyService
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class MyApplication implements CommandLineRunner {@Autowiredprivate MyService myService;public static void main(String[] args) {SpringApplication.run(MyApplication.class, args);}@Overridepublic void run(String... args) {System.out.println(myService.getMsg());}
}
6. 启动并测试

启动应用时,如果 application.properties 中的 my.enabled 设置为 true,则会自动创建并注入 MyService 实例,否则不会创建 MyService

总结

  • Spring Boot 的自动配置机制依赖于 @EnableAutoConfiguration 和一系列的条件注解(如 @ConditionalOnClass@ConditionalOnProperty 等),它根据应用的类路径、环境条件以及配置文件来自动加载和配置必要的 Bean。
  • 开发者可以通过创建自定义的自动配置类、定义条件注解、配置 spring.factories 文件来扩展 Spring Boot 的自动配置功能。
  • 自定义自动配置可以通过条件化配置来控制何时启用特定的配置,增强了 Spring Boot 的灵活性和扩展性。

http://www.ppmy.cn/embedded/154815.html

相关文章

如何用 AI 打造孩子的专属学习助手?

目录 一、创建智能体 二、填写提示词 三、验证效果 四、发布到豆包 如何用 AI 打造孩子的专属学习助手? 如何用 AI 打造孩子的专属学习助手? 今天给大家分享个超实用滴干货,能让家里的娃在学习路上如虎添翼!  前几天&#…

基于微信小程序的汽车销售系统的设计与实现springboot+论文源码调试讲解

第4章 系统设计 一个成功设计的系统在内容上必定是丰富的,在系统外观或系统功能上必定是对用户友好的。所以为了提升系统的价值,吸引更多的访问者访问系统,以及让来访用户可以花费更多时间停留在系统上,则表明该系统设计得比较专…

OSI七层协议——分层网络协议

OSI七层协议,顾名思义,分为七层,实际上七层是不存在的,是人为的进行划分,让人更好的理解 七层协议包括,物理层(我),数据链路层(据),网络层(网),传输层(传输),会话层(会),表示层(表),应用层(用)(记忆口诀->我会用表…

基于物联网表计的综合能源管理方案

为加快推进国家“双碳”战略和新型能源体系建设,努力实现负荷准确控制和用户精细化管理,按照“政府主导、电网组织、政企协同、用户实施”的指导原则,多地成立市/县级电力负荷管理中心,包括浙江宁波、慈溪、辽宁大连、湖南株洲、娄…

GitLab CI/CD使用runner实现自动化部署前端Vue2 后端.Net 7 Zr.Admin项目

1、查看gitlab版本 建议安装的runner版本和gitlab保持一致 2、查找runner 执行 yum list gitlab-runner --showduplicates | sort -r 找到符合gitlab版本的runner,我这里选择 14.9.1版本 如果执行出现找不到下载源,添加官方仓库 执行 curl -L &quo…

Shell的运行原理以及Linux中的权限问题

Shell的运行原理 Linux严格意义上说的是一个操作系统,我们称之为“核心(kernel)“ ,但我们一般用户,不能直接使用kernel。 而是通过kernel的“外壳”程序,也就是所谓的shell,来与kernel沟通。如…

Centos9 + Docker 安装 MySQL8.4.0 + 定时备份数据库到本地

Centos9 Docker 安装 MySQL8.4.0 定时备份数据库到本地 创建目录,创建配置文件启动容器命令定时备份MySQL执行脚本Linux每日定时任务命令文件内参数其他时间参数 AT一次性定时任务 创建目录,创建配置文件 $ mkdir -p /opt/mysql/conf$ vim /opt/mysql/…

Spring Boot中yml和properties的区别

properties 和 yml 都是 Spring Boot 支持的两种配置文件,可以看作是 Spring Boot 在不同时期的两款“产品”。主要是为了取代 XML 文件格式来配置项目。 properties 配置文件属于早期,也是目前创建 Spring Boot(2.x)项目时默认的…