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执行初始化操作内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

解决SpringBoot中使用@Async注解失效的问题
这篇文章主要介绍了解决SpringBoot中使用@Async注解失效的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-09-09
Java实现文件上传保存
这篇文章主要为大家详细介绍了Java实现文件上传保存，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
java实现ATM取款项目
这篇文章主要为大家详细介绍了java实现ATM取款项目的实现代码，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-06-06
SpringBoot 使用jwt进行身份验证的方法示例
这篇文章主要介绍了SpringBoot 使用jwt进行身份验证的方法示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-12-12
Java中的HashMap源码详解
这篇文章主要介绍了Java中的HashMap源码详解,当我们确切知道HashMap将要处理的数据量为n时,推荐调用构造函数public HashMap(int initialCapacity)来创建 HashMap,这样就不会发生扩容,需要的朋友可以参考下
2023-09-09
MyBatis-Plus 与Druid 数据源操作
SpringBoot框架集成MyBatis-Plus和Druid数据源,简化了数据操作与监控,MyBatis-Plus作为MyBatis的增强工具,自动实现CRUD操作,减少手写SQL,提供分页、逻辑删除等功能,本文介绍MyBatis-Plus & Druid 数据源总结,感兴趣的朋友一起看看吧
2024-09-09
使用springboot每日推送早安问候语到用户微信的全过程
近期网上又出现一股给女朋友做微信公众号推送的潮流,所以这篇文章主要给大家介绍了关于如何使用springboot每日推送早安问候语到用户微信的相关资料,文中通过图文以及实例代码介绍的非常详细,需要的朋友可以参考下
2022-11-11
logstash将mysql数据同步到elasticsearch方法详解
这篇文章主要为大家介绍了logstash将mysql数据同步到elasticsearch方法详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-12-12
idea类名显示多行的设置方式
在IntelliJ IDEA中,类名的显示方式可以通过设置来调整,若想设置为单行显示,需在设置中找到相关选项并勾选“√”,若需多行显示,则取消勾选即可,此操作有助于优化代码视图,提升开发效率
2024-09-09
Java中的OkHttp使用教程
OkHttp是目前非常火的网络库，OKHttp与HttpClient类似，也是一个Http客户端，提供了对 HTTP/2 和 SPDY 的支持，并提供了连接池，GZIP 压缩和 HTTP 响应缓存功能，本文重点给大家介绍Java OkHttp使用，感兴趣的朋友一起看看吧
2022-04-04