SpringBoot AutoConfiguration解密[譯]

本文是http://sivalabs.in/2016/03/how-springboot-autoconfiguration-magic/的翻譯。

我們知道SpringBoot的應用可以以非常簡潔的代碼去做很多的事情, 可以自動幫你注入數據庫的Bean，消息隊列的Bean等等等等，那么SpringBoot是怎么做到的呢？

但是在探索SpringBoot的神秘之前，我們先了解一下Spring的@Conditional注解，這是SpringBoot的AutoConfiguration的神奇之處所依賴的底層機制。

@Conditional 探秘

我們開發Spring應用的時候有時候會碰到要根據外界條件注冊不同Bean的情況。

比如如果你的應用是跑在本地機器的話，你會想要讓你的DataSource bean指向一個本地的數據庫，而如果是跑在線上機器的話，你會想讓DataSource bean指向一個生產的數據庫。

你可以把這些數據庫連接信息抽取到幾個不同的配置文件里面去，然后在不同的環境下使用不同的配置文件。但是當你的應用被部署到新的環境下的時候，你還是要添加新的配置文件，并且重新打包。(譯者注:這里其實只要把配置文件抽取到代碼之外不就好了么?不知道原作者在想什么)

為了解決這個問題，Spring 3.1引入了Profiles的概念。你可以注冊同一個類型bean的不同實例，然后把這些不同的實例綁定到不同的Profile, 當你運行這個Spring應用的時候，你可以指定你要激活的Profile, 這樣只有跟這些被激活的Profile相關聯的bean才會被注冊:

@Configuration
public class AppConfig
{
    @Bean
    @Profile("DEV")
    public DataSource devDataSource() {
        ...
    }

    @Bean
    @Profile("PROD")
    public DataSource prodDataSource() {
        ...
    }
}

然后你可以通過系統屬性指定激活的profile:

-Dspring.profiles.active=DEV

這種方式對于你要基于profile來決定是否注冊一個bean的情況工作得很好。但是如果你要基于一些條件性的判斷邏輯來決定是否注冊一個bean的話，那么光靠profile是不行的。

為了給條件性地注冊bean提供更高的靈活性，Spring 4提供了@Conditional的概念。通過使用@Conditional你可以基于任何條件來決定是否注冊一個bean。

你的條件可能是這樣的:

CLASSPATH里面有一個特定的Class
ApplicationContext里面有一個特定類型的bean
在指定的位置有指定的文件
配置文件里面有指定的配置項
系統屬性里面配置了指定的屬性

這些只是我能想到的一些，實際上你可以基于任何條件。下面讓我們來看看Spring的@Conditional到底是如何工作的。我們先設定一個場景:

我們有一個UserDAO接口用來從數據庫里面獲取數據。這個接口我們有兩個實現: JdbcUserDAO從MySQL數據庫里面獲取數據；MongoUserDAO從MongoDB里面獲取數據。

通過系統屬性來決定

我們想通過一個名為dbType的系統屬性來決定到底使用JdbcUserDAO還是MongoUserDAO。期望的效果是，如果通過java -jar myapp.jar -DdbType=MySQL那么使用的是JdbcUserDAO, 如果通過java -jar myapp.jar -DdbType=MONGO啟動，這使用MongoUserDAO。幾個類的實現是這樣的:

public interface UserDAO
{
    List<String> getAllUserNames();
}

public class JdbcUserDAO implements UserDAO
{
    @Override
    public List<String> getAllUserNames()
    {
        System.out.println("**** Getting usernames from RDBMS *****");
        return Arrays.asList("Siva","Prasad","Reddy");
    }
}

public class MongoUserDAO implements UserDAO
{
    @Override
    public List<String> getAllUserNames()
    {
        System.out.println("**** Getting usernames from MongoDB *****");
        return Arrays.asList("Bond","James","Bond");
    }
}

我們可以實現這樣的一個MySQLDatabaseTypeCondition來檢測系統屬性dbType是否是MYSQL:

public class MySQLDatabaseTypeCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata metadata)
    {
        String enabledDBType = System.getProperty("dbType");
        return (enabledDBType != null && enabledDBType.equalsIgnoreCase("MYSQL"));
    }
}

類似的MongoDBDatabaseTypeCondition:

public class MongoDBDatabaseTypeCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata metadata)
    {
        String enabledDBType = System.getProperty("dbType");
        return (enabledDBType != null && enabledDBType.equalsIgnoreCase("MONGODB"));
    }
}

現在我們就可以通過@Conditional來判斷使用JdbcUserDAO還是MongoUserDAO:

