一:为何读源码
其实之前一直没想起来要读apollo的源码,直到有一次面试ali的时候,一面和二面的面试官都问了我同样的问题就是apollo如何实现配置的实时更新,当时可能看过几篇文章,感觉吹起来还是有点顺畅,虽然面试过了但是感觉回答的不是很好;后来反思总结的时候准备尽可能的读一读源码。总的来说就是要在面试的时候面试官问你,你不会一脸茫然。
二:源码怎么读
在细读xxljob源码这篇文章中我也说过,从你知道的功能点入手。那我们简单梳理下功能点。我们在页面新增/修改配置 -> 发布配置 -> 读取配置,一套操作下来项目中就能实时读取到最新的配置。这个实时的功能怎么实现的?
apollo客户端设计图
第二个问题是通信的方式是什么,这也是问题吧?
三:源码认知
首先应该要找到源码的入口在哪,通常中间价的入口一定是和Spring的生命周期相关的,一般是利用Spring的扩展点进行集成。那我们就来看下apollo是如何集成的。
很容易发现一个类
ApolloApplicationContextInitializer,这个类实现了
ApplicationContextInitializer接口,重写了initialize(
ConfigurableApplicationContext context)方法,那实现了接口就会执行initialize方法了吗?当然不是,要想执行方法有3种方式,
- 第一种是在 classpath 路径下的 META-INF/spring.factories 文件中填写接口和实现类的全名,多个实现的话用逗号分隔。
- 第二种是在 Spring Boot 启动代码中手动添加初始化器,
- 第三种是在 application.factories 中配置 org.springframework.context.ApplicationContextInitializer,Apollo也是采用的这种方式。如图
这样相应的
ApplicationContextInitializer实现类就会被SpringApplication#initialize发现.
方法中依次获取对应的 namespace 的配置, 并将配置使用 addFirst() 具有最高优先级属性源的设置方法, 添加到了 spring 的配置上下文中。这里解释了为什么 apollo 的配置的优先级最高,比 application.properties 中直接配置都要高。
接下来了解一下JDK的SPI机制,简单讲就是JDK内置的一种服务提供发现机制,可以用来启用框架扩展和替换组件,比如apollo这里就是利用加载这几个类来实现对应的扩展,在META-INF/services路径下放几个文件,里面配置文件的项目全路径。
对应的2个类
ConfigPropertySourcesProcessor,ApolloConfigRegistrar;其中关于Spring生命周期的相关知识如果不熟悉可以自己查看一下相关文章。
- ConfigPropertySourcesProcessor继承PropertySourcesProcessor,首先实现了BeanDefinitionRegistryPostProcessor接口,PropertySourcesProcessor实现了BeanFactoryPostProcessor接口,重写了postProcessBeanFactory方法(实例化bean之前),PropertySourcesProcessor重写了postProcessBeanDefinitionRegistry方法(读取项目中的beanDefinition之后执行);同时在本类中还利用JDK的SPI加载了ConfigPropertySourcesProcessorHelper。
- ApolloConfigRegistrar这个类实现ImportBeanDefinitionRegistrar接口,这样机会自动加载到spring容器中,实现EnvironmentAware接口获取spring的environment能力;同时在本类中还利用JDK的SPI加载了ApolloConfigRegistrarHelper。
这两个类都在做一件事就是注册相关类,其中包括
PropertySourcesPlaceholderConfigurer,PropertySourcesProcessor(此类是Apollo中用来实现属性动态加载得到关键),SpringValueProcessor,
- PropertySourcesPlaceholderConfigurer:占位符处理类,优先级调整为0(此类间接实现了BeanFactoryPostProcessor,所以给其设置优先级,并且优先级越小越先注册,目的就是要在PropertyPlaceholderConfigurer配置类之前注册,用来解析占位符${}得。因为此处spring版本3.0之前默认是使用PropertyPlaceholderConfigurer,后面得版本使用PropertySourcesPlaceholderConfigurer来代替,并且5.2版本已经不推荐使用了)
- PropertySourcesProcessor:优先级设置最高。其中bean工厂处理器得回调方法中会执行两个关键性得方法
initializePropertySources方法:初始化Apollo得名为ApolloPropertySources得属性资源配置,将前面添加到多值映射map中得namespace遍历依次通过ConfigService.getConfig(namespace)代码来获取配置Config(此处看似很简单,但是其中涉及到得却是整个Apollo客户端与服务端交互得逻辑),然后构造ConfigPropertySource(Apollo中得类,实现了
org.springframework.core.env.EnumerablePropertySource)添加到创建得CompositePropertySource组合配置属性类中,接着将NAMESPACE_NAMES缓存清掉,最后如果spring environment中包含名为
ApolloBootstrapPropertySources得启动属性配置,则将上面创建得CompositePropertySource对象添加到其之后,如果没有,则添加到第一位(确保Apollo得属性配置放在第一位)
initializeAutoUpdatePropertiesFeature方法:创建
AutoUpdateConfigChangeListener监听器,此类实现了配置监听器接口ConfigChangeListener,是实现诸如@Value注解属性动态刷新得关键。获取所有namespace对应得ConfigPropertySource,将监听器添加进去实现监听
- SpringValueProcessor此类用来处理带有@Value注解得属性字段,并将值通过SpringValueRegistry注册器添加到注册器缓存map中(上面提到得监听器AutoUpdateConfigChangeListener接收到配置变更时就会通过反射更新缓存中得值)
关于ConfigService.getConfig(namespace)下一篇说。。。。。。