Spring Framework&Spring Boot集成apollo源碼分析

作者：大禹的足跡 2023-01-10 07:52:15

ApolloConfigRegistrar最終將apollo中BeanDefinitionRegistryPostProcessor、BeanFactoryPostProcessor、BeanPostProcessor實現(xiàn)類的注冊到spring容器中（具體實現(xiàn)類與Spring Framework部分基本是一致的），后續(xù)的邏輯與Spring Framework部分分析的是一致的了。

引言

為了在項目中用好框架，以及出現(xiàn)問題時候能夠快速定位、分析、優(yōu)化，文章嘗試從源碼角度分析Spring集成apollo的過程。期望文章能夠把以下幾個事情描述清楚：

apollo通過使用Spring哪些擴展點，完成了與Spring的集成；
apollo中的配置如何融入到Spring Environment；
apollo中的配置項如何賦值給Spring Bean相關字段、方法；
在應用運行過程中，當修改apollo中的配置，配置如何在Spring Bean相關字段、方法上生效的

由于Spring Framework和Spring Boot集成apollo的方式有些許不同，分別進行分析。

Spring Framework

示例

Spring XML配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:apollo="http://www.ctrip.com/schema/apollo"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.ctrip.com/schema/apollo
        http://www.ctrip.com/schema/apollo.xsd"
>
    <apollo:config namespaces="application,public_namespace"/>
    <context:component-scan base-package="test.springframework"/>
      
      <bean id="test" class="test.springframework.Test">
        <property name="test1" value="${test1}"/>
    </bean>
</beans>

apollo:config配置的是apollo app.id中的命令空間（app.id、app.meta配置可以參考apollo官方文檔）；
context:component-scan配置的是Spring component注解的掃描路徑；
另一個重要的配置是xmlns:apollo="http://www.ctrip.com/schema/apollo"，后面內容會有分析。

Spring Bean

package test.springframework;
public class Test {
    @ApolloConfig
    private Config config;
    @Value("${test2:}")
    private String test2;
    private String test1;
    public String getTest1(){
        return test1;
    }
    public void setTest1(String test1){
        this.test1 = test1;
    }
    @ApolloConfigChangeListener
    public void onChange(ConfigChangeEvent changeEvent){
        System.out.println(changeEvent);
    }
}

集成分析

refresh時序圖

圖中概括地描述了refresh過程，其中標識黃顏色的地方是這次分析的重點，下面分別進行描述。

解析apollo:config

當解析xml文件apollo:config標記的時候調用BeanDefinitionParserDelegate.parseCustomElement(…)，主要流程如下：

個性化命名空間解析

圖中流程主要完成了兩件事：

將xml中配置的apollo命名空間存儲到了PropertySourcesProcessor(屬于apollo jar包)類中的NAMESPACE_NAMES字段；
將ConfigPropertySourcesProcessor(屬于apollo jar包)作為BeanDefinition注冊到了Spring容器中；ConfigPropertySourcesProcessor實現(xiàn)了Spring接口BeanDefinitionRegistryPostProcessor、BeanFactoryPostProcessor。

調用BeanFactoryPostProcessor

apollo中ConfigPropertySourcesProcessor實現(xiàn)了Spring接口BeanDefinitionRegistryPostProcessor、BeanFactoryPostProcessor，ConfigPropertySourcesProcessor實現(xiàn)如下：

public class ConfigPropertySourcesProcessor extends PropertySourcesProcessor
    implements BeanDefinitionRegistryPostProcessor {
  //使用java SPI機制，ConfigPropertySourcesProcessorHelper對應的實現(xiàn)類是DefaultConfigPropertySourcesProcessorHelper，這段代碼完成了apollo client初始化
  private ConfigPropertySourcesProcessorHelper helper = ServiceBootstrap.loadPrimary(ConfigPropertySourcesProcessorHelper.class);

  @Override
  public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
    helper.postProcessBeanDefinitionRegistry(registry);
  }
}

調用BeanDefinitionRegistryPostProcessor.postProcessBeanDefinitionRegistry

實際調用的是
DefaultConfigPropertySourcesProcessorHelper.postProcessBeanDefinitionRegistry方法，該方法主要完成以下幾件事：

