java SpringBoot自動組裝原理是什麼

summary

detail

傳統的Spring專案會有很多的設定文件，例如我們要使用Redis，一般除了對應的依賴的jar包我們還需要在application.xml裡面配置JedisConnectionFactory、JedisPoolConfig、RedisTemplate。但是如果使用SpringBoot的話，系統會根據pom.xml裡面的jar包，自動產生這些類別並且注入到IOC容器當中。

傳統Spring專案中需要配置

<bean id="jedisConnectionFactory" class="...JedisConnectionFactory"></bean>
<bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig"></bean>
<bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"></bean>

而使用SpringBoot的話，除了pom.xml引入對應的jar包外，只需要在application.properties配置對應的屬性值即可

以Redis舉例

• 從spring-boot-autoconfigure.jar/META-INF/spring.factories中取得120多個預設功能配置類，其中包括redis的功能配置類別RedisAutoConfiguration的全限定名，一般一個功能配置類別圍繞該功能，負責管理創建多個相關的功能類，例如RedisAutoConfiguration負責：

JedisConnectionFactory、RedisTemplate、StringRedisTemplate這3個功能類別的建立

org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\

• RedisAutoConfiguration設定類別生效的條件是@ConditionalOnClass ：JedisConnection.class, RedisOperations.class, Jedis.class,所以會去classpath下去找對應的class檔案

@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {}

• 如果pom.xml有對應的jar套件,就能匹配到對應依賴class:JedisConnection.class, RedisOperations.class, Jedis.class

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

• 匹配成功，這個功能配置類別才會生效，同時會注入預設的屬性配置類別@EnableConfigurationProperties(RedisProperties.class)

@ConfigurationProperties(prefix = "spring.redis")
public class RedisProperties {
    private int database = 0;
    private String url;
    private String host = "localhost";
    private String password;
    private int port = 6379;

• Redis功能配置裡面會根據條件產生最終的JedisConnectionFactory、RedisTemplate,條件就是IOC環境裡面，沒有使用者自訂的

# @ConditionalOnMissingBean(RedisConnectionFactory.class)、RedisTemplate

@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {
        @Bean
        @ConditionalOnMissingBean(RedisConnectionFactory.class)
        public JedisConnectionFactory redisConnectionFactory()
                throws UnknownHostException {
            return applyProperties(createJedisConnectionFactory());
        }

        @Bean
        @ConditionalOnMissingBean(name = "redisTemplate")
        public RedisTemplate<Object, Object> redisTemplate(
                RedisConnectionFactory redisConnectionFactory)
                        throws UnknownHostException {
            RedisTemplate<Object, Object> template = new RedisTemplate<Object, Object>();
            template.setConnectionFactory(redisConnectionFactory);
            return template;
        }
}

• 最終建立好的預設組裝類，會透過功能配置類別裡面的@Bean註解，注入到IOC當中

原理與結果分析

透過各種註解，SpringApplication.run(Application.class, args)在執行時，會讀取spring-boot-autoconfigure.jar裡面的spring. factories設定文件，設定檔中有所有自動組裝類別的設定類別的className，然後產生對應功能的Configuration類，這些功能設定類別要生效的話，會去classpath找是否有該類別的依賴類別（也就是pom .xml必須有對應功能的jar包才行），然後配置類裡再通過判斷生成最後的功能類，並且配置類裡面注入了默認屬性值類，功能類可以引用並賦默認值。產生功能類別的原則是自訂優先，沒有自訂時才會使用自動組裝類別。

綜上所述，要想自動組裝一個類別需要滿足2個條件：

• #spring.factories裡面有這個類別的設定類別（一個配置類別可以建立多個圍繞該功能的依賴類別）

• pom.xml裡面需要有對應的jar套件

#整個過程的結果是兩件事：

• 根據各種判斷和依賴，最終生成了業務需要的類別並且注入到IOC容器當中了

• 自動組裝產生的類別賦予了一些預設的屬性值

#依賴的註解

• ##@ SpringBootApplication：sb專案應用程式啟動類別的註解，其實是3個註解的組合：@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan，其中在自動組裝中起作用的是第二個

• ############################################################### #@EnableAutoConfiguration：表示SB應用程式啟動自動組裝的功能（包含載入對應的Bean到IOC容器中，且根據預設配置對屬性賦值）###########@Import(EnableAutoConfigurationImportSelector.class) ：這個註解比較厲害，可以把沒有註冊到IOC中的Bean強行註冊到IOC中,表示啟動自動配置功能需要引入EnableAutoConfigurationImportSelector.class才行############@Configuration### #########@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }):表示讓RedisAutoConfiguration配置類別運作的話，必須有包含這些類別的jar包才行#### ########@EnableConfigurationProperties(RedisProperties.class)：表示預設引用RedisProperties.class裡面的配置############@ConditionalOnMissingBean(RedisConnectionFactory.class)：這是個很厲害的註解，實現自動組裝時自訂優先。表示如果使用者沒有自訂注入RedisConnectionFactory.class類，才會使用預設的JedisConnectionFactory。 ###

自動組裝的過程

• 透過各種註解實現了類別與類別之間的依賴關係，容器在啟動的時候Application.run，會呼叫EnableAutoConfigurationImportSelector.class的selectImports方法（其實是其父類別的方法）

• selectImports方法最終會呼叫SpringFactoriesLoader.loadFactoryNames方法來取得一個全面的常用Bean#Configuration列表清單

• ##loadFactoryNames方法會讀取FACTORIES_RESOURCE_LOCATION（也就是spring-boot-autoconfigure.jar 下面的spring.factories），取得到所有的Spring相關的Bean的全限定名ClassName，大概120多個

• selectImports方法繼續呼叫filter(configurations, autoConfigurationMetadata);這個時候會根據這些BeanConfiguration裡面的條件，來一一篩選，最關鍵的是@ConditionalOnClass，這個條件註解會去classpath下要查找，jar包裡面是否有這個條件依賴類，所以必須有了相應的jar包，才有這些依賴類，才會生成IOC環境需要的一些預設配置Bean

• 最後把符合條件的BeanConfiguration注入預設的EnableConfigurationPropertie類別裡面的屬性值，並且注入到IOC環境當中

以上是java SpringBoot自動組裝原理是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章！