@Configuration
public class AppConfig
{
    @Bean
    @Conditional(MySQLDatabaseTypeCondition.class)
    public UserDAO jdbcUserDAO(){
        return new JdbcUserDAO();
    }

    @Bean
    @Conditional(MongoDBDatabaseTypeCondition.class)
    public UserDAO mongoUserDAO(){
        return new MongoUserDAO();
    }
}

通過CLASSPATH上是否有指定的類來判斷

類似地我們可以通過判斷CLASSPATH里面是否有com.mongodb.Server這個Driver類來決定是使用MongoUserDAO還是JdbcUserDAO:

public class MongoDriverPresentsCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext,AnnotatedTypeMetadata metadata)
    {
        try {
            Class.forName("com.mongodb.Server");
            return true;
        } catch (ClassNotFoundException e) {
            return false;
        }
    }
}

public class MongoDriverNotPresentsCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata metadata)
    {
        try {
            Class.forName("com.mongodb.Server");
            return false;
        } catch (ClassNotFoundException e) {
            return true;
        }
    }
}

通過容器里面是否存在指定類型bean來判斷

如果我們只在容器里面沒有任何類型的UserDAO的bean的時候才注冊MongoUserDAO。我們通過創建一個Condition來檢測是否存在一個指定類型的bean:

public class UserDAOBeanNotPresentsCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata metadata)
    {
        UserDAO userDAO = conditionContext.getBeanFactory().getBean(UserDAO.class);
        return (userDAO == null);
    }
}

如果想通過配置文件里面的配置來決定DAO類型呢?

public class MongoDbTypePropertyCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext,
    AnnotatedTypeMetadata metadata)
    {
        String dbType = conditionContext.getEnvironment()
                            .getProperty("app.dbType");
        return "MONGO".equalsIgnoreCase(dbType);
    }
}

更優雅的實現方式: 注解

我們已經試了通過各種不同條件來實現Condition。但是其實有更優雅的、通過注解來實現Condition的方式。我們不再為MYSQL和MongoDB實現各自Condition, 我們可以實現下面這樣一個DatabaseType注解:

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Conditional(DatabaseTypeCondition.class)
public @interface DatabaseType
{
    String value();
}

然后我們實現DatabaseTypeCondition來使用這個注解來判斷DAO的類型了:

public class DatabaseTypeCondition implements Condition
{
    @Override
    public boolean matches(ConditionContext conditionContext,
    AnnotatedTypeMetadata metadata)
    {
        Map<String, Object> attributes = metadata.getAnnotationAttributes(DatabaseType.class.getName());
        String type = (String) attributes.get("value");
        String enabledDBType = System.getProperty("dbType","MYSQL");
        return (enabledDBType != null && type != null && enabledDBType.equalsIgnoreCase(type));
    }
}

現在我們就可以在我們的bean上使用DatabaseType注解了:

@Configuration
@ComponentScan
public class AppConfig
{
    @Bean
    @DatabaseType("MYSQL")
    public UserDAO jdbcUserDAO(){
        return new JdbcUserDAO();
    }

    @Bean
    @DatabaseType("MONGO")
    public UserDAO mongoUserDAO(){
        return new MongoUserDAO();
    }
}

這里我們從DatabaseType注解里面獲取元數據，并且把獲取的值跟系統屬性里面的dbType進行對比來決定是否激活bean。

我們已經看了很多例子來看@Conditional注解的作用。SpringBoot大量的使用@Conditional來實現基于條件的注冊bean。你可以在spring-boot-autoconfigure-{version}.jar 的 org.springframework.boot.autoconfigure 包里面看到SpringBoot使用的大量的Condition的實現。

那么我們已經知道了SpringBoot使用@Conditional來決定是否初始化一個bean, 但是是什么機制觸發了auto-configuration機制呢？我們下一節來聊聊這個事情:

SprintBoot的自動配置

SpringBoot的自動配置的關鍵在于@EnableAutoConfiguration這個注解。一般來說我們把我們程序的入口類加上@SpringBootApplication注解，或者如果我們想要更加細致的定制這些默認值的話:

@Configuration
@EnableAutoConfiguration
@ComponentScan
public class Application
{

}

@EnableAutoConfiguration注解通過掃描CLASSPATH里面所有的組件，然后基于條件來決定是否注冊bean來使得Spring的ApplicationContext自動配置。

SpringBoot在spring-boot-autoconfigure-{version}.jar里面提供了很多AutoConfiguration的類來負責注冊各種不同的組件。

一般來說AutoConfiguration類上面會標上@Configuration注解來標明它是一個Spring的配置類，標上@EnableConfigurationProperties來綁定自定義的配置值，并且會在一到多個方法上標上@Conditional注解來標記注冊方法。

