【源碼解析】自動配置的這些細節不知道，別說你會 springboot

spring-boot 相對於 spring，很重要的一個特色就是自動配置，使約定大於配置思想成功落地。xxx-spring-boot-starter 一系列引導器可以開箱即用，或者只須要不多的配置（對於初學人員）就是由於已作了默認的自動配置。

自動配置在一開始就初始化了一些配置，同時提供修改配置的入口。

總體結構

spring-boot-autoconfigure 包是 spring-boot-starter 中一個很是重要的包，其中提供了自動配置功能，還對經常使用依賴，設置了默認配置。

依賴

其依賴的包有三種：

• 基礎包：spring-boot
• 可選功能依賴包：提供默認配置的經常使用依賴包，實際使用時由使用者提供
• 測試包

可選功能依賴包有 spring-data-redis、validator、thymeleaf、websocket 等等。下面會選幾個做爲示例具體講解。

原理

@EnableAutoConfiguration

@AutoConfigurationPackage
@Import(AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration {
  /**
   *  當此名對應屬性爲 true 時，纔開啓自動配置
   */
  String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
  
  /**
   *  須要排除的類（一般當此類在類路徑下時使用）
   */
  Class<?>[] exclude() default {};

  /**
   *  須要排除的類名（當此類不在類路徑下時使用）
   */
  String[] excludeName() default {};
}

@AutoConfigurationPackage

將使用此註解的類所屬於的包註冊成 spring bean。
此 spring bean 的 beanName 爲 AutoConfigurationPackages，
beanClass 爲 BasePackages。

AutoConfigurationImportSelector

自動配置選擇器，選擇哪些類自動配置。

selectImports

核心方法：String[] selectImports(AnnotationMetadata annotationMetadata) ，此方法返回須要自動配置的全類名數組。
須要自動配置的類知足如下條件：

1. META-INF/spring.factories 中 key 爲 org.springframework.boot.autoconfigure.EnableAutoConfiguration 的類
2. @EnableAutoConfiguration 註解中 exclude 、 excludeName 屬性表明的類， 配置中 spring.autoconfigure.exclude 中設置的類（若類路徑中存在，可是步驟 1 不存在，則拋異常）
3. 知足包含三種註解的條件：OnBeanCondition（如：ConditionalOnBean、ConditionalOnMissingBean） 、OnClassCondition （如：ConditionalOnClass、ConditionalOnMissingClass）、OnWebApplicationCondition（如：ConditionalOnWebApplication、ConditionalOnNotWebApplication）

最後，會激活 AutoConfigurationImportEvent 事件。

getImportGroup 與 DeferredImportSelector.Group

對來自不一樣 ImportSelector 的結果進行分組

自動配置的順序

• AutoConfigurationSorter
• @AutoConfigureOrder
• @AutoConfigureBefore
• @AutoConfigureAfter

AutoConfigurationSorter 是具體控制排序的邏輯
@AutoConfigureOrder 是 @Order 的 Auto-configuration 特定變體，所以須要制定自定配置的順序時，能夠用 @AutoConfigureOrder 。控制應用配置類的絕對順序。
@AutoConfigureBefore 和 @AutoConfigureAfter 控制應用配置類的相對順序。

具體培訓順序以下：

1. 根據類名按照字母表遞增排序
2. 根據 @AutoConfigureOrder value 值（默認：0）遞增排序
3. 根據 @AutoConfigureBefore 和 @AutoConfigureAfter 調整排序

那麼 @Order 還能控制自動配置類的順序嗎？

@SpringBootApplication

2.1.8.RELEASE 版本中，此註解的組合註解以下：

// 省略不需關心的註解
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = { @Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {

已有原來的 @Configuration 改成 @SpringBootConfiguration，其意義以下：

• 至關因而 @Configuration 類
• 使用該註解的類提供 Spring Boot 應用。

一個應用只能包含一個 @SpringBootConfiguration 類，一般使用 @SpringBootApplication 就能夠了

AbstractDependsOnBeanFactoryPostProcessor

此類實現 BeanFactoryPostProcessor，會在 spring-boot 啓動過程當中在合適的時機執行
繼承此類，經過構造器動態決定指定類型的 bean 應該依賴於哪些 bean。

BackgroundPreinitializer

此類實現 ApplicationListener<SpringApplicationEvent>
此類功能爲：在耗時任務的後臺線程中觸發早期初始化，如：
ValidationInitializer、MessageConverterInitializer、JacksonInitializer、CharsetInitializer、ConversionServiceInitializer、MBeanFactoryInitializer等

@ImportAutoConfiguration

導入自動配置類。從源碼來看，都是測試時用於自動配置。使用此類的註解，也在 META-INF/spring.factories 中配置，示例以下：

@ImportAutoConfiguration
public @interface AutoConfigureDataJpa {}

org.springframework.boot.test.autoconfigure.orm.jpa.AutoConfigureDataJpa=\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration,\
org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration,\
org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration,\
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration,\
org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration

所以使用註解 AutoConfigureDataJpa 就至關於導入了 JpaRepositoriesAutoConfiguration、DataSourceAutoConfiguration 等類。

使用以下：

@BootstrapWith(DataJpaTestContextBootstrapper.class)
@ExtendWith(SpringExtension.class)
@OverrideAutoConfiguration(enabled = false)
@TypeExcludeFilters(DataJpaTypeExcludeFilter.class)
@Transactional
@AutoConfigureCache
@AutoConfigureDataJpa
@AutoConfigureTestDatabase
@AutoConfigureTestEntityManager
@ImportAutoConfiguration
public @interface DataJpaTest {
  // ...
}

@RunWith(SpringRunner.class)
@DataJpaTest
@TestPropertySource(properties = "spring.jpa.hibernate.use-new-id-generator-mappings=false")
public class DataJpaTestIntegrationTests {

    @Autowired
    private TestEntityManager entities;

    @Autowired
    private JdbcTemplate jdbcTemplate;

    @Autowired
    private ExampleRepository repository;

    @Autowired
    private DataSource dataSource;

    @Autowired
    private ApplicationContext applicationContext;

    @Test
    public void testEntityManager() {
        ExampleEntity entity = this.entities.persist(new ExampleEntity("spring", "123"));
        this.entities.flush();
        Object id = this.entities.getId(entity);
        ExampleEntity found = this.entities.find(ExampleEntity.class, id);
        assertThat(found.getName()).isEqualTo("spring");
    }
    
    // ...

對經常使用工具的支持

以上原理是提供自動配置的基石，但實際在使用的時候，不少內容不須要任何（或極少許）配置就能直接使用，一方面是各 xxx-spring-boot-starter 中包含了 spring-boot-autoconfigure 並寫了自動配置邏輯，一方面，是 spring-boot 官方在 spring-boot-autoconfigure 包中已經直接支持了。

示例：gson 自動配置

支持有以下類：

• GsonProperties
• GsonBuilderCustomizer
• GsonAutoConfiguration

GsonProperties 類獲取 Gson 的配置屬性

@ConfigurationProperties(prefix = "spring.gson")
public class GsonProperties {
  private Boolean generateNonExecutableJson;
  private Boolean excludeFieldsWithoutExposeAnnotation;
  private Boolean serializeNulls;
  private String dateFormat;
  // ...
}

@FunctionalInterface
public interface GsonBuilderCustomizer {
    /**
     * 自定義 GsonBuilder
     */
    void customize(GsonBuilder gsonBuilder);
}

GsonAutoConfiguration 中使用 GsonProperties 和 GsonBuilderCustomizer（內部類中實現）

@Configuration
@ConditionalOnClass(Gson.class)
@EnableConfigurationProperties(GsonProperties.class)
public class GsonAutoConfiguration {
    @Bean
    @ConditionalOnMissingBean
    public GsonBuilder gsonBuilder(List<GsonBuilderCustomizer> customizers) {
        GsonBuilder builder = new GsonBuilder();
        customizers.forEach((c) -> c.customize(builder));
        return builder;
    }

    @Bean
    @ConditionalOnMissingBean
    public Gson gson(GsonBuilder gsonBuilder) {
        return gsonBuilder.create();
    }

    @Bean
    public StandardGsonBuilderCustomizer standardGsonBuilderCustomizer(GsonProperties gsonProperties) {
        return new StandardGsonBuilderCustomizer(gsonProperties);
    }

    static final class StandardGsonBuilderCustomizer implements GsonBuilderCustomizer, Ordered {

        private final GsonProperties properties;

        StandardGsonBuilderCustomizer(GsonProperties properties) {
            this.properties = properties;
        }

        @Override
        public int getOrder() {
            return 0;
        }

        @Override
        public void customize(GsonBuilder builder) {
         // ...
        }

公衆號：逸飛兮（專一於 Java 領域知識的深刻學習，從源碼到原理，系統有序的學習）