在 SpringBoot 2.x中，一個很核心的功能是自動配置（Auto-Configuration）機(jī)制，這篇文章，我們來聊一聊 Spring Boot 2.x 實現(xiàn)自動配置的8個寶藏技巧，希望幫助你更好地掌握SpringBoot的自動配置原理。

1. 核心注解：@EnableAutoConfiguration

自動配置的啟用主要通過 @EnableAutoConfiguration 注解實現(xiàn)，通常，這個注解被包含在 @SpringBootApplication 中：

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

@SpringBootApplication 等同于組合了以下三個注解：

• @SpringBootConfiguration
• @EnableAutoConfiguration
• @ComponentScan

2. 自動配置類的注冊：spring.factories

Spring Boot 使用 spring.factories 文件（位于各個自動配置模塊的 META-INF 目錄下）來注冊所有的自動配置類。具體來說，@EnableAutoConfiguration 注解會觸發(fā) AutoConfigurationImportSelector，它會讀取 spring.factories 文件中 org.springframework.boot.autoconfigure.EnableAutoConfiguration 鍵對應(yīng)的所有自動配置類，并將其導(dǎo)入到應(yīng)用上下文中。

示例 spring.factories 內(nèi)容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.autoconfig.MyAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration

3. 條件裝配：@Conditional 注解

自動配置類通常使用各種 @Conditional 注解來決定是否應(yīng)用特定的配置。這些條件基于類路徑中的類、存在的 Bean、配置屬性等。常見的條件注解包括：

• @ConditionalOnClass: 當(dāng)指定的類存在于類路徑上時生效。
• @ConditionalOnMissingBean: 當(dāng)指定的 Bean 不存在時生效。
• @ConditionalOnProperty: 當(dāng)特定的配置屬性滿足條件時生效。
• @ConditionalOnBean: 當(dāng)指定的 Bean 存在時生效。

示例：

@Configuration
@ConditionalOnClass(DataSource.class)
@ConditionalOnMissingBean(DataSource.class)
public class DataSourceAutoConfiguration {

    @Bean
    public DataSource dataSource() {
        // 創(chuàng)建并返回默認(rèn)的數(shù)據(jù)源
    }
}

上述配置表示：如果 DataSource 類在類路徑中存在，并且上下文中尚未定義 DataSource Bean，則自動配置一個默認(rèn)的數(shù)據(jù)源。

4. 自動配置的優(yōu)先級與覆蓋

雖然自動配置會根據(jù)條件自動配置很多 Bean，但開發(fā)者可以通過以下方式覆蓋默認(rèn)配置：

自定義 Bean：如果開發(fā)者在上下文中定義了某個 Bean，而自動配置類又嘗試定義同類型的 Bean，通常開發(fā)者自定義的 Bean 會優(yōu)先于自動配置的 Bean。

排除自動配置：可以在 @SpringBootApplication 或 @EnableAutoConfiguration 注解中使用 exclude 屬性來排除特定的自動配置類。

@SpringBootApplication(exclude = { DataSourceAutoConfiguration.class })
public class MyApplication { ... }

配置屬性：通過在 application.properties 或 application.yml 中設(shè)置特定的配置屬性，可以啟用、禁用或自定義自動配置的行為。

5. SpringBoot Starter

Spring Boot Starter 是一組依賴描述符（通常是 Maven 或 Gradle 依賴），它們聚合了一組相關(guān)的依賴項。通過引入特定的 Starter，自動配置機(jī)制會檢測到相關(guān)的依賴，并根據(jù)需要應(yīng)用相應(yīng)的自動配置。

常見的 Starter 示例：

• spring-boot-starter-web: 包含了構(gòu)建 Web 應(yīng)用所需的依賴，如 spring-webmvc、Tomcat 等，并觸發(fā)相關(guān)的自動配置（如 DispatcherServlet、Tomcat 等）。
• spring-boot-starter-data-jpa: 包含了 JPA 相關(guān)的依賴，并觸發(fā)數(shù)據(jù)源、JPA 實體管理器等的自動配置。

6. AutoConfigurationImportSelector 與組裝自動配置

AutoConfigurationImportSelector 是 @EnableAutoConfiguration 背后的關(guān)鍵類。它負(fù)責(zé)讀取 spring.factories 文件中的自動配置類，并應(yīng)用到 Spring 應(yīng)用上下文中。流程如下：

• 解析 spring.factories：讀取所有在 spring.factories 中注冊的自動配置類。
• 評估條件：對于每個自動配置類，評估其 @Conditional 注解，決定是否應(yīng)用該配置。
• 導(dǎo)入配置類：將符合條件的自動配置類導(dǎo)入到應(yīng)用上下文中。

7. 調(diào)試與診斷自動配置

Spring Boot 提供了一些工具和特性，幫助開發(fā)者理解和調(diào)試自動配置：

spring-boot-starter-actuator：包含的 auto-configure 端點可以展示應(yīng)用的自動配置報告。

@EnableAutoConfiguration 的 report 日志：在啟動日志中顯示哪些自動配置被應(yīng)用或被排除。

spring.autoconfigure.exclude 屬性：可以在配置文件中指定要排除的自動配置類。

8. 自定義自動配置

作為開發(fā)者，我們也可以創(chuàng)建自定義的自動配置類，以便在特定條件下自動配置特定的 Bean。

下面列舉了核心的 3個步驟：

創(chuàng)建自動配置類：使用 @Configuration 和適當(dāng)?shù)?@Conditional 注解。

@Configuration
@ConditionalOnClass(MyService.class)
public class MyServiceAutoConfiguration {

    @Bean
    public MyService myService() {
        return new MyService();
    }
}

在 spring.factories 中注冊：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.autoconfig.MyServiceAutoConfiguration

發(fā)布 Starter：將自動配置類打包在一個 Starter 中，供其他項目引入使用。

通過上面 3個核心步驟，當(dāng)我們在啟動SpringBoot容器時，自定義的類就會被自動配置，實現(xiàn)我們要達(dá)到的預(yù)期。

9. 總結(jié)

本文，我們分析了 Spring Boot 2.x 自動配置的 8個寶藏技巧，通過一系列智能的條件判斷、依賴管理和配置文件支持，Spring能夠根據(jù)項目的實際需求自動裝配所需的組件和 Bean。這極大地簡化了 Spring 應(yīng)用的配置過程，使得開發(fā)者能夠更專注于業(yè)務(wù)邏輯的實現(xiàn)，而無需關(guān)心繁瑣的配置細(xì)節(jié)。

到此這篇關(guān)于SpringBoot自動配置的8個技巧分享的文章就介紹到這了,更多相關(guān)SpringBoot自動配置內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評論