SpringBoot - @PostConstruct、InitializingBean、 ApplicationRunner 和 CommandLineRunner的执行顺序

布满荆棘的人生 2023-10-08 16:28 10阅读 0赞

#### 写在前面 ####

在实际开发场景中，经常会遇到数据初始化的业务场景，那么如何在Spring容器启动时执行相关操作呢？比如：读取配置文件，数据库连接，数据缓存，数据预计算…  
可以使用：@PostConstruct、InitializingBean、 ApplicationRunner 和 CommandLineRunner来完成。

[SpringBoot - @PostConstruct 注解详解][SpringBoot - _PostConstruct]  
[SpringBoot - ApplicationRunner的作用是什么？][SpringBoot - ApplicationRunner]  
[SpringBoot - InitializingBean的作用是什么？][SpringBoot - InitializingBean]

#### 测试示例 ####

@Component
    public class MyInitializingBean implements InitializingBean, CommandLineRunner, ApplicationRunner {
        
        @PostConstruct
        public void init() {
        
            System.out.println("1. 执行@PostConstruct注解的方法 - init()...");
        }
    
    
        @Override
        public void afterPropertiesSet() throws Exception {
        
            System.out.println("2. 执行实现InitializingBean接口的方法 - afterPropertiesSet()...");
        }
    
        @Override
        public void run(ApplicationArguments args) throws Exception {
        
            System.out.println("3. 执行实现ApplicationRunner接口的方法 - run(ApplicationArguments args)...");
    
        }
    
        @Override
        public void run(String... args) throws Exception {
        
            System.out.println("4. 执行实现CommandLineRunner接口的方法 - run(String... args)...");
        }
    }
    
    // 输出结果如下:
    
    1. 执行@PostConstruct注解的方法 - init()...
    2. 执行实现InitializingBean接口的方法 - afterPropertiesSet()...
    3. 执行实现ApplicationRunner接口的方法 - run(ApplicationArguments args)...
    4. 执行实现CommandLineRunner接口的方法 - run(String... args)...

#### 区别描述 ####

A. 如果需要在容器启动后进行一些初始化操作，可以使用由SpringBoot提供的ApplicationRunner/CommandLineRunner；  
B. 如果需要在一个类加载的时候进行一个初始化的操作，可以选择由JDK提供的@PostConstruct注解进行一个初始化的操作。另：@PostConstruct可以在容器没有完全启动的情况下能够进行初始化操作，而ApplicationRunner/CommandLineRunner的初始化一定是在容器完全启动之后执行的。@PostConstruct这个注解是针对BEAN的初始化完成之后再做一些事情，比如注册一些监听器、配置文件的初始化等等;  
C. 由Spring提供的InitializingBean用法与@PostConstruct基本一致，但是相应的BEAN需要实现afterPropertiesSet()方法;

#### 定义来源 ####

<table> 
 <thead> 
  <tr> 
   <th align="left">名称</th> 
   <th align="left">来源</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">ApplicationRunner</td> 
   <td align="left">Spring Boot</td> 
  </tr> 
  <tr> 
   <td align="left">CommandLineRunner</td> 
   <td align="left">Spring Boot</td> 
  </tr> 
  <tr> 
   <td align="left">InitializingBean</td> 
   <td align="left">Spring</td> 
  </tr> 
  <tr> 
   <td align="left">@PostConstruct</td> 
   <td align="left">JDK</td> 
  </tr> 
 </tbody> 
</table>

#### 执行顺序 ####

@PostConstruct > InitializingBean > ApplicationRunner > CommandLineRunner

#### 源码、示例及DEMO ####

[源码、示例及DEMO][DEMO]

[SpringBoot - _PostConstruct]: https://blog.csdn.net/goodjava2007/article/details/126356981?spm=1001.2014.3001.5501
[SpringBoot - ApplicationRunner]: https://blog.csdn.net/goodjava2007/article/details/126356485?spm=1001.2014.3001.5502
[SpringBoot - InitializingBean]: https://blog.csdn.net/goodjava2007/article/details/122245457?spm=1001.2014.3001.5502
[DEMO]: https://gitee.com/cloneme01/preflight