Spring Cloud Config 流程源碼詳解

Server

  • 如何加載

    • 核心接口是EnvironmentRepository,提供配置的讀取
    public interface EnvironmentRepository {
          Environment findOne(String application, String profile, String label);
      }
    
    • EnvironmentRepository有多種實(shí)現(xiàn),基于JDBC、SVN、GIT等等
    • 默認(rèn)情況下,使用的是 MultipleJGitEnvironmentRepository(可以配置多個(gè)地址的GIT數(shù)據(jù)源)
    • ConfigServerAutoConfiguration -> EnvironmentRepositoryConfiguration -> DefaultRepositoryConfiguration
    @Configuration
      @ConditionalOnMissingBean(value = EnvironmentRepository.class)
      class DefaultRepositoryConfiguration {
          ...
          @Bean
          public MultipleJGitEnvironmentRepository defaultEnvironmentRepository(...) throws Exception {
              return gitEnvironmentRepositoryFactory.build(environmentProperties);
          }
      }
    
    • MultipleJGitEnvironmentRepository 代理遍歷每個(gè) JGitEnvironmentRepository, JGitEnvironmentRepository 下使用 NativeEnvironmentRepository 代理讀取本地文件。
    • AbstractScmEnvironmentRepository#findOne
    public synchronized Environment findOne(String application, String profile, String label) {
          NativeEnvironmentRepository delegate = new NativeEnvironmentRepository(getEnvironment(),
                  new NativeEnvironmentProperties());
          Locations locations = getLocations(application, profile, label);
          delegate.setSearchLocations(locations.getLocations());
          Environment result = delegate.findOne(application, profile, "");
          ...
                  getUri());
      }
    
  • 其中g(shù)etLocations這部會(huì)從GIT遠(yuǎn)程倉庫同步到本地

  • JGitEnvironmentRepository#getLocations -> JGitEnvironmentRepository.refresh

public String refresh(String label) {
       Git git = createGitClient();
       ...
       checkout(git, label);
       ...
       merge(git, label);
       ...
       resetHard(...)
       ...
}

  • 配置文件加載優(yōu)先級順序(上面的覆蓋下面的)
模式 應(yīng)用
{spring.application.name}-{profile}.properties/yml 應(yīng)用-環(huán)境-配置
{spring.application.name}.properties/yml 應(yīng)用-全局-配置
application-{profile}.properties/yml 公眾-環(huán)境-配置
application.properties/yml 公眾-全局-配置
  • 具體的邏輯參考NativeEnvironmentRepository和ConfigFileApplicationListener

  • 如何注入

    • ConfigServer本身也可以注入自己的讀取的配置,使得其他服務(wù)可以和ConfigServer配置在一起,比如Eureka
    • Config的自身注入在BootStrap階段
    • ConfigServerBootstrapConfiguration#LocalPropertySourceLocatorConfiguration
     @Configuration
      @ConditionalOnProperty("spring.cloud.config.server.bootstrap")
      public class ConfigServerBootstrapConfiguration {
          @Bean
          public EnvironmentRepositoryPropertySourceLocator environmentRepositoryPropertySourceLocator() {
              return new EnvironmentRepositoryPropertySourceLocator(this.repository, this.client.getName(),
                      this.client.getProfile(), getDefaultLabel());
          }
      }
    
    • EnvironmentRepositoryPropertySourceLocator會(huì)調(diào)用EnvironmentRepository獲取配置
    public class EnvironmentRepositoryPropertySourceLocator implements PropertySourceLocator{
          @Override
          public PropertySource<?> locate(Environment environment) {
              CompositePropertySource composite = new CompositePropertySource("configService");
              for (PropertySource source : environmentRepository.findOne(name, profiles, label)
                      .getPropertySources()) {
                  composite.addPropertySource(...);
              }
              return composite;
          }
    }
    
    • PropertySourceBootstrapConfiguration#init負(fù)責(zé)所有BootStrap配置的加載,所有實(shí)現(xiàn)PropertySourceLocator接口的服務(wù)都會(huì)被調(diào)用
    CompositePropertySource composite = new CompositePropertySource(
                  BOOTSTRAP_PROPERTY_SOURCE_NAME);
      for (PropertySourceLocator locator : this.propertySourceLocators) {
          PropertySource<?> source = locator.locate(environment);
          composite.addPropertySource(source);
      }
    

Client

  • 2種高可用方式, Spring-Cloud-Config-Client配置存在兩種策略

    1. 通過ConfigServer獲取注冊中心地址和其他配置
    2. 通過注冊中心獲取ConfigServer地址,然后獲得其他配置
  • 參考國內(nèi)比較成熟的分布式集中配置,比如百度Disconf,攜程Apollo等基本都是第1種策略,好處是唯一需要本地寫死的是配置中心的參數(shù).

  • 但是Spring Cloud 1.X 并不支持ConfigServer集群的高可用配置。需要單獨(dú)將spring-cloud-starter-config升級到2.x(可以和其他1.x組件混用)

  • 升級后就可以配多個(gè)地址了,如下:

spring:
  application:
    name: user
  cloud:
    config:
      fail-fast: true
      profile: dev
      label: master
      uri: http://localhost:8761/config, http://localhost:8762/config, http://localhost:8763/config
  • 但是網(wǎng)上更多介紹的是第二種方案,這里也貼出來。配置項(xiàng)更多了,需要同時(shí)指定configserver和eureka
spring:
  application:
    name: user
  cloud:
    config:
      fail-fast: true
      profile: dev
      label: master
      discovery:
        enabled: true
        serviceId: dashboard
      
eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/,http://localhost2:8762/eureka,http://localhost3:8763/eureka
  • 啟動(dòng)過程和ConfigServer注入過程類似
  • ConfigServiceBootstrapConfiguration -> ConfigServicePropertySourceLocator -> locate
public PropertySource<?> locate(Environment environment) {
    CompositePropertySource composite = new CompositePropertySource("configService");
    ...
    RestTemplate restTemplate = getSecureRestTemplate(properties);
    ...
    Environment result = getRemoteEnvironment(restTemplate...);
    ...
    for (PropertySource source : result.getPropertySources()) {
        ...
        composite.addPropertySource(source);
    }
    ...
}
  • 該服務(wù)實(shí)現(xiàn)了PropertySourceLocator接口,在PropertySourceBootstrapConfiguration#init中會(huì)被注入到bootStrap的context中

  • 方案2比方案1多一個(gè)環(huán)節(jié),configServer 的 uri 是由注冊中心獲取的

  • DiscoveryClientConfigServiceBootstrapConfiguration#refresh

@ConditionalOnProperty(value = "spring.cloud.config.discovery.enabled", matchIfMissing = false)
@Configuration
@EnableDiscoveryClient
public class DiscoveryClientConfigServiceBootstrapConfiguration {
    void refresh() {
        String serviceId = this.config.getDiscovery().getServiceId();
        List<ServiceInstance> serviceInstances = this.instanceProvider
                    .getConfigServerInstances(serviceId);
        for (int i = 0; i < serviceInstances.size(); i++) {
                ServiceInstance server = serviceInstances.get(i);
                String url = getHomePage(server);
                listOfUrls.add(url);
        }
        ...
        configClientProperties.setUri(listOfUrls);
    }
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,622評論 6 544
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,716評論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,746評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,991評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,706評論 6 413
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 56,036評論 1 329
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 44,029評論 3 450
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,203評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,725評論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,451評論 3 361
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,677評論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,161評論 5 365
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,857評論 3 351
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,266評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,606評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,407評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,643評論 2 380

推薦閱讀更多精彩內(nèi)容