apollo在Spring boot加载过程解析

==

apollo 是一个开源的配置中心项目，功能很强大，apollo 本身的配置项并不复杂，但是因为配置的路径特别多，非常容易搞混了， 所以本文试图聚焦 spring-boot 的场景，在 spring-boot 微服务场景下，搞清楚 apollo-client 的加载过程

集成使用

====

1、添加 gradle 依赖

==============

implementation “com.ctrip.framework.apollo:apollo-client:1.6.0”

2、配置 application.properties

===========================

apollo 自身的配置共包含 9 项，必要配置只有 3 项，其他的都是可选的配置。apollo 在 spring-boot 环境下的配置命名和 System 参数的命名保持了一直，最终 spring 的配置会注入到 System 中，具体的逻辑下文分析。

必须配置

====

#应用的ID

app.id = java-project

apollo 的 config-service 服务发现地址

apollo.meta = http://apollo.meta

启用 apollo

apollo.bootstrap.enabled = true

可选配置

====

在日志系统初始化前加载 apollo 配置

apollo.bootstrap.eagerLoad.enabled=true

加载的命名空间，默认加载 application ，多个以逗号隔开

apollo.bootstrap.namespaces = application

apollo 的安全拉取 secret 配置

apollo.accesskey.secret = xx

集群配置

apollo.cluster = hk

缓存路径

apollo.cacheDir = /opt

是否保持和 apollo 配置页面的配置顺序一致

apollo.property.order.enable = true

加载过程解析

======

public class ApolloApplicationContextInitializer implements ApplicationContextInitializer , EnvironmentPostProcessor, Ordered {

public static final int DEFAULT_ORDER = 0;

private static final Logger logger = LoggerFactory.getLogger(ApolloApplicationContextInitializer.class);

private static final Splitter NAMESPACE_SPLITTER = Splitter.on(“,”).omitEmptyStrings().trimResults();

private static final String[] APOLLO_SYSTEM_PROPERTIES = {“app.id”, ConfigConsts.APOLLO_CLUSTER_KEY,

“apollo.cacheDir”, “apollo.accesskey.secret”, ConfigConsts.APOLLO_META_KEY, PropertiesFactory.APOLLO_PROPERTY_ORDER_ENABLE};

private final ConfigPropertySourceFactory configPropertySourceFactory = SpringInjector.getInstance(ConfigPropertySourceFactory.class);

private int order = DEFAULT_ORDER;

@Override

public void initialize(ConfigurableApplicationContext context) {

ConfigurableEnvironment environment = context.getEnvironment();

if (!environment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED, Boolean.class, false)) {

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);

initialize(environment);

}

/**

• Initialize Apollo Configurations Just after environment is ready.

• @param environment

*/

protected void initialize(ConfigurableEnvironment environment) {

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);

}

/**

• To fill system properties from environment config

*/

void initializeSystemProperty(ConfigurableEnvironment environment) {

for (String propertyName : APOLLO_SYSTEM_PROPERTIES) {

fillSystemPropertyFromEnvironment(environment, propertyName);

}

}

private void fillSystemPropertyFromEnvironment(ConfigurableEnvironment environment, String propertyName) {

if (System.getProperty(propertyName) != null) {

return;

}

String propertyValue = environment.getProperty(propertyName);

if (Strings.isNullOrEmpty(propertyValue)) {

return;

}

System.setProperty(propertyName, propertyValue);

}

/**

• In order to load Apollo configurations as early as even before Spring loading logging system phase,

• this EnvironmentPostProcessor can be called Just After ConfigFileApplicationListener has succeeded.

• 
  

• The processing sequence would be like this:
  

• Load Bootstrap properties and application properties -----> load Apollo configuration properties ----> Initialize Logging systems

• @param configurableEnvironment

• @param springApplication

*/

@Override

public void postProcessEnvironment(ConfigurableEnvironment configurableEnvironment, SpringApplication springApplication) {

// should always initialize system properties like app.id in the first place

initializeSystemProperty(configurableEnvironment);

Boolean eagerLoadEnabled = configurableEnvironment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_EAGER_LOAD_ENABLED, Boolean.class, false);

//EnvironmentPostProcessor should not be triggered if you don’t want Apollo Loading before Logging System Initialization

if (!eagerLoadEnabled) {

return;

}

Boolean bootstrapEnabled = configurableEnvironment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED, Boolean.class, false);

if (bootstrapEnabled) {

initialize(configurableEnvironment);

}

}

/**

• @since 1.3.0

*/

@Override

public int getOrder() {

return order;