[譯] SpringBoot AutoConfiguration 解密

bkdr5742 7年前發布 | 50K 次閱讀數據庫 Spring Boot

我們知道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的了。

來自：http://www.jianshu.com/p/d0f8d487f9a9

本文由用戶 bkdr5742 自行上傳分享，僅供網友學習交流。所有權歸原作者，若您的權利被侵害，請聯系管理員。

轉載本站原創文章，請注明出處，并保留原始鏈接、圖片水印。

本站是一個以用戶分享為主的開源技術平臺，歡迎各類分享！

本文地址：http://www.baiduhome.net/lib/view/open1491093926403.html

數據庫 Spring Boot