Spring Boot 自動配置

Spring Boot的自動配置功能會根據Classpath中的Class為我們自動建立相應的bean。比如當classpath下存在MongoClient.class和MongoTemplate.class時就會進行Spring Data MongoDB的配置。這是通過MongoDataAutoConfiguration類配置的。下面是MongoDataAutoConfiguration類的定義，可以看到上面使用了@Configuration註解定義，且通過@ConditionalOnClass註解指定了只有在存在MongoClient.class和MongoTemplate.class時才會生效。@EnableConfigurationProperties指定了可以使用的配置屬性類，Spring Boot會自動生成對應型別的bean，以供我們在自動配置類中進行依賴注入。@AutoConfigureAfter定義了該自動配置類生效的位置，下面程式碼指定了將在MongoAutoConfiguration配置類之後生效。

@Configuration
@ConditionalOnClass({ MongoClient.class, MongoTemplate.class })
@EnableConfigurationProperties(MongoProperties.class)
@AutoConfigureAfter(MongoAutoConfiguration.class)
public class MongoDataAutoConfiguration {
    //...省略
}

上面的配置類又定義了很多的bean，如下是簡單的兩個示例。其中通過 @ConditionalOnMissingBean(MongoDbFactory.class)指定了在沒有定義MongoDbFactory型別的bean時將通過mongoDbFactory()建立一個型別為SimpleMongoDbFactory的bean。指定了在不存在MongoTemplate型別的bean時將通過mongoTemplate()建立一個MongoTemplate型別的bean（@ConditionalOnMissingBean不指定型別時，預設取方法返回型別）。

@Configuration
@ConditionalOnClass({ MongoClient.class, MongoTemplate.class })
@EnableConfigurationProperties(MongoProperties.class)
@AutoConfigureAfter(MongoAutoConfiguration.class)
public class MongoDataAutoConfiguration {
    private final ApplicationContext applicationContext;

    private final MongoProperties properties;

    public MongoDataAutoConfiguration(ApplicationContext applicationContext,
            MongoProperties properties) {
        this.applicationContext = applicationContext;
        this.properties = properties;
    }

    @Bean
    @ConditionalOnMissingBean(MongoDbFactory.class)
    public SimpleMongoDbFactory mongoDbFactory(MongoClient mongo) {
        String database = this.properties.getMongoClientDatabase();
        return new SimpleMongoDbFactory(mongo, database);
    }

    @Bean
    @ConditionalOnMissingBean
    public MongoTemplate mongoTemplate(MongoDbFactory mongoDbFactory,
            MongoConverter converter) {
        return new MongoTemplate(mongoDbFactory, converter);
    }
    //...省略
}

@ConditionalOnMissingBean除了可以通過型別指定缺失的bean外，還可以通過bean名稱指定缺失的bean。
除了上面提到的Conditional註解外，Spring Boot還提供了很多Conditional註解，它們都定義在org.springframework.boot.autoconfigure.condition包中，詳情可以參考對應的API文件。

上面是基於MongoDataAutoConfiguration自動配置類舉的一個例子，其它自動配置類也是採用類似的形式進行定義的，它們都定義在spring-boot-autoconfigure-xxx.jar中。通過上面的介紹我們知道，如果我們不想使用自動配置的bean，則可以定義自己的bean。這樣自動配置的bean就不會生效了。自動配置的bean生效的條件是多種多樣的，具體可以參考對應的AutoConfiguration類。

如果不想使用某個自動配置，則可以通過@SpringBootApplication的exclude屬性指定需要排除的自動配置類。如下程式碼就指定了將排除MongoDataAutoConfiguration自動配置類。

@SpringBootApplication(exclude = { MongoDataAutoConfiguration.class })
public class Application {

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

}

也可以通過excludeName指定需要排除的自動配置類的全路徑名稱。

@SpringBootApplication(excludeName = { "org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration" })
public class Application {

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

}

如果期望看到哪些自動配置類進行了自動配置，可以在啟動引數中新增--debug，則日誌中會輸出自動配置結果，類似於下面這樣的。

============================
CONDITIONS EVALUATION REPORT
============================


Positive matches:
-----------------

   AopAutoConfiguration matched:
      - @ConditionalOnClass found required classes `org.springframework.context.annotation.EnableAspectJAutoProxy`, `org.aspectj.lang.annotation.Aspect`, `org.aspectj.lang.reflect.Advice`, `org.aspectj.weaver.AnnotatedElement`; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnProperty (spring.aop.auto=true) matched (OnPropertyCondition)

   AopAutoConfiguration.CglibAutoProxyConfiguration matched:
      - @ConditionalOnProperty (spring.aop.proxy-target-class=true) matched (OnPropertyCondition)

   CodecsAutoConfiguration matched:
      - @ConditionalOnClass found required class `org.springframework.http.codec.CodecConfigurer`; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)

   CodecsAutoConfiguration.JacksonCodecConfiguration matched:
      - @ConditionalOnClass found required class `com.fasterxml.jackson.databind.ObjectMapper`; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)

Spring Boot提供的自動配置的配置類都在spring-boot-autoconfigure-xxx.jar的META-INF/spring.factories檔案中配置，對應的配置Key是org.springframework.boot.autoconfigure.EnableAutoConfiguration。如果需要實現自己的自動配置類，也需要在Classpath下的META-INF/spring.factories檔案中做相同的配置。

（注：本文是基於Spring Boot 2.0.3所寫）