关于Spring-Boot配置加载顺序解读

网站建设4年前发布
55 0 0

20230306015422b77c1b476b737d0d41f376fbd8ef7e3245de05849,(1) pom.xml如下:,(2)ConfigServerApplication.java如下:,(3) application.yaml如下:,需在gitee上创建一个仓库spring-cloud-config(名字可随意取),default-label: master表示使用master分支。,(1) pom.xml如下:,(2)ConfigOrderApplication.java如下:,使用了InitRunner演示应用初始化时输出参数的值。,(3) yaml配置文件如下:,配置环境好环境变量以及jvm启动参数。,20230306015422c7ff71b7578f3c3b323371cb1f7e1cdd099ca1872,20230306095605a5674e502ee731bfaa8175d7cd89fe1adcde69251,运行程序可以看到以下结果xxx.yyy.zzz is from-config-order.yaml,说明从配置中心获取到了配置项。,接着将配置中心的配置项改掉,表示配置中心无对应的配置项,如下:,config-order.yaml:,再次运行程序可以看到结果xxx.yyy.zzz is from-jvm-args,说明从jvm启动参数中获取到了,若将jvm参数去掉,则结果变为xxx.yyy.zzz is from-system-environment,说明从系统环境变量中获取到了。可以看到这个配置加载是有顺序的,可以继续尝试修改剩下的配置文件中的参数查看结果。,idea 中运行调试逐步查看源码。,SpringApplication.run(ConfigOrderApplication.class, args);开始debug,一直调试进入到SpringApplication类的方法ConfigurableApplicationContext run(String... args)中,直到configureIgnoreBeanInfo(environment);这一行,查看一下变量environment,如下图:,20230306015423c3ee49b5194cb68d58631541abc4cffae16166427,查看关键属性environmentpropertySourcespropertySourceList,可以看到这个List中初始化了9个属性来源,当然可以还有其他的,不过在此演示一些关键的配置项。同时可以看到关键属性propertyResolver,即属性解析器。,上面截图的List中要以看到配置文件的顺序是configurationProperties -> systemProperties -> systemEnvironment -> ... -> bootstrap.yaml -> ... -> appplication-dev.yaml -> application.yaml:,2023030609560653dcac48365c399ee5e51782ed445b56fe4ca1469,接下来看看这个PropertySourceList是怎么拼装起来的,跟踪到方法 ConfigurableEnvironment prepareEnvironment中,查看变量environment的值,如下图:,20230306015424820a5675659fdd710e93412816c8f6e78e1b7b804,可以看到getOrCreateEnvironment()方法创建完成后按顺序有两个值systemPropertiessystemEnvironment,接着继续configureEnvironment(environment,applicationArguments.getSourceArgs());此方法后查看变量,根据变量名可以猜想到应该是属于args参数,于是配置上参数观察如下,其为commandLineArgs,且加到了第一位置。,2023030601542562a9979295ee88f8806443d85b5b91d0fd346b848,20230306015425974a4048360eee052c2505fe3a6192a9435ab7304,跟踪方法configurePropertySources可以看到sources.addFirst将其添加到了第一位。,接下来是到ConfigurationPropertySources.attach(environment);,进到方法attach方法后可以跟踪到又有一个sources.addFirst,将其放到第一的位置。,20230306015426e97fc369689afb31668053c9448c0da636695d279,接着跑完listeners.environmentPrepared(bootstrapContext, environment);后可以观察到加了几项配置,在prepareEnvironment方法完成后完成了基础的准备,接着是关键方法prepareContext中完成初始化的过程。最后的结果如下:,20230306015426f29d20271978ec38344490b6b7708f39e1df06186,其中bootstrap.yaml配置是通过BootstrapApplicationListener的方法initialize中调用reorderSources完成的,可以看到是addLast;而bootstrapProperties即配置中心是通过PropertySourceBootstrapConfiguration的方法initialize中最后调用insertPropertySources完成的,其中的incoming.addFirst(p);将配置中心放到了最前面。,属性读取的过程。,前面跟着调试的代码大概了解了propertySourceList的拼装过程,下面看看PropertiesResolver是怎么解析的,同样是写一段演示代码如下,并跟踪其执行过程。,2023030609560612bab4e423f1c84545b229e88f2b613265134e292,一路调试跟踪到ConfigurationPropertySourcesPropertyResolver类中的方法findPropertyValue,再跟进到attached.findConfigurationProperty(name),可以方法里面的for循环里面getSource(),打开Evaluate录入可以看到getSource() 里面的即是前一步的propertySourceList,如下图:,202303060154270688334688d98cb2bbe0783ab40aa4ef33fe23575,从这里就可以看出关键的点,属性是从propertySourceList逐个去解析的,若前面已经获取到对应的值,则后面配置的值就不会再解析了,所以这是个优先级的问题,并不是不同配置文件之间参数覆盖的过程。,前面还注意到一个点,在配置系统环境变量的时候,配置的环境变量参数为XXX_YYY_ZZZ而并不是xxx.yyy.zzz,为什么同样可以解析到呢?这个其实是一个约定的解析方法。同样是跟踪获取配置项的方法一直进入到SpringConfigurationPropertySource的方法getConfigurationProperty中,如下:,2023030601542899a950931bb2984758e887661c4c3c95e4d7f9691,可以看到name=xxx.yyy.zzz,其中有个mapper.map(name),注意看mapperSystemEnvironmentPropertyMapper,继续跟踪到里面即可发现有个转换的过程convertName,即如下图,将xxx.yyy.zzz转换为XXX_YYY_ZZZ,所以也是可以的。,20230306015428597ee3e7706d81b4596633c3abcf757628b1e6142,配置加载时间先后顺序的问题。,前面可以看到配置文件的加载中,若从配置中心获取到配置则需要启动到prepareContext时才能从配置中心读取到配置项,如果是在配置中心配置了不同的日志格式呢?是不是得在加载到配置中心后才开始使用新的日志格式呢?可以实践得到结果的确是的,如配置中心定义日志格式为console: "%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %m%n",启动日志如下:,2023030601542868096ef51e71dc215a7683fbc69f49e5dbc937994,可以看到控制台日志格式的一个变化过程。,经过上面的分析可以得出常用配置文件中读取配置的结论:config配置中心 => jvm参数 => 系统环境变量 => 项目内的application-xxx.yaml => 项目内的application.yaml => bootstrap.yaml。,spring-boot 项目可以有多种灵活的方式设置配置项,一般来说项目内的application.yaml是一个默认配置项,再通过基本配置项对参数进行不同的赋值。

© 版权声明

相关文章