將PropertySourcesPlaceholderConfigurer注冊到spring容器中，該類實現(xiàn)了接口BeanFactoryPostProcessor，用于占位符的轉換處理；
將ApolloAnnotationProcessor注冊到spring容器中，該類實現(xiàn)了接口BeanPostProcessor；
將SpringValueProcessor注冊到spring容器中，該類實現(xiàn)了接口BeanFactoryPostProcessor和BeanPostProcessor；
將ApolloJsonValueProcessor注冊到spring容器中，該類實現(xiàn)了接口BeanPostProcessor；
將BeanDefinition中帶有占位符的所有屬性存儲到Map<BeanDefinitionRegistry, ?Multimap<String, SpringValueDefinition>>結構中

調用BeanFactoryPostProcessor.postProcessBeanFactory

PropertySourcesProcessor

CompositePropertySource composite = new CompositePropertySource(PropertySourcesConstants.APOLLO_PROPERTY_SOURCE_NAME);
ImmutableSortedSet<Integer> orders = ImmutableSortedSet.copyOf(NAMESPACE_NAMES.keySet());
Iterator<Integer> iterator = orders.iterator();

while (iterator.hasNext()) {
    int order = iterator.next();
    for (String namespace : NAMESPACE_NAMES.get(order)) {
        Config config = ConfigService.getConfig(namespace);
        composite.addPropertySource(configPropertySourceFactory.getConfigPropertySource(namespace, config));
    }
}
NAMESPACE_NAMES.clear();
environment.getPropertySources().addFirst(composite);

NAMESPACE_NAMES中存儲的是應用配置的apollo命名空間；
通過Config config = ConfigService.getConfig(namespace)獲取每個命名空間的配置對象，將Config對象封裝成ConfigPropertySource，接著將所有ConfigPropertySource放入CompositePropertySource，最后將CompositePropertySource加入到spring ConfigurableEnvironment中，此時spring容器的ConfigurableEnvironment已經(jīng)擁有了apollo命令空間的配置；

AutoUpdateConfigChangeListener autoUpdateConfigChangeListener = new AutoUpdateConfigChangeListener(environment, beanFactory);

List<ConfigPropertySource> configPropertySources = configPropertySourceFactory.getAllConfigPropertySources();
for (ConfigPropertySource configPropertySource : configPropertySources) {
  configPropertySource.addChangeListener(autoUpdateConfigChangeListener);
}

為apollo命名空間對象添加監(jiān)聽AutoUpdateConfigChangeListener，當改變命名空間中配置的時候，該監(jiān)聽完成Bean對象屬性值得更新，及方法的調用。

PropertySourcesPlaceholderConfigurer

將ConfigurableEnvironment構造成自身的PropertySource；

new PropertySource<Environment>(ENVIRONMENT_PROPERTIES_PROPERTY_SOURCE_NAME, this.environment) {
  public String getProperty(String key) {
    return this.source.getProperty(key);
  }
}

通過自身的PropertySource構造PropertySourcesPropertyResolver，PropertySourcesPropertyResolver中完成解析的類是PropertyPlaceholderHelper；

new PropertySourcesPropertyResolver(this.propertySources)

構造StringValueResolver，然后調用PropertySourcesPropertyResolver來進行解析；

StringValueResolver valueResolver = strVal -> {
    String resolved = (ignoreUnresolvablePlaceholders ?
                       propertyResolver.resolvePlaceholders(strVal) :
                       propertyResolver.resolveRequiredPlaceholders(strVal));
    if (trimValues) {
        resolved = resolved.trim();
    }
    return (resolved.equals(nullValue) ? null : resolved);
};

構造BeanDefinitionVisitor，用于解析BeanDefinition包含的所有String值（屬性、構造方法參數(shù)、元數(shù)據(jù)），解析找到的任何占位符。

BeanDefinitionVisitor visitor = new BeanDefinitionVisitor(valueResolver);