比如我們來看看org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration:

@Configuration
@ConditionalOnClass({ DataSource.class, EmbeddedDatabaseType.class })
@EnableConfigurationProperties(DataSourceProperties.class)
@Import({ Registrar.class, DataSourcePoolMetadataProvidersConfiguration.class })
public class DataSourceAutoConfiguration
{
    ...
    ...
    @Conditional(DataSourceAutoConfiguration.EmbeddedDataSourceCondition.class)
    @ConditionalOnMissingBean({ DataSource.class, XADataSource.class })
    @Import(EmbeddedDataSourceConfiguration.class)
    protected static class EmbeddedConfiguration {

    }

    @Configuration
    @ConditionalOnMissingBean(DataSourceInitializer.class)
    protected static class DataSourceInitializerConfiguration {
        @Bean
        public DataSourceInitializer dataSourceInitializer() {
        return new DataSourceInitializer();
        }
    }

    @Conditional(DataSourceAutoConfiguration.NonEmbeddedDataSourceCondition.class)
    @ConditionalOnMissingBean({ DataSource.class, XADataSource.class })
    protected static class NonEmbeddedConfiguration {
        @Autowired
        private DataSourceProperties properties;

        @Bean
        @ConfigurationProperties(prefix = DataSourceProperties.PREFIX)
        public DataSource dataSource() {
            DataSourceBuilder factory = DataSourceBuilder
                    .create(this.properties.getClassLoader())
                    .driverClassName(this.properties.getDriverClassName())
                    .url(this.properties.getUrl()).username(this.properties.getUsername())
                    .password(this.properties.getPassword());
            if (this.properties.getType() != null) {
                factory.type(this.properties.getType());
            }
            return factory.build();
        }
    }
    ...
    ...
    @Configuration
    @ConditionalOnProperty(prefix = "spring.datasource", name = "jmx-enabled")
    @ConditionalOnClass(name = "org.apache.tomcat.jdbc.pool.DataSourceProxy")
    @Conditional(DataSourceAutoConfiguration.DataSourceAvailableCondition.class)
    @ConditionalOnMissingBean(name = "dataSourceMBean")
    protected static class TomcatDataSourceJmxConfiguration {
        @Bean
        public Object dataSourceMBean(DataSource dataSource) {
        ....
        ....
        }
    }
    ...
    ...
}

這里DataSourceAutoConfiguration上標記了一個@ConditionalOnClass({ DataSource.class,EmbeddedDatabaseType.class }), 這樣只有當CLASSPATH上有DataSource.class和EmbeddedDatabaseType.class的時候，DataSourceAutoConfiguration 才會生效。

這個類還被@EnableConfigurationProperties(DataSourceProperties.class)標記了，這樣application.properties里面相關的配置值會自動綁定到DataSourceProperties上面。

@ConfigurationProperties(prefix = DataSourceProperties.PREFIX)
public class DataSourceProperties implements BeanClassLoaderAware, EnvironmentAware, InitializingBean {

    public static final String PREFIX = "spring.datasource";
    ...
    ...
    private String driverClassName;
    private String url;
    private String username;
    private String password;
    ...
    //setters and getters
}

有了這個配置屬性類，所有spring.datasource.*的配置都會自動綁定到DataSourceProperties:

spring.datasource.url=jdbc:mysql://localhost:3306/test
spring.datasource.username=root
spring.datasource.password=secret
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

你還能看到一些內部類以及bean的定義方法被SpringBoot的@ConditionalOnMissingBean, @ConditionOnClass, @ConditionalOnProperty等等標記。

這些bean的定義只有在那些條件滿足的時候才會注冊。

在spring-boot-autoconfigure-{version}.jar里面你還能看到其它的AutoConfiguration類:

org.springframework.boot.autoconfigure.web.DispatcherServletAutoConfiguration
org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration
org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration

等等。我希望通過今天文章的介紹大家已經理解SpringBoot是怎么做到自動配置bean的了。

最后編輯于：2017.12.06 07:02:17

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

