Spring Boot 自动配置原理
Spring Boot 的自动配置机制基于 条件化配置,通过 @EnableAutoConfiguration 注解来启用。自动配置的核心原理是 基于类路径和环境条件来推断所需要的配置,Spring Boot 会根据项目中引入的依赖和当前环境来自动装配相关的配置项,而不需要开发者手动配置。
自动配置原理简述
- @EnableAutoConfiguration:这个注解会触发 Spring Boot 的自动配置功能。它会让 Spring Boot 从- META-INF/spring.factories文件中读取自动配置类,并根据当前项目的依赖来加载相关配置。
- 条件注解(@Conditional系列注解):Spring Boot 会根据项目中存在的类、依赖、配置等条件,判断是否应用某些配置。例如:@ConditionalOnClass、@ConditionalOnProperty等注解,它们会根据类路径上的依赖和配置项来决定是否加载某些配置。
- 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 来配置其属性。
步骤:
- 创建自动配置类:自定义自动配置类,负责提供具体的配置逻辑。
- 使用 @Conditional注解:使用条件注解来判断是否自动配置。
- 创建 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 的灵活性和扩展性。