记一次spring注解@Value不生效的深度排查

​上周遇到一个有意思的问题,拿出来分享一下。
问题可以简单地描述如下:在springboot中以starter的方式引入dubbo,但注册中心的配置使用javaConfig的方式,先贴出配置代码

@Configuration
public class DubboRegistryConfig {
​
    @Value("${dynamic.dubbo.registries.nacos.address:#{null}}")
    private String nacosAddress;
​
    @Value("${dynamic.dubbo.registries.zk.address:#{null}}")
    private String zkAddress;
​
    @Bean
    public RegistryConfig nacosRegistry() {
        RegistryConfig nacosConfig = new RegistryConfig();
        nacosConfig.setAddress(nacosAddress);
        nacosConfig.setProtocol("nacos");
        return nacosConfig;
    }
​
    @Bean
    public RegistryConfig zkRegistry() {
        RegistryConfig zkConfig = new RegistryConfig();
        zkConfig.setAddress(zkAddress);
        zkConfig.setProtocol("zookeeper");
        return zkConfig;
    }
​
    @Bean
    public ConsumerConfig consumerConfig() {
        ConsumerConfig consumerConfig = new ConsumerConfig();
        List<RegistryConfig> registryConfigs = new ArrayList<>(2);
        registryConfigs.add(nacosRegistry());
        registryConfigs.add(zkRegistry());
        consumerConfig.setRegistries(registryConfigs);
        return consumerConfig;
    }
​
    @Bean
    public ProviderConfig providerConfig() {
        ProviderConfig providerConfig = new ProviderConfig();
        providerConfig.setRegistry(zkRegistry());
        return providerConfig;
    }
​
}

将这段代码打成jar包,在主工程中引入,启动类上使用@Import引入

@SpringBootApplication
@Import(DubboRegistryConfig.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(Application.class);
        application.run(args);
    }
}

当然,注册中心地址写在application.properties文件中。
运行一下,奇怪的事情发生了,方便起见,我把调试截图贴出来


image

当运行到consumerConfig代码时,两个注册中心的地址并没有注入进来,这是怎么回事?下意识地看了下程序运行日志,发现了一条可疑日志

ConfigurationClassPostProcessor.enhanceConfigurationClasses()|Cannot enhance @Configuration bean definition 'com.lkxiaolou.registry.dynamic.config.DubboRegistryConfig' since its singleton instance has been created too early. The typical cause is a non-static @Bean method with a BeanDefinitionRegistryPostProcessor return type: Consider declaring such methods as 'static'. 

大概意思是,由于DubboRegistryConfig bean实例化太早,导致没有被ConfigurationClassPostProcessor增强。好像跟bean的生命周期有关,这个配置类中定义了三个bean,加上配置类自身也是一个bean,想办法看一下这四个bean的加载顺序是不是有助于问题的解决?于是,我在配置代码中输出一些调试信息

@Configuration
public class DubboRegistryConfig {
​
    @Value("${dynamic.dubbo.registries.nacos.address:#{null}}")
    private String nacosAddress;
​
    @Value("${dynamic.dubbo.registries.zk.address:#{null}}")
    private String zkAddress;
​
    @PostConstruct
    public void init() {
        System.out.println("=== DubboRegistryConfig inited");
    }
​
    @Bean
    @DependsOn("dubboRegistryConfig")
    public RegistryConfig nacosRegistry() {
        System.out.println("=== nacosRegistry create");
        RegistryConfig nacosConfig = new RegistryConfig();
        nacosConfig.setAddress(nacosAddress);
        nacosConfig.setProtocol("nacos");
        return nacosConfig;
    }
​
    @Bean
    public RegistryConfig zkRegistry() {
        System.out.println("=== zkRegistry create");
        RegistryConfig zkConfig = new RegistryConfig();
        zkConfig.setAddress(zkAddress);
        zkConfig.setProtocol("zookeeper");
        return zkConfig;
    }
​
    @Bean
    public ConsumerConfig consumerConfig() {
        System.out.println("=== consumerConfig create");
        ConsumerConfig consumerConfig = new ConsumerConfig();
        List<RegistryConfig> registryConfigs = new ArrayList<>(2);
        registryConfigs.add(nacosRegistry());
        registryConfigs.add(zkRegistry());
        consumerConfig.setRegistries(registryConfigs);
        return consumerConfig;
    }
​
    @Bean
    public ProviderConfig providerConfig() {
        System.out.println("=== providerConfig create");
        ProviderConfig providerConfig = new ProviderConfig();
        providerConfig.setRegistry(zkRegistry());
        return providerConfig;
    }
}

最后只有三个bean正常输出了调试信息

=== consumerConfig create
=== nacosRegistry create
=== zkRegistry create

providerConfig没有输出可以理解,因为程序挂掉了,但是为什么DubboRegistryConfig没有执行@PostConstruct?它的bean是存在的吗?还是没来得及初始化?试着给它注入个ApplicationContext,调试一把


