关于apollo和Spring集成@Value注解通用解析

发布时间:

发现公司集成apollo后原来的@value注入的属性不用做任何变动,也没有换成apollo的注解,遂略看源码后大致了解,做此笔记

1、根据文档可知@value

是由AutowiredAnnotationBeanPostProcessor类的postProcessPropertyValues方法进行处理的,该类为InstantiationAwareBeanPostProcessor的子类

继承关系如下图:

关于apollo和Spring集成@Value注解通用解析

2、在SpringBean创建三步走的第二步属性

注入方法AbstractAutowireCapableBeanFactory.populateBean()中,可参考我上篇文章Spring启动流程及Bean生命周期梳理。

populateBean方法中有对InstantiationAwareBeanPostProcessor接口进行调用处理,即反射获取子类并调用方法

部分源码如下:

if (hasInstAwareBpps) {
	if (pvs == null) {
		pvs = mbd.getPropertyValues();
	}
	for (BeanPostProcessor bp : getBeanPostProcessors()) {
		if (bp instanceof InstantiationAwareBeanPostProcessor) {
			InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp;
			PropertyValues pvsToUse = ibp.postProcessProperties(pvs, bw.getWrappedInstance(), beanName);
			if (pvsToUse == null) {
				if (filteredPds == null) {
					filteredPds = filterPropertyDescriptorsForDependencyCheck(bw, mbd.allowCaching);
					}
				pvsToUse = ibp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName);
				if (pvsToUse == null) {
					return;
				}
			}
			pvs = pvsToUse;
		}
	}
}

3、想必Appllo也一定是继承类似接口进行属性注入的

于是在Apollo中找到了SpringValueProcessor类,其继承关系如下图,

关于apollo和Spring集成@Value注解通用解析

BeanPostProcessor的实现类ApolloProcessor中对postProcessAfterInitialization方法进行了实现,该方法是Bean生命周期中最后一个执行的方法,所以这里处理bean的属性注入是最终的。

4、SpringValueProcessor类中

具体实现了Apollo对Value注解的处理,对value字段进行判断,并注册到自己的处理类中去处理,源码如下

  @Override
  protected void processField(Object bean, String beanName, Field field) {
// register @Value on field
Value value = field.getAnnotation(Value.class);
if (value == null) {
  return;
}
//解析value中自定义的属性
Set<String> keys = placeholderHelper.extractPlaceholderKeys(value.value());

if (keys.isEmpty()) {
  return;
}
	//注册到自己的处理器
for (String key : keys) {
  SpringValue springValue = new SpringValue(key, value.value(), bean, beanName, field, false);
  springValueRegistry.register(beanFactory, key, springValue);
  logger.debug("Monitoring {}", springValue);
}
  }

由此总结整体流程为:

Spring初始化时会处理BeanPostProcessor实现类并调用其方法,在处理到SpringValueProcessor时就会对带有Value的属性进行写入,因为该方法是Bean生命周期的最后一个方法,所以是覆盖写入最终值

5、关于动态更新apollo会触发更新Bean字段的原理则为

Apollo的PropertySourcesProcessor实现了Spring的BeanFactoryPostProcessor接口,该接口为bean生命周期最开始执行的方法。

简单来看有两步。

  • 第一步,初始化bean属性
  • 第二步,动态更新属性
@Override
  public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
initializePropertySources();
initializeAutoUpdatePropertiesFeature(beanFactory);
  }

initializePropertySources()大致处理就是把apollo的参数加载进来放入Map中用于后面bean的属性注入。

initializeAutoUpdatePropertiesFeature(beanFactory)方法会把beanFactory放入apollo的监听器中,当属性变动时通过回调和反射来修改bean的属性,具体源码后续再进行分析。