Springboot 通过Apollo-client加载配置的过程

springboot 通过Apollo-client加载配置的过程

1.Apollo-client利用springboot的META-INF/spring.factories将ApolloApplicationContextInitializer添加到springboot的ApplicationContextInitializer

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.ctrip.framework.apollo.spring.boot.ApolloAutoConfiguration
org.springframework.context.ApplicationContextInitializer=\
com.ctrip.framework.apollo.spring.boot.ApolloApplicationContextInitializer

2.springboot启动时.经过前面的资源收集.然后加载ApplicationContextInitializer.即执行ApolloApplicationContextInitializer.java中initialize().此类为apollo入口类

@Override
  public void initialize(ConfigurableApplicationContext context) {
    ConfigurableEnvironment environment = context.getEnvironment();

    initializeSystemProperty(environment);

    String enabled = environment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED, "false");
    if (!Boolean.valueOf(enabled)) {
      logger.debug("Apollo bootstrap config is not enabled for context {}, see property: ${{}}", context, PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED);
      return;
    }
    logger.debug("Apollo bootstrap config is enabled for context {}", context);

    if (environment.getPropertySources().contains(PropertySourcesConstants.APOLLO_BOOTSTRAP_PROPERTY_SOURCE_NAME)) {
      //already initialized
      return;
    }

    String namespaces = environment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_NAMESPACES, ConfigConsts.NAMESPACE_APPLICATION);
    logger.debug("Apollo bootstrap namespaces: {}", namespaces);
    List namespaceList = NAMESPACE_SPLITTER.splitToList(namespaces);

    CompositePropertySource composite = new CompositePropertySource(PropertySourcesConstants.APOLLO_BOOTSTRAP_PROPERTY_SOURCE_NAME);
    for (String namespace : namespaceList) {
      Config config = ConfigService.getConfig(namespace);

      composite.addPropertySource(configPropertySourceFactory.getConfigPropertySource(namespace, config));
    }

    environment.getPropertySources().addFirst(composite);
  }

3.方法中进入Config config = ConfigService.getConfig(namespace);

 4.ConfigService.java

public static Config getConfig(String namespace) {
  return s_instance.getManager().getConfig(namespace);
}

5.进入DefaultConfigManager

@Override
public Config getConfig(String namespace) {
  Config config = m_configs.get(namespace);

  if (config == null) {
    synchronized (this) {
      config = m_configs.get(namespace);

      if (config == null) {
        ConfigFactory factory = m_factoryManager.getFactory(namespace);
//断点2 开始去获取config
        config = factory.create(namespace);
        m_configs.put(namespace, config);
      }
    }
  }

  return config;
}

6.DefaultConfigFactory.java....进入createLocalConfigRepository(namespace)

@Override
public Config create(String namespace) {
  DefaultConfig defaultConfig = new DefaultConfig(namespace, createLocalConfigRepository(namespace));
  return defaultConfig;
}

进去.然后createRemoteConfigRepository(namespace)---->new RemoteConfigRepository(namespace);

LocalFileConfigRepository createLocalConfigRepository(String namespace) {
  if (m_configUtil.isInLocalMode()) {
    logger.warn(
        "==== Apollo is in local mode! Won't pull configs from remote server for namespace {} ! ====",
        namespace);
    return new LocalFileConfigRepository(namespace);
  }
//断点8
  return new LocalFileConfigRepository(namespace, createRemoteConfigRepository(namespace));
}

RemoteConfigRepository createRemoteConfigRepository(String namespace) {
  return new RemoteConfigRepository(namespace);
}

7.RemoteConfigRepository.java--->进入this.trySync();

public RemoteConfigRepository(String namespace) {
  m_namespace = namespace;
  m_configCache = new AtomicReference<>();
  m_configUtil = ApolloInjector.getInstance(ConfigUtil.class);
  m_httpUtil = ApolloInjector.getInstance(HttpUtil.class);
  m_serviceLocator = ApolloInjector.getInstance(ConfigServiceLocator.class);
  remoteConfigLongPollService = ApolloInjector.getInstance(RemoteConfigLongPollService.class);
  m_longPollServiceDto = new AtomicReference<>();
  m_remoteMessages = new AtomicReference<>();
  m_loadConfigRateLimiter = RateLimiter.create(m_configUtil.getLoadConfigQPS());
  m_configNeedForceRefresh = new AtomicBoolean(true);
  m_loadConfigFailSchedulePolicy = new ExponentialSchedulePolicy(m_configUtil.getOnErrorRetryInterval(),
      m_configUtil.getOnErrorRetryInterval() * 8);
  gson = new Gson();
  this.trySync();
  this.schedulePeriodicRefresh();
  this.scheduleLongPollingRefresh();
}