public void visitBeanDefinition(BeanDefinition beanDefinition) {
    visitParentName(beanDefinition);
    visitBeanClassName(beanDefinition);
    visitFactoryBeanName(beanDefinition);
    visitFactoryMethodName(beanDefinition);
    visitScope(beanDefinition);
    if (beanDefinition.hasPropertyValues()) {
        visitPropertyValues(beanDefinition.getPropertyValues());
    }
    if (beanDefinition.hasConstructorArgumentValues()) {
        ConstructorArgumentValues cas = beanDefinition.getConstructorArgumentValues();
        visitIndexedArgumentValues(cas.getIndexedArgumentValues());
        visitGenericArgumentValues(cas.getGenericArgumentValues());
    }
}

@Nullable
protected String resolveStringValue(String strVal) {
    if (this.valueResolver == null) {
        throw new IllegalStateException("No StringValueResolver specified - xxx");
    }
    // 最終調用的是PropertySourcesPropertyResolver中的resolveXXX方法String resolvedValue = this.valueResolver.resolveStringValue(strVal);
    return (strVal.equals(resolvedValue) ? strVal : resolvedValue);
}

調用BeanPostProcessor

ApolloAnnotationProcessor

用于解析apollo注解ApolloConfig、
ApolloConfigChangeListener。

ApolloConfig

為注解為ApolloConfig的字段賦值對應的namespace Config對象。

protected void processField(Object bean, String beanName, Field field) {
  ApolloConfig annotation = AnnotationUtils.getAnnotation(field, ApolloConfig.class);
  if (annotation == null) {
    return;
  }
  
  Preconditions.checkArgument(Config.class.isAssignableFrom(field.getType()),
    "Invalid type: %s for field: %s, should be Config", field.getType(), field);
  
  String namespace = annotation.value();
  Config config = ConfigService.getConfig(namespace);
  
  ReflectionUtils.makeAccessible(field);
  ReflectionUtils.setField(field, bean, config);
}

ApolloConfigChangeListener

為注解為ApolloConfigChangeListener的方法添加namespace的監(jiān)聽。

ApolloConfigChangeListener annotation = AnnotationUtils
        .findAnnotation(method, ApolloConfigChangeListener.class);
String[] namespaces = annotation.value();
ConfigChangeListener configChangeListener = new ConfigChangeListener() {
  @Override
  public void onChange(ConfigChangeEvent changeEvent) {
  ReflectionUtils.invokeMethod(method, bean, changeEvent);
  }
};
for (String namespace : namespaces) {
  Config config = ConfigService.getConfig(namespace);
  config.addChangeListener(configChangeListener);
}

SpringValueProcessor

將Bean中含有Value注解的字段、方法注冊到SpringValueRegistry（Map<BeanFactory, Multimap<String, SpringValue>>）中，SpringValue保存了Bean實例，對應的key，F(xiàn)ield或Method；

protected void processField(Object bean, String beanName, Field field) {
  Value value = field.getAnnotation(Value.class);
  Set<String> keys = placeholderHelper.extractPlaceholderKeys(value.value());
  for (String key : keys) {
    SpringValue springValue = new SpringValue(key, value.value(), bean, beanName, field, false);
    springValueRegistry.register(beanFactory, key, springValue);
  }
}
protected void processMethod(Object bean, String beanName, Method method) {
  Value value = method.getAnnotation(Value.class);
  Set<String> keys = placeholderHelper.extractPlaceholderKeys(value.value());
  for (String key : keys) {
    SpringValue springValue = new SpringValue(key, value.value(), bean, beanName, method, false);
    springValueRegistry.register(beanFactory, key, springValue);
  }
}

將DefaultConfigPropertySourcesProcessorHelper中解析的Map<BeanDefinitionRegistry, Multimap<String, SpringValueDefinition>>轉換為SpringValue保存在SpringValueRegistry中；
前面在PropertySourcesProcessor類中對每個namespace Config對象注冊了監(jiān)聽AutoUpdateConfigChangeListener，AutoUpdateConfigChangeListener類含有SpringValueRegistry的引用；
當namespace Config配置改變的時候會通知到AutoUpdateConfigChangeListener，AutoUpdateConfigChangeListener通過配置key找到對應的SpringValue對象，通過SpringValue改變Bean對應的屬性，或調用Bean對應的方法。

ApolloJsonValueProcessor