人面猴
序言：七十年代末，一起剝皮案震驚了整個濱河市，隨后出現的幾起案子，更是在濱河造成了極大的恐慌，老刑警劉巖，帶你破解...
沈念sama閱讀 230,622評論 6贊 544
死咒
序言：濱河連續發生了三起死亡事件，死亡現場離奇詭異，居然都是意外死亡，警方通過查閱死者的電腦和手機，發現死者居然都...
沈念sama閱讀 99,716評論 3贊 429
救了他兩次的神仙讓他今天三更去死
文/潘曉璐我一進店門，熙熙樓的掌柜王于貴愁眉苦臉地迎上來，“玉大人，你說我怎么就攤上這事。” “怎么了？”我有些...
開封第一講書人閱讀 178,746評論 0贊 383
道士緝兇錄：失蹤的賣姜人
文/不壞的土叔我叫張陵，是天一觀的道長。經常有香客問我，道長，這世上最難降的妖魔是什么？我笑而不...
開封第一講書人閱讀 63,991評論 1贊 318
?港島之戀（遺憾婚禮）
正文為了忘掉前任，我火速辦了婚禮，結果婚禮上，老公的妹妹穿的比我還像新娘。我一直安慰自己，他們只是感情好，可當我...
茶點故事閱讀 72,706評論 6贊 413
惡毒庶女頂嫁案：這布局不是一般人想出來的
文/花漫我一把揭開白布。她就那樣靜靜地躺著，像睡著了一般。火紅的嫁衣襯著肌膚如雪。梳的紋絲不亂的頭發上，一...
開封第一講書人閱讀 56,036評論 1贊 329
城市分裂傳說
那天，我揣著相機與錄音，去河邊找鬼。笑死，一個胖子當著我的面吹牛，可吹牛的內容都是我干的。我是一名探鬼主播，決...
沈念sama閱讀 44,029評論 3贊 450
雙鴛鴦連環套：你想象不到人心有多黑
文/蒼蘭香墨我猛地睜開眼，長吁一口氣：“原來是場噩夢啊……” “哼！你這毒婦竟也來了？” 一聲冷哼從身側響起，我...
開封第一講書人閱讀 43,203評論 0贊 290
萬榮殺人案實錄
序言：老撾萬榮一對情侶失蹤，失蹤者是張志新（化名）和其女友劉穎，沒想到半個月后，有當地人在樹林里發現了一具尸體，經...
沈念sama閱讀 49,725評論 1贊 336
?護林員之死
正文獨居荒郊野嶺守林人離奇死亡，尸身上長有42處帶血的膿包…… 初始之章·張勛以下內容為張勛視角年9月15日...
茶點故事閱讀 41,451評論 3贊 361
?白月光啟示錄
正文我和宋清朗相戀三年，在試婚紗的時候發現自己被綠了。大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
茶點故事閱讀 43,677評論 1贊 374
活死人
序言：一個原本活蹦亂跳的男人離奇死亡，死狀恐怖，靈堂內的尸體忽然破棺而出，到底是詐尸還是另有隱情，我是刑警寧澤，帶...
沈念sama閱讀 39,161評論 5贊 365
?日本核電站爆炸內幕
正文年R本政府宣布，位于F島的核電站，受9級特大地震影響，放射性物質發生泄漏。R本人自食惡果不足惜，卻給世界環境...
茶點故事閱讀 44,857評論 3贊 351
男人毒藥：我在死后第九天來索命
文/蒙蒙一、第九天我趴在偏房一處隱蔽的房頂上張望。院中可真熱鬧，春花似錦、人聲如沸。這莊子的主人今日做“春日...
開封第一講書人閱讀 35,266評論 0贊 28
一樁弒父案，背后竟有這般陰謀
文/蒼蘭香墨我抬頭看了看天上的太陽。三九已至，卻和暖如春，著一層夾襖步出監牢的瞬間，已是汗流浹背。一陣腳步聲響...
開封第一講書人閱讀 36,606評論 1贊 295
情欲美人皮
我被黑心中介騙來泰國打工，沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留，地道東北人。一個月前我還...
沈念sama閱讀 52,407評論 3贊 400
代替公主和親
正文我出身青樓，卻偏偏與公主長得像，于是被迫代替她去往敵國和親。傳聞我的和親對象是個殘疾皇子，可洞房花燭夜當晚...
茶點故事閱讀 48,643評論 2贊 380

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频

SpringBoot AutoConfiguration解密[譯]

SpringBoot AutoConfiguration解密[譯]

@Conditional 探秘

通過系統屬性來決定

通過CLASSPATH上是否有指定的類來判斷

通過容器里面是否存在指定類型bean來判斷

更優雅的實現方式: 注解

SprintBoot的自動配置

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美 国产 综合 欧美 视频

SpringBoot AutoConfiguration解密[譯]

@Conditional 探秘

通過系統屬性來決定

通過CLASSPATH上是否有指定的類來判斷

通過容器里面是否存在指定類型bean來判斷

更優雅的實現方式: 注解

SprintBoot的自動配置

推薦閱讀更多精彩內容

三个男躁一个女,国精产品一区一手机的秘密,麦子交换系列最经典十句话,欧美国产综合欧美视频