8.RemoteConfigRepository.java------>loadApolloConfig();

@Override
protected synchronized void sync() {
  Transaction transaction = Tracer.newTransaction("Apollo.ConfigService", "syncRemoteConfig");

  try {
    ApolloConfig previous = m_configCache.get();
//断点10
    ApolloConfig current = loadApolloConfig();

    //reference equals means HTTP 304
    if (previous != current) {
      logger.debug("Remote Config refreshed!");
      m_configCache.set(current);
      this.fireRepositoryChange(m_namespace, this.getConfig());
    }

    if (current != null) {
      Tracer.logEvent(String.format("Apollo.Client.Configs.%s", current.getNamespaceName()),
          current.getReleaseKey());
    }

    transaction.setStatus(Transaction.SUCCESS);
  } catch (Throwable ex) {
    transaction.setStatus(ex);
    throw ex;
  } finally {
    transaction.complete();
  }
}

继续进入loadApolloConfig.

private ApolloConfig loadApolloConfig() {
  if (!m_loadConfigRateLimiter.tryAcquire(5, TimeUnit.SECONDS)) {
    //wait at most 5 seconds
    try {
      TimeUnit.SECONDS.sleep(5);
    } catch (InterruptedException e) {
    }
  }
  String appId = m_configUtil.getAppId();
  String cluster = m_configUtil.getCluster();
  String dataCenter = m_configUtil.getDataCenter();
  Tracer.logEvent("Apollo.Client.ConfigMeta", STRING_JOINER.join(appId, cluster, m_namespace));
  int maxRetries = m_configNeedForceRefresh.get() ? 2 : 1;
  long onErrorSleepTime = 0; // 0 means no sleep
  Throwable exception = null;
  //断点11 此处进入获取元服务信息
  List configServices = getConfigServices();
  String url = null;
  for (int i = 0; i < maxRetries; i++) {
    List randomConfigServices = Lists.newLinkedList(configServices);
    Collections.shuffle(randomConfigServices);
    //Access the server which notifies the client first
    if (m_longPollServiceDto.get() != null) {
      randomConfigServices.add(0, m_longPollServiceDto.getAndSet(null));
    }

    for (ServiceDTO configService : randomConfigServices) {
      if (onErrorSleepTime > 0) {
        logger.warn(
            "Load config failed, will retry in {} {}. appId: {}, cluster: {}, namespaces: {}",
            onErrorSleepTime, m_configUtil.getOnErrorRetryIntervalTimeUnit(), appId, cluster, m_namespace);

        try {
          m_configUtil.getOnErrorRetryIntervalTimeUnit().sleep(onErrorSleepTime);
        } catch (InterruptedException e) {
          //ignore
        }
      }
//生成访问元服务的url
//http://10.10.10.56:8080/configs/spring-boot-logger/default/application?ip=10.10.10.56
      url = assembleQueryConfigUrl(configService.getHomepageUrl(), appId, cluster, m_namespace,
              dataCenter, m_remoteMessages.get(), m_configCache.get());

      logger.debug("Loading config from {}", url);
      HttpRequest request = new HttpRequest(url);

      Transaction transaction = Tracer.newTransaction("Apollo.ConfigService", "queryConfig");
      transaction.addData("Url", url);
      try {
//将url访问元服务
        HttpResponse response = m_httpUtil.doGet(request, ApolloConfig.class);
        m_configNeedForceRefresh.set(false);
        m_loadConfigFailSchedulePolicy.success();

        transaction.addData("StatusCode", response.getStatusCode());
        transaction.setStatus(Transaction.SUCCESS);

        if (response.getStatusCode() == 304) {
          logger.debug("Config server responds with 304 HTTP status code.");
          return m_configCache.get();
        }
//获取元服务返回的结果数据
        ApolloConfig result = response.getBody();

        logger.debug("Loaded config for {}: {}", m_namespace, result);

        return result;
      } catch (ApolloConfigStatusCodeException ex) {
//省略
       }
         
}
9.回到断点10...

10.回到//断点8...

LocalFileConfigRepository(namespace, createRemoteConfigRepository(namespace));

11一路退出..

config = factory.create(namespace);

12一路退出..

Config config = ConfigService.getConfig(namespace);13一路退出..
composite.addPropertySource(configPropertySourceFactory.getConfigPropertySource(namespace, config));

14.多个namespace多次循环

15最后将配置放到environment.PropertySources

environment.getPropertySources().addFirst(composite);