Spring Boot 启动预加载数据 CommandLineRunner

Posted 2023-05-03

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Boot 启动预加载数据 CommandLineRunner相关的知识，希望对你有一定的参考价值。

参考技术A 实际应用中，我们会有在项目、服务启动时就去加载一些数据或做一些事情这样的需求。

为了解决这样的问题， Spring Boot 为我们提供了一个方法，通过实现接口 CommandLineRunner 来实现。

很简单，只需要一个类就可以，无需其他配置。
创建实现接口 CommandLineRunner 的类

Spring Boot 应用程序在启动后，会遍历 CommandLineRunner 接口的实例并运行它们的 run 方法。也可以利用 @Order 注解（或者实现 Order 接口）来规定所有 CommandLineRunner 实例的运行顺序。

如下我们使用 @Order 注解来定义执行顺序。

启动程序后，控制台输出结果为：

根据控制台结果可判断， @Order 注解的执行优先级是按 value 值从小到大顺序。

Spring Boot 启动时自动执行代码的几种方式。。

来源：blog.csdn.net/u011291072/article/details/81813662

前言

目前开发的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

官方文档解释为：

Provides access to the arguments that were used to run a SpringApplication.

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

Order注解

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

代码测试

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

Spring Boot 基础就不介绍了，推荐下这个实战教程：https://github.com/javastacks/spring-boot-best-practice

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");

执行结果