SpringBoot 启动时自动执行代码的几种方式

太过爱你忘了你带给我的痛 2023-09-28 08:17 36阅读 0赞

> ### 前言 ###

目前开发的`SpringBoot`项目在启动的时候需要预加载一些资源。如何实现启动过程中执行代码，或启动成功后执行，是有很多种方式可以选择，可以在static代码块中实现，也可以在构造方法里实现，也可以使用`@PostConstruct`注解实现。

当然也可以去实现`Spring`的`ApplicationRunner`与`CommandLineRunner`接口去实现启动后运行的功能。在这里整理一下，在这些位置执行的区别以及加载顺序。

### java自身的启动时加载方式 ###

> **static代码块**

static静态代码块，在类加载的时候即自动执行。

> **构造方法**

在对象初始化时执行。执行顺序在static静态代码块之后。

### Spring启动时加载方式 ###

> `@PostConstruct`注解

PostConstruct注解使用在方法上，这个方法在对象依赖注入初始化之后执行。

> `ApplicationRunner`和`CommandLineRunner`

`SpringBoot`提供了两个接口来实现`Spring`容器启动完成后执行的功能，两个接口分别为`CommandLineRunner`和`ApplicationRunner`。

这两个接口需要实现一个`run`方法，将代码在`run`中实现即可。这两个接口功能基本一致，其区别在于`run`方法的入参。`ApplicationRunner`的`run`方法入参为`ApplicationArguments`，为`CommandLineRunner`的`run`方法入参为`String`数组。

> 什么是`ApplicationArguments`

在`Spring`应用运行时使用的访问应用参数。即我们可以获取到`SpringApplication.run(…)`的应用参数。

> Order注解

当有多个类实现了`CommandLineRunner`和`ApplicationRunner`接口时，可以通过在类上添加`@Order`注解来设定运行顺序。

### 代码测试 ###

为了测试启动时运行的效果和顺序，编写几个测试代码来运行

TestPostConstruct

@Component
    public class TestPostConstruct {
        
    
        static {
        
            System.out.println("static");
        }
        public TestPostConstruct() {
        
            System.out.println("constructer");
        }
    
        @PostConstruct
        public void init() {
        
            System.out.println("PostConstruct");
        }
    }

TestApplicationRunner

@Component
    @Order(1)
    public class TestApplicationRunner implements ApplicationRunner{
        
        @Override
        public void run(ApplicationArguments applicationArguments) throws Exception {
        
            System.out.println("order1:TestApplicationRunner");
        }
    }

TestCommandLineRunner

@Component
    @Order(2)
    public class TestCommandLineRunner implements CommandLineRunner {
        
        @Override
        public void run(String... strings) throws Exception {
        
            System.out.println("order2:TestCommandLineRunner");
        }
    }

执行结果

![在这里插入图片描述][bc5b90254a5d40b8a3f40cf504983e40.jpeg]

> ### 总结 ###

`Spring`应用启动过程中，肯定是要自动扫描有`@Component`注解的类，加载类并初始化对象进行自动注入。加载类时首先要执行`static`静态代码块中的代码，之后再初始化对象时会执行构造方法。

在对象注入完成后，调用带有`@PostConstruct`注解的方法。当容器启动成功后，再根据`@Order`注解的顺序调用`CommandLineRunner`和`ApplicationRunner`接口类中的`run`方法。

因此，加载顺序为`static`>`constructer`>`@PostConstruct`>`CommandLineRunner`和`ApplicationRunner`.

[bc5b90254a5d40b8a3f40cf504983e40.jpeg]: https://img-blog.csdnimg.cn/bc5b90254a5d40b8a3f40cf504983e40.jpeg