Spring bean 加载顺序导致的 bug 问题

一、问题描述

今天启动 spring boot 项目的时候，有时候会报加载不到配置文件的属性。配置文件的属性是用 @Value 获取的，属性有时候会是 null 。

程序经过简化，是这样的，有一个 InitConfig 类，用来让静态工具类能获取到配置文件的属性值。内容是这样的：

image.png

在静态工具类中，通过 InitConfig.load(); 来获取配置文件中的属性值，这是没问题的，因为 @Configuration 类会在 spring 程序启动过程中就执行了。

但如果在 @Service 修饰的类中，调用 InitConfig.load(); 如下图所示：

image.png

这样，有时候就会获取不到配置文件中的属性值。如下图所示：

image.png

很奇怪，经过研究尝试，终于了解了其中的缘由。现在给大家分享一下。

二、spring bean 加载顺序

之前我一直以为 @Configuration 会比 @Service、@Component 优先执行。其实不对。看下面的代码片段：

文件结构：

image.png

Aaa.java 文件：

image.png

Bb.java 文件：

image.png

再结合上面的 InitConfig.java 文件。当项目启动的过程中，你会发现这样的结果：

image.png

Aaa.java 先执行，Bb.java 其次，InitConfig.java 文件最后执行。这样就验证了 @Configuration 并不会比 @Service、@Component 优先执行。

我猜测的应该是，spring 将上面带有注解的类都放在一起，统一加载。默认是根据 包名+文件名称 来判断加载顺序的。

@Configuration、@Service、@Component 都会将修饰的类交给 spring 来管理，文件初始化的时候，会加载属性，无参构造方法等。

三、设置 spring bean 加载顺序

有这么一个注解，@DependsOn，它可以指定依赖哪个 bean ，让自己在该 bean 之后加载。这样就可以实现 bean 顺序的设置。

@Configuration
@DependsOn({"initConfig", "aaa"})
public class Bb {    
...
}
复制代码

@DependsOn 可以指定多个 bean ，用 String[] 表示，有顺序。@DependsOn({"initConfig", "aaa"}) 表示在执行 Bb.java 之前，会首先执行 InitConfig.java，然后再执行 Aaa.java。bean 名称默认为 首字母小写的文件名。

四、小结

@Configuration、@Service、@Component 都会将修饰的类交给 spring 来管理，但就注解这个层面来说，貌似是没有加载顺序的。默认为 包名+文件名 来判断加载顺序。

如果需要指定加载顺序，可以使用 @DependsOn 注解。

文中还用到了 @PostConstruct 注解。它是 jdk 中的一个注解， 被 @PostConstruct 修饰的方法会在服务器加载 Servlet 的时候运行，并且只会被服务器调用一次。

好啦，以上基本就是对 Spring bean 加载顺序导致问题 bug 的思考，如果上述描述有欠缺或错误，欢迎指正，感谢。