SpringBoot启动时执行初始化操作的几种方式

更新时间：2024年05月01日 08:41:30 作者：strggle_bin

项目中,经常需要在启动过程中初始化一些数据,如从数据库读取一些配置初始化,或从数据库读取一些热点数据到redis进行初始化缓存,本文给大家介绍了SpringBoot启动时执行初始化操作的几种方式的相关资料,需要的朋友可以参考下

场景

项目中，经常需要在启动过程中初始化一些数据，如从数据库读取一些配置初始化，或从数据库读取一些热点数据到redis进行初始化缓存。

方式一:实现CommandLineRunner 接口重写run方法逻辑

CommandLineRunner是Spring提供的接口，定义了一个run()方法，用于执行初始化操作。

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class InitConfigCommand implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println("CommandLineRunner:"+"{}"+"接口实现方式重写");
    }
}

CommandLineRunner的执行时机为Spring beans初始化之后，因此CommandLineRunner的执行一定是晚于@PostConstruct的。

若有多组初始化操作，则每一组操作都要定义一个CommandLineRunner派生类并实现run()方法。这些操作的执行顺序使用@Order(n)来设置，n为int型数据。

@Component
@Order(99)
public class CommandLineRunnerA implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("初始化：CommandLineRunnerA");
    }
}

@Component
@Order(1)
public class CommandLineRunnerB implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("初始化：CommandLineRunnerB");
    }
}

如上，会先执行CommandLineRunnerB的run()，再执行CommandLineRunnerA的run()。

@Order(n)中的n较小的会先执行，较大的后执行。n只要是int值即可，无需顺序递增。

方式二:实现ApplicationRunner接口重写run方法逻辑

ApplicationRunner接口与CommandLineRunner接口类似，都需要实现run()方法。二者的区别在于run()方法的参数不同：

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class InitConfig implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("项目启动初始化");
    }
}

ApplicationRunner接口的run()参数为ApplicationArguments对象，因此可以获取更多项目相关的内容。

ApplicationRunner接口与CommandLineRunner接口的调用时机也是相同的，都是Spring beans初始化之后。因此ApplicationRunner接口也使用@Order(n)来设置执行顺序。

方式三:使用@PostConstruct注解的方式

对于注入到Spring容器中的类，在其成员函数前添加@PostConstruct注解，则在执行Spring beans初始化时，就会执行该函数。

但由于该函数执行时，其他Spring beans可能并未初始化完成，因此在该函数中执行的初始化操作应当不依赖于其他Spring beans。

@Component
public class Construct {
    @PostConstruct
    public void doConstruct() throws Exception {
        System.out.println("初始化：PostConstruct");
    }
}

初始化顺序

@PostConstruct 注解方法
CommandLineRunner接口实现
ApplicationRunner接口实现

扩展

@PostConstruct注解使用在方法上，它可以被用来标注一个非静态的 void 方法，这个方法会在该类被 Spring 容器初始化后立即执行。因为它的执行时机是在依赖注入之后，对象构造完成之后，也就是说是在@Autowired注入之后执行。所以这里可以进行一些初始化操作，如某些需要在对象创建后才能进行的数据初始化操作。

需要注意以下几点：

@PostConstruct 只能用在方法上面，而不能用在属性或构造函数上。
一个类中可以有多个使用 @PostConstruct 注解的方法，但执行顺序并不是固定的。
@PostConstruct 注解的方法在本类中必须是无参数的，如果有参数，那么这个方法不会被执行。
@PostConstruct 注解的方法在实现上可以使用任意修饰符。

假设我们有一个需要初始化数据的类：

public class InitService {
 
    private List<String> data;
 
    public InitService() {
        this.data = Arrays.asList("A", "B", "C");
    }
 
    @PostConstruct
    public void init() {
        data.add("D");
    }
 
    public List<String> getData() {
        return this.data;
    }
}

当我们实例化 InitService 时，构造函数会为 data 属性赋初值，而 @PostConstruct 注解的 init 方法会在 Spring 容器实例化完 InitService 后被执行，将 “D” 添加到 data 列表中。所以当我们调用 getData() 方法时，返回的列表应该是 [A, B, C, D]。

