Spring?Boot?中starter的原理詳析

更新時(shí)間：2022年06月06日 11:57:47 作者：??香菜_香菜????

這篇文章主要介紹了Spring?Boot?中starter原理詳析，文章圍繞主題展開springboot的插件機(jī)制和starter原理相關(guān)資料，需要的小伙伴可以參考一下

1、springboot 的starter 的啟動(dòng)原理是什么

原理

這個(gè)問題是很簡(jiǎn)單的，只要了解springboot的同學(xué)應(yīng)該都知道，也是必須了解的。

① Spring Boot 在啟動(dòng)時(shí)會(huì)去classpath中中尋找 resources/META-INF/spring.factories 文件
② 根據(jù) spring.factories 配置加載 AutoConfigure 類
③ 根據(jù) @Conditional 注解的條件，進(jìn)行自動(dòng)配置并將 Bean 注入 Spring Context

來個(gè)例子

我們看個(gè)例子，下面是我工作中的一個(gè)starter，刪除了一些公司的代碼

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ 
com.xx.common.ratelimiter.config.reactive.WebsocketRateLimiterAutoConfiguration,\ 
com.xx.common.ratelimiter.config.ProductIdLimiterAutoConfiguration

解釋下：

EnableAutoConfiguration 這個(gè)是固定的，在springboot啟動(dòng)的時(shí)候，會(huì)去實(shí)例化這個(gè)key之后的每一個(gè)類
\ 是連接符，也就是表示這是一行數(shù)據(jù)，只不過可以分行表示
WebsocketRateLimiterAutoConfiguration 后面這兩行是業(yè)務(wù)自定義的config類，多個(gè)的話都好分割

@Configuration
@ConditionalOnProperty(
        prefix = "gateway.ratelimiter",
        name = {"enabled"},
        havingValue = "true"
)
@EnableConfigurationProperties(RateLimiterProperties.class)
@AutoConfigureAfter({RedisAutoConfiguration.class})
public class ProductIdLimiterAutoConfiguration {
...
}

上面這個(gè)是配置類，可以看到這個(gè)最主要的是一些注解

@Configuration 標(biāo)識(shí)這是一個(gè)配置類
@ConditionalOnProperty 標(biāo)識(shí)這個(gè)類的實(shí)例化需要在配置文件中存在 gateway.ratelimiter.enable 這個(gè)key，并且值為true
@EnableConfigurationProperties 將配置中的類，讀取到RateLimiterProperties.class 這個(gè)對(duì)象中
@AutoConfigureAfter 這個(gè)顧名思義，需要在redis 的實(shí)例化之后，因?yàn)檫@個(gè)config依賴redis 。

小結(jié)

springboot starter的原理就是springboot項(xiàng)目在啟動(dòng)的時(shí)候掃描jar，然后讀取spring.factories 中EnableAutoConfiguration key 指向的config類

然后通過一系列的條件配置判斷，啟動(dòng)當(dāng)前stater

2、springboot 是如何找到配置類的

第一個(gè)問題解決了主要流程的問題，但是springboo是怎么找到spring.fatories的吶、?

這個(gè)主要是涉及jar包中資源的讀取，讓我們看下這個(gè)流程。

主要的路徑是下面這三個(gè)注解：

SpringBootApplication ->
    EnableAutoConfiguration -> 
      AutoConfigurationImportSelector org.springframework.boot.autoconfigure.AutoConfigurationImportSelector#selectImports 
      org.springframework.boot.autoconfigure.AutoConfigurationImportSelector#getAutoConfigurationEntry 
      org.springframework.boot.autoconfigure.AutoConfigurationImportSelector#getCandidateConfigurations 
      org.springframework.core.io.support.SpringFactoriesLoader#loadFactoryNames 
      org.springframework.core.io.support.SpringFactoriesLoader#loadSpringFactories Enumeration<URL> urls = classLoader.getResources(FACTORIES_RESOURCE_LOCATION); 
      public static final String FACTORIES_RESOURCE_LOCATION = "META-INF/spring.factories";

通過上面的路徑，我們找到了最終是通過classloader 加載jar中"META-INF/spring.factories";當(dāng)然這段是代碼我們也可以用來加載其他的文件哦，也給我們借鑒，在下次需要實(shí)現(xiàn)類似的功能，可以直接抄。

3、springboot starter 的bean 是怎么加載到容器的

這個(gè)問題已經(jīng)很簡(jiǎn)單了，因?yàn)榈谝粋€(gè)問題已經(jīng)基本上可以看到原因了，

在springboot 加載到config的時(shí)候，可以在config中通過@bean進(jìn)行容器注冊(cè)，這個(gè)bean就會(huì)加載到容器

這里主要要說幾個(gè)特殊的注解，@ConditionalOnXXX

@ConditionalOnBean：當(dāng)容器中有指定Bean的條件下進(jìn)行實(shí)例化。
@ConditionalOnMissingBean：當(dāng)容器里沒有指定Bean的條件下進(jìn)行實(shí)例化。
@ConditionalOnClass：當(dāng)classpath類路徑下有指定類的條件下進(jìn)行實(shí)例化。
@ConditionalOnMissingClass：當(dāng)類路徑下沒有指定類的條件下進(jìn)行實(shí)例化。
@ConditionalOnWebApplication：當(dāng)項(xiàng)目是一個(gè)Web項(xiàng)目時(shí)進(jìn)行實(shí)例化。
@ConditionalOnNotWebApplication：當(dāng)項(xiàng)目不是一個(gè)Web項(xiàng)目時(shí)進(jìn)行實(shí)例化。
@ConditionalOnProperty：當(dāng)指定的屬性有指定的值時(shí)進(jìn)行實(shí)例化。
@ConditionalOnExpression：基于SpEL表達(dá)式的條件判斷。
@ConditionalOnJava：當(dāng)JVM版本為指定的版本范圍時(shí)觸發(fā)實(shí)例化。
@ConditionalOnResource：當(dāng)類路徑下有指定的資源時(shí)觸發(fā)實(shí)例化。
@ConditionalOnJndi：在JNDI存在的條件下觸發(fā)實(shí)例化。
@ConditionalOnSingleCandidate：當(dāng)指定的Bean在容器中只有一個(gè)，或者有多個(gè)但是指定了首選的Bean時(shí)觸發(fā)實(shí)例化。

如果想要定制自己的condition，可以實(shí)現(xiàn)Condition接口，定制Condition條件