將Bean中含有ApolloJsonValue注解的字段、方法注冊到SpringValueRegistry（Map<BeanFactory, Multimap<String, SpringValue>>）中，SpringValue保存了Bean實例，對應的key，F(xiàn)ield或Method；
對于注解在Field的情況，獲取ApolloJsonValue key的配置，將配置轉換為Field對應類型的對象并完成對Field的賦值；

protected void processField(Object bean, String beanName, Field field) {
  ApolloJsonValue apolloJsonValue = AnnotationUtils.getAnnotation(field, ApolloJsonValue.class);
  String placeholder = apolloJsonValue.value();
  Object propertyValue = placeholderHelper
    .resolvePropertyValue(beanFactory, beanName, placeholder);
  boolean accessible = field.isAccessible();
  field.setAccessible(true);
  ReflectionUtils
    .setField(field, bean, parseJsonValue((String)propertyValue, field.getGenericType()));
  field.setAccessible(accessible);
  if (configUtil.isAutoUpdateInjectedSpringPropertiesEnabled()) {
    Set<String> keys = placeholderHelper.extractPlaceholderKeys(placeholder);
    for (String key : keys) {
    SpringValue springValue = new SpringValue(key, placeholder, bean, beanName, field, true);
    springValueRegistry.register(beanFactory, key, springValue);
    }
  }
}

對于注解在Method的情況，獲取ApolloJsonValue key的配置，將配置轉換為Method入?yún)愋偷膶ο蟛⑼瓿蓪ethod的調用

protected void processMethod(Object bean, String beanName, Method method) {
  ApolloJsonValue apolloJsonValue = AnnotationUtils.getAnnotation(method, ApolloJsonValue.class);
  String placeHolder = apolloJsonValue.value();
  Object propertyValue = placeholderHelper
    .resolvePropertyValue(beanFactory, beanName, placeHolder);
  boolean accessible = method.isAccessible();
  method.setAccessible(true);
  ReflectionUtils.invokeMethod(method, bean, parseJsonValue((String)propertyValue, types[0]));
  method.setAccessible(accessible);
  
  if (configUtil.isAutoUpdateInjectedSpringPropertiesEnabled()) {
    Set<String> keys = placeholderHelper.extractPlaceholderKeys(placeHolder);
    for (String key : keys) {
    SpringValue springValue = new SpringValue(key, apolloJsonValue.value(), bean, beanName,method, true);
    springValueRegistry.register(beanFactory, key, springValue);
    }
  }
}

Spring Boot

示例

// Spring Boot啟動類
@SpringBootApplication
@EnableApolloConfig
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
//測試Bean見Spring Framework部分示例

上面代碼中的@EnableApolloConfig是一個接入點，后面會分析到。

集成分析

Spring Boot啟動流程

圖中概括地描述了SpringApplication啟動過程（其中會將啟動類加入到spring容器中），其中標識黃顏色的地方是這次分析的重點，下面分別進行描述。

加載apollo ApplicationContextInitializer

通過SpringFactoriesLoader加載apollo jar包中META-INF/spring.factories文件，解析ApplicationContextInitializer實現(xiàn)類ApolloApplicationContextInitializer。

setInitializers((Collection) getSpringFactoriesInstances(
        ApplicationContextInitializer.class));
// 通過SpringFactoriesLoader加載、解析META-INF/spring.factories
private <T> Collection<T> getSpringFactoriesInstances(Class<T> type,
    Class<?>[] parameterTypes, Object... args) {
  ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
  Set<String> names = new LinkedHashSet<>(
      SpringFactoriesLoader.loadFactoryNames(type, classLoader));
  List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
      classLoader, args, names);
  AnnotationAwareOrderComparator.sort(instances);
  return instances;
}

apollo ApplicationContextInitializer initialize

ApolloApplicationContextInitializer解析apollo.bootstrap.namespaces配置的命名空間名稱，然后通過Config config = ConfigService.getConfig(namespace)獲取每個命名空間的配置對象，將Config對象封裝成ConfigPropertySource，接著將所有ConfigPropertySource放入CompositePropertySource，最后將CompositePropertySource加入到spring ConfigurableEnvironment中，此時spring容器的ConfigurableEnvironment已經(jīng)擁有了apollo命令空間的配置。