接下来看看 @Autowired 和@PostConstruct 的具体执行顺序

@Service
public class TestA {
    static {
        System.out.println("staticA");
    }
    @Autowired
    private TestB testB;
 
    public TestA() {
        System.out.println("这是TestA 的构造方法");
    }
 
    @PostConstruct
    private void init() {
        System.out.println("这是TestA的 init 方法");
        testB.test();
    }
}

@Service
public class TestB {
    static {
        System.out.println("staticB");
    }
    @PostConstruct
    private void init() {
        System.out.println("这是TestB的init 方法");
    }
 
    public TestB() {
        System.out.println("这是TestB的构造方法");
    }
 
    void test() {
        System.out.println("这是TestB的test方法");
    }
}

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

服务启动后，输出结果如下：

staticA
这是TestA 的构造方法
staticB
这是TestB的构造方法
这是TestB的init 方法
这是TestA的 init 方法
这是TestB的test方法

结论为：等@Autowired注入后，在执行@PostConstruct注解的方法。

方式四:静态代码块

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

使用的static静态代码块，实现原理为@Component + static代码块, spring boot项目在启动过程中，会扫描@Component 并初始化相应的类，类的初始化过程会运行静态代码块。

@Component
public class WordInitConfig {
    static {
        WordSegmenter.segWithStopWords("初始化分词");
    }
}

所以得到结论

static>constructer>@Autowired>@PostConstruct>ApplicationRunner>CommandLineRunner

到此这篇关于SpringBoot启动时执行初始化操作的几种方式的文章就介绍到这了,更多相关SpringBoot执行初始化操作内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

避免sql注入_动力节点Java学院整理
这篇文章主要介绍了避免sql注入，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-08-08
详解java枚举用法及实例
这篇文章主要介绍了Java枚举详解及使用实例,本文直接给出实例代码,需要的朋友可以参考下
2017-04-04
Mybatis批量新增的三种实现方式
文章讲述了在Java中进行批量操作的最佳实践,包括使用MyBatis的ExecutorType.BATCH模式,作者建议根据实际需求选择是否进行批量操作,因为批量操作并不总是能提升性能,且有副作用,如无法获取自增ID等
2024-12-12
入门JDK集合之HashMap解析
HashMap---基于哈希表的 Map 接口的实现。此实现提供所有可选的映射操作，并允许使用 null 值和 null 键。(除了非同步和允许使用 null 之外，HashMap 类与 Hashtable 大致相同
2021-06-06
完美解决docx4j变量替换的问题
这篇文章主要介绍了完美解决docx4j变量替换的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-07-07
Spring中的事件监听器使用学习记录
Spring框架中的事件监听机制是一种设计模式,它允许你定义和触发事件,同时允许其他组件监听这些事件并在事件发生时作出响应,这篇文章主要介绍了Spring中的事件监听器使用学习,需要的朋友可以参考下
2024-07-07
解决程序启动报错org.springframework.context.ApplicationContextExcept
文章描述了一个Spring Boot项目在不同环境下启动时出现差异的问题,通过分析报错信息,发现是由于导入`spring-boot-starter-tomcat`依赖时定义的scope导致的配置问题,调整依赖导入配置后,解决了启动错误
2024-11-11
IDEA 中 maven 的 Lifecycle 和Plugins&n
IDEA 主界面右侧 Maven 标签栏有同样的命令，比如 install，既在 Plugins 中存在，也在 Lifecycle中存在，到底选哪个？二者又有什么区别呢?下面小编给大家介绍下IDEA 中 maven 的 Lifecycle 和Plugins 的区别，感兴趣的朋友一起看看吧
2023-03-03
SpringBoot如何使用ApplicationContext获取bean对象
这篇文章主要介绍了SpringBoot 如何使用ApplicationContext获取bean对象，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-11-11
Spring Boot教程之利用ActiveMQ实现延迟消息
这篇文章主要给大家介绍了关于Spring Boot教程之利用ActiveMQ实现延迟消息的相关资料，文中通过示例代码介绍的非常详细，对大家学习或者使用Spring Boot具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-11-11