最近公司项目在做SpringBoot的升级,在升级过程中遇到了一些问题,简单记录一下,做个分享。另外,本文中的程序只为示例代码,并非公司生产环境代码。

遇到什么问题

从SpringBoot1.x升级到SpringBoot2.x之后,解决完编译异常,运行程序,在程序启动时报错:

报错信息

报错信息就已经很直白的告诉了我们错误原因:

配置属性名称“com_shen”无效

无效字符: '_', 原因:规范名称应为kebab-case(用'-'分隔),小写字母数字字符,并且必须以字母开头

怎么解决

经过排查,是因为在application.properties文件中有如下一个配置项:

com_shen.name=xiaohei

对应Java程序代码:

@Getter @Setter @ConfigurationProperties(prefix = "com_shen") public class Service {     private String name; } 

结合报错日志,我们可以很容易的解决这个问题,去掉配置项中的_,将配置项name修改为com.shen.name即可。

源码解析

你以为文章写到这里就结束了吗?其实并没有。hhhhhh,通过这个问题,我们来看一下SpringBoot2.x的内部源码。什么,你不知道该从哪里入手来看这个源码,没关系,我们一步一步来。

点开@ConfigurationProperties源码,

@ConfigurationProperties源码

在Spring中,大量的功能都是通过BeanPostProcessor来实现的。而且,Spring中的源码注释写的非常的仔细。通过源码注释我们可以猜到可能是ConfigurationPropertiesBindingPostProcessor这个类在负责@ConfigurationProperties注解的背后支持。

点开ConfigurationPropertiesBindingPostProcessor类源码,发现在该类中Override了BeanPostProcessorpostProcessBeforeInitialization方法:
ConfigurationPropertiesBindingPostProcessor#postProcessBeforeInitialization
在这个方法中,调用了bind(bean, beanName, annotation);方法。这个方法名叫"绑定",方法中传入了bean、beanName和annotation的信息,经验告诉我这个方法大概率就是在负责解析@ConfigurationProperties,进行属性绑定。

于是,在这里打一个条件断点,debug运行项目:

条件断点

通过debug发现的确是这个方法在进行属性绑定。而且底层调用了org.springframework.boot.context.properties.bind.Binder#bind(String, Bindable<T>, BindHandler)方法:

bind方法

在这个bind方法中,又调用了另一个方法bind(ConfigurationPropertyName.of(name), target, handler);,而且通过name生成了