protected void initialize(ConfigurableEnvironment environment) {
  String namespaces = environment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_NAMESPACES, ConfigConsts.NAMESPACE_APPLICATION);
  List<String> 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);
}

初始化BeanDefinitionLoader

我們關注BeanDefinitionLoader類中屬性annotatedReader=new
AnnotatedBeanDefinitionReader(registry)，AnnotatedBeanDefinitionReader構造方法如下：

public AnnotatedBeanDefinitionReader(BeanDefinitionRegistry registry, Environment environment) {
  this.registry = registry;
  this.conditionEvaluator = new ConditionEvaluator(registry, environment, null);
  // 將Annotation相關的處理類注冊到Spring容器中，如：// ConfigurationClassPostProcessor : 處理Configuration注解// AutowiredAnnotationBeanPostProcessor : 處理Value注解// RequiredAnnotationBeanPostProcessor : 處理Required注解// CommonAnnotationBeanPostProcessor : 處理PostConstruct/PreDestroy/Resource/Lazy注解// ... ...
  AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);
}

與我們這次分析相關的類是：
ConfigurationClassPostProcessor，該類實現(xiàn)了BeanDefinitionRegistryPostProcessor、BeanFactoryPostProcessor接口。

ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry

判斷spring容器中BeanDefinition是否含有Configuration、Component、ComponentScan、Import

ImportResource、Bean注解，沒有則直接返回；

構造ConfigurationClassParser（Parses a Configuration class definition, populating a collection of ConfigurationClass objects (parsing a single Configuration class may result in any number of ConfigurationClass objects because one Configuration class may import another using the Import annotation)），接著對BeanDefinition上的Configuration、Component、ComponentScan、Import

ImportResource、Bean注解進行解析。

解析完成后，通過ConfigurationClassBeanDefinitionReader.loadBeanDefinitions(ConfigurationClass)進行apollo相關BeanDefinition的加載：apollo EnableApolloConfig注解的定義如下

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
// 在上面parse階段會將Import封裝在ConfigurationClass中
@Import(ApolloConfigRegistrar.class)
public @interface EnableApolloConfig {
  String[] value() default {ConfigConsts.NAMESPACE_APPLICATION};
  int order() default Ordered.LOWEST_PRECEDENCE;
}

ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsFromRegistrars會調用到ApolloConfigRegistrar類的registerBeanDefinitions方法

private void loadBeanDefinitionsFromRegistrars(Map<ImportBeanDefinitionRegistrar, AnnotationMetadata> registrars) {
  registrars.forEach((registrar, metadata)
      registrar.registerBeanDefinitions(metadata, this.registry));
}

ApolloConfigRegistrar最終將apollo中BeanDefinitionRegistryPostProcessor、BeanFactoryPostProcessor、BeanPostProcessor實現(xiàn)類的注冊到spring容器中（具體實現(xiàn)類與Spring Framework部分基本是一致的），后續(xù)的邏輯與Spring Framework部分分析的是一致的了。

public class ApolloConfigRegistrar implements ImportBeanDefinitionRegistrar {

  private ApolloConfigRegistrarHelper helper = ServiceBootstrap.loadPrimary(ApolloConfigRegistrarHelper.class);

  @Override
  public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry){
  // 該方法中將apollo相關類注冊到spring容器中，如：// PropertySourcesProcessor// ApolloAnnotationProcessor// SpringValueProcessor// SpringValueDefinitionProcessor// ApolloJsonValueProcessor
    helper.registerBeanDefinitions(importingClassMetadata, registry);
  }
}

總結

?文章主要介紹了apollo借助Spring擴展點完成了與Spring的集成:Spring Framework集成方式使用到了loadBeanDefinitions階段中apollo:config NamespaceHandler，BeanDefinitionRegistryPostProcessor，BeanFactoryPostProcessor，BeanPostProcessor；Spring Boot集成方式使用到了ApplicationContextInitializer，BeanDefinitionRegistryPostProcessor，BeanFactoryPostProcessor，BeanPostProcessor;

apollo還提供了通過注解類ApolloAutoConfiguration與Spring Boot完成集成，原理是一致的。

責任編輯：武曉燕來源：今日頭條

Spring 源碼容器