SpringBoot中@AutoConfiguration和@Configuration區(qū)別
@AutoConfiguration 是 Spring Boot 2.4 引入的一個新注解,用于標記自動配置類。它是對傳統(tǒng) @Configuration 注解的增強,專門用于自動配置場景。
@AutoConfiguration 注解詳解
1. 基本作用
@AutoConfiguration 是一個復合注解,主要用于標識自動配置類,它提供了比 @Configuration 更明確的語義和更好的功能。
2. 注解定義
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface AutoConfiguration {
/**
* 自動配置類的處理順序
*/
AutoConfigurationPhase before() default AutoConfigurationPhase.NONE;
/**
* 在指定的自動配置類之后處理
*/
Class<?>[] after() default {};
/**
* 在指定的自動配置類之前處理
*/
Class<?>[] before() default {};
}
3. 與 @Configuration 的區(qū)別
// 傳統(tǒng)方式
@Configuration
@ConditionalOnClass(DataSource.class)
@EnableConfigurationProperties(DataSourceProperties.class)
public class DataSourceAutoConfiguration {
// 配置內容
}
// 新方式(推薦)
@AutoConfiguration
@ConditionalOnClass(DataSource.class)
@EnableConfigurationProperties(DataSourceProperties.class)
public class DataSourceAutoConfiguration {
// 配置內容
}
4. 主要特性
4.1 明確的語義(使用@Configuration的類只知道是一個配置類,并不知道是自動配置類)
// 明確表示這是一個自動配置類
@AutoConfiguration
@ConditionalOnClass(RedisTemplate.class)
public class RedisAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public RedisTemplate redisTemplate() {
return new RedisTemplate();
}
}
4.2 排序控制
// 控制自動配置的執(zhí)行順序
@AutoConfiguration(
before = DataSourceAutoConfiguration.class,
after = WebMvcAutoConfiguration.class
)
@ConditionalOnClass(DataSource.class)
public class CustomDataSourceAutoConfiguration {
// 配置內容
}
5. 實際應用示例
5.1 基礎自動配置類
@AutoConfiguration
@ConditionalOnClass(MyService.class)
@EnableConfigurationProperties(MyServiceProperties.class)
public class MyServiceAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public MyService myService(MyServiceProperties properties) {
MyServiceImpl service = new MyServiceImpl();
service.setConfig(properties);
return service;
}
}
5.2 帶排序的自動配置(決定當前自動配置類,在誰創(chuàng)建之前或者之后配置)
@AutoConfiguration(
before = {DataSourceAutoConfiguration.class},
after = {WebMvcAutoConfiguration.class}
)
@ConditionalOnClass(CacheManager.class)
@EnableConfigurationProperties(CacheProperties.class)
public class CacheAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public CacheManager cacheManager(CacheProperties properties) {
return new CustomCacheManager(properties);
}
}
5.3 條件化自動配置
@AutoConfiguration
@ConditionalOnWebApplication
@ConditionalOnClass(Servlet.class)
@ConditionalOnProperty(prefix = "my.web", name = "enabled", havingValue = "true", matchIfMissing = true)
public class WebAutoConfiguration {
@Bean
public WebInterceptor webInterceptor() {
return new WebInterceptor();
}
@Bean
public WebFilter webFilter() {
return new WebFilter();
}
}
6. 與其他注解的配合使用
6.1 與條件注解配合
@AutoConfiguration
@ConditionalOnClass(JdbcTemplate.class)
@ConditionalOnProperty(name = "my.jdbc.enabled", havingValue = "true", matchIfMissing = true)
public class JdbcAutoConfiguration {
@Bean
@Primary
@ConditionalOnMissingBean
public JdbcTemplate jdbcTemplate(DataSource dataSource) {
return new JdbcTemplate(dataSource);
}
}
6.2 與屬性配置注解配合
@AutoConfiguration
@EnableConfigurationProperties({
DatabaseProperties.class,
ConnectionProperties.class
})
@ConditionalOnClass(DataSource.class)
public class DatabaseAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public DataSource dataSource(DatabaseProperties dbProps, ConnectionProperties connProps) {
// 創(chuàng)建數據源
return createDataSource(dbProps, connProps);
}
}
7. 優(yōu)勢和特點
7.1 語義明確
- 明確標識這是一個自動配置類
- 提高代碼可讀性和維護性
7.2 排序支持
@AutoConfiguration(
before = DataSourceAutoConfiguration.class,
after = WebMvcAutoConfiguration.class
)
7.3 與Spring Boot生態(tài)系統(tǒng)集成
- 與
spring.factories或AutoConfiguration.imports文件配合使用 - 支持Spring Boot的條件化配置機制
8. 完整示例
// 自定義屬性配置類
@ConfigurationProperties(prefix = "myapp.service")
public class MyServiceProperties {
private String url = "http://localhost:8080";
private int timeout = 5000;
private boolean enabled = true;
// getters and setters
}
// 自動配置類
@AutoConfiguration
@ConditionalOnClass(MyService.class)
@ConditionalOnProperty(prefix = "myapp.service", name = "enabled", havingValue = "true", matchIfMissing = true)
@EnableConfigurationProperties(MyServiceProperties.class)
public class MyServiceAutoConfiguration {
@Bean
@ConditionalOnMissingBean
public MyService myService(MyServiceProperties properties) {
MyService service = new MyServiceImpl();
service.setUrl(properties.getUrl());
service.setTimeout(properties.getTimeout());
return service;
}
@Bean
@ConditionalOnMissingBean
public MyServiceClient myServiceClient(MyService myService) {
return new MyServiceClient(myService);
}
}
9. 最佳實踐
- 使用明確的語義:優(yōu)先使用
@AutoConfiguration而不是@Configuration - 合理的條件注解:結合使用
@ConditionalOnClass、@ConditionalOnMissingBean等 - 屬性配置:使用
@EnableConfigurationProperties管理配置屬性 - 排序控制:必要時使用
before和after屬性控制執(zhí)行順序 - 文檔注釋:為自動配置類添加清晰的文檔說明
@AutoConfiguration 注解使自動配置類的意圖更加明確,提供了更好的排序控制,并且是Spring Boot 2.4+推薦的標準做法。
到此這篇關于 SpringBoot中@AutoConfiguration和@Configuration區(qū)別的文章就介紹到這了,更多相關 SpringBoot @AutoConfiguration @Configuration內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
- SpringBoot?注解?@AutoConfiguration?在?2.7?版本中被新增的使用方法詳解
- springboot使用@ConfigurationProperties實現(xiàn)自動綁定配置參數屬性
- SpringBoot中的@ConfigurationProperties注解的使用
- SpringBoot中@ConfigurationProperties自動獲取配置參數的流程步驟
- Springboot之@ConfigurationProperties注解解讀
- SpringBoot中的@ConfigurationProperties注解解析
- 關于SpringBoot的@ConfigurationProperties注解和松散綁定、數據校驗
相關文章
BeanUtils.copyProperties擴展--實現(xiàn)String轉Date
這篇文章主要介紹了BeanUtils.copyProperties擴展--實現(xiàn)String轉Date操作,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06
SpringBoot Starter機制及整合tomcat的實現(xiàn)詳解
這篇文章主要介紹了SpringBoot Starter機制及整合tomcat的實現(xiàn),我們知道SpringBoot自己在“后臺”幫我們配置了很多原本需要我們手動去的東西,至于這個“后臺”是啥,就是Starter機制2022-09-09