image

发现在nacosRegistry创建的时候,居然找不到DubboRegistryConfig的bean定义,难道是@Import使用姿势不对?
于是把@Import改成包扫描,再调试发现可以找到DubboRegistryConfig的bean了,但是@PostConstruct依然不执行,属性依旧没有注入。


image

先捋一捋,我们最初的问题是@Configuration无法注入@Value,通过@Import导入@Configuration,@Configuration本身不是一个bean,自然@Value就无法装配属性,但当我们改成包扫描后,能获取到@Configuration本身的bean,但是属性依然没有注入,@PostConstruct依然没有执行。
bean生成了,但@Value与@PostConstruct注解没有生效,我们把焦点放到这两个注解上,这两个注解是怎么实现的?查询了一下资料,@PostConstruct是依靠InitDestroyAnnotationBeanPostProcessor实现,@Value是依靠AutowiredAnnotationBeanPostProcessor实现,从名字上就能看出这两个类实现了BeanPostProcesser,BeanPostProcesser提供了在bean执行初始化(init-method)前后插入hock的能力。也就是说,DubboRegistryConfig的bean没有执行BeanPostProcesser,为了验证猜想,断点找出堆栈,顺藤摸瓜
image

从堆栈中发现了是dubbo的ReferenceBean触发了DubboRegistry的bean的初始化


image

那么为什么ReferenceBean初始化DubboRegistryConfig中的bean不会触发BeanPostProcesser呢?又是谁初始化ReferenceBean的?
接着调试,发现Spring容器初始化的时候初始化了ServiceAnnotationBeanPostProcessor,这是dubbo-spring-boot-starter提供的一个类,它实现了BeanFactoryPostProcessor接口的方法postProcessBeanDefinitionRegistry,可以在bean定义加载完成后,bean尚未初始化时对bean的定义进行修改。它和BeanPostProcesser的执行顺序是先调用BeanFactoryPostProcessor,再注册BeanPostProcesser,如果BeanFactoryPostProcessor中创建了bean,那么它就不会执行BeanPostProcesser,也就是@Value和@PostConstruct无法生效。
image

那么问题归结于,为什么在BeanFactoryPostProcessor中会创建bean呢?
接着调试,ServiceAnnotationBeanPostProcessor定义在DubboAutoConfiguration,并且需要注入一个Environment
image

通过调试发现问题就出在注入Environment这个过程。
注入Envioment需要先找到Environment这个类型的bean,调用DefaultListableBeanFactory.doGetBeanNamesForType
image

doGetBeanNamesForType需要遍历所有bean定义,判断出需要的bean(并不需要初始化bean),但是在循环到dubbo的ReferenceBean时,发现它的isFactoryBean为true,此时会调用AbstractBeanFactory.getTypeForFactoryBean方法


image

这个方法就会初始化bean了,这是为什么?

原来ReferenceBean实现了FactoryBean接口,FactoryBean可以理解为生产bean的bean,可以根据复杂的情况生产不同的bean,再来看ReferenceBean其实很好理解,因为dubbo的reference是不同的调用代理,也就是不同的bean,用ReferenceBean来实现很好理解。
那为什么判断类型时FactoryBean产生的bean需要实例化呢?也好理解,如果不实例化是不知道FactoryBean产生的是什么bean,所以只有这种类型的bean会被提前初始化。
差不多到这里已经水落石出了,我们简单总结一下:
@Configuration中无法注入@Value与@PostConstruct无法执行,我们查到是Configuration的bean已经初始化,但是注解失效;
调研了一下@Value与@PostConstruct的原理是BeanPostProcesser;
根据堆栈找到dubbo-spring-starter中ServiceAnnotationBeanPostProcessor的实现是BeanFactoryPostProcesser,它的执行要在BeanPostProcesser注入之前;
实例化ServiceAnnotationBeanPostProcessor时注入Environment,需要扫描所有bean的定义;
dubbo的ReferenceBean是基于FactoryBean实现,而4中的扫描对于普通bean不会触发实例化,但FactoryBean产生的bean会被实例化;
于是ReferenceBean实例化时触发DubboRegistryConfig中bean的实例化,进而触发DubboRegistryConfig实例化,而这一切发生在BeanPostProcesser生效之前。
问题找到了,解决就很简单,这种情况下不要使用这两种注解,可以实现InitializingBean的afterPropertiesSet来代替@Postconstruct,实现EnvironmentAware的setEnvironment接口来代替@Value获取配置。
最后,文章中还有几处没有详细写出来,大家伙可以试着分析分析,一是为什么@Import导入的jar包中的@Configuration不是一个bean?另一个是文章中第一次执行程序输出日志有什么意义?


欢迎关注我的公众号“捉虫大师”

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,014评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,796评论 3 386
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,484评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,830评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,946评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,114评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,182评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,927评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,369评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,678评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,832评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,533评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,166评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,885评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,128评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,659评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,738评论 2 351

推荐阅读更多精彩内容