Spring Cloud Config 源码分析

今天我们来分析一下spring cloud 的 config 的源码。我们可以看到spring-cloud-config-client项目下的spring.factories文件中定义了我们今天所要讲的文 ConfigClientAutoConfiguration 与ConfigServiceBootstrapConfiguration。他们被自动引入进我们的容器中作为Bean。我们先看一下ConfigServiceBootstrapConfiguration

@Configuration
@EnableConfigurationProperties
public class ConfigServiceBootstrapConfiguration {

   @Autowired
   private ConfigurableEnvironment environment;

   ...

   @Bean
   @ConditionalOnProperty(value = "spring.cloud.config.enabled", matchIfMissing = true)
   public ConfigServicePropertySourceLocator configServicePropertySource() {
      ConfigServicePropertySourceLocator locator = new ConfigServicePropertySourceLocator(
            configClientProperties());
      return locator;
   }

   ...

}

我们说一下作为重要的一个Bean configServicePropertySource,他的作用就是从远程服务器上拿到我们的配置,放入到spring 容器中的
environment 中。让我们详细的看一下。

@Override
@Retryable(interceptor = "configServerRetryInterceptor")
public org.springframework.core.env.PropertySource<?> locate(
      org.springframework.core.env.Environment environment) {
   ConfigClientProperties client = this.defaults.override(environment);
   CompositePropertySource composite = new CompositePropertySource("configService");
   RestTemplate restTemplate = this.restTemplate == null ? getSecureRestTemplate(client)
         : this.restTemplate;
   Exception error = null;
   String errorBody = null;
   logger.info("Fetching config from server at: " + client.getRawUri());
   try {
      String[] labels = new String[]{""};
      if (StringUtils.hasText(client.getLabel())) {
         labels = StringUtils.commaDelimitedListToStringArray(client.getLabel());
      }
      // Try all the labels until one works
      for (String label : labels) {
         Environment result = getRemoteEnvironment(restTemplate, client.getRawUri(), client.getName(), client.getProfile(), label.trim());
         if (result != null) {
            logger.info(String.format("Located environment: name=%s, profiles=%s, label=%s, version=%s",
                  result.getName(),
                  result.getProfiles() == null ? "" : Arrays.asList(result.getProfiles()),
                  result.getLabel(), result.getVersion()));

            for (PropertySource source : result.getPropertySources()) {
               @SuppressWarnings("unchecked")
               Map<String, Object> map = (Map<String, Object>) source
                     .getSource();
               composite.addPropertySource(new MapPropertySource(source
                     .getName(), map));
            }
            return composite;
         }
      }
   }
   catch (HttpServerErrorException e) {
      error = e;
      if (MediaType.APPLICATION_JSON.includes(e.getResponseHeaders()
            .getContentType())) {
         errorBody = e.getResponseBodyAsString();
      }
   }
   catch (Exception e) {
      error = e;
   }
   if (client != null && client.isFailFast()) {
      throw new IllegalStateException(
            "Could not locate PropertySource and the fail fast property is set, failing",
            error);
   }
   logger.warn("Could not locate PropertySource: "
         + (errorBody == null ? error==null ? "label not found" : error.getMessage() : errorBody));
   return null;

}
 
 
private Environment getRemoteEnvironment(RestTemplate restTemplate, String uri, String name, String profile, String label) {
   String path = "/{name}/{profile}";
   Object[] args = new String[] { name, profile };
   if (StringUtils.hasText(label)) {
      args = new String[] { name, profile, label };
      path = path + "/{label}";
   }
   ResponseEntity<Environment> response = null;

   try {
      response = restTemplate.exchange(uri + path,
            HttpMethod.GET, new HttpEntity<Void>((Void) null),
            Environment.class, args);
   } catch (HttpClientErrorException e) {
      if(e.getStatusCode() != HttpStatus.NOT_FOUND ) {
         throw e;
      }
   }

   if (response==null || response.getStatusCode()!=HttpStatus.OK) {
      return null;
   }
   Environment result = response.getBody();
   return result;
}

这个类的生命周期方法是locate,getRemoteEnvironment这个方法就是从远程服务器上拉取数据,将数据放入到Environment中返回,然后解析得到的Environment,将数据放入
composite。在哪里用呢?请看PropertySourceBootstrapConfiguration

@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
   CompositePropertySource composite = new CompositePropertySource(
         BOOTSTRAP_PROPERTY_SOURCE_NAME);
   AnnotationAwareOrderComparator.sort(this.propertySourceLocators);
   boolean empty = true;
   ConfigurableEnvironment environment = applicationContext.getEnvironment();
   for (PropertySourceLocator locator : this.propertySourceLocators) {
      PropertySource<?> source = null;
      source = locator.locate(environment);
      if (source == null) {
         continue;
      }
      logger.info("Located property source: " + source);
      composite.addPropertySource(source);
      empty = false;
   }
   if (!empty) {
      MutablePropertySources propertySources = environment.getPropertySources();
      String logConfig = environment.resolvePlaceholders("${logging.config:}");
      LogFile logFile = LogFile.get(environment);
      if (propertySources.contains(BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
         propertySources.remove(BOOTSTRAP_PROPERTY_SOURCE_NAME);
      }
      insertPropertySources(propertySources, composite);
      reinitializeLoggingSystem(environment, logConfig, logFile);
      setLogLevels(environment);
   }
}

首先这是一个ApplicationContextInitializer的子类,那么会在spring boot 进行初始化的时候调用,将所有PropertySourceLocator类型的对象的locate方法都调用一遍,然后将各个渠道得到的属性值放到
composite中利用insertPropertySources(propertySources, composite)设置到environment中,这样容器就得到了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,723评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,003评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,512评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,825评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,874评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,841评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,812评论 3 416
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,582评论 0 271
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,033评论 1 308
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,309评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,450评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,158评论 5 341
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,789评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,409评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,609评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,440评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,357评论 2 352

推荐阅读更多精彩内容