SpringBoot启动时执行自定义内容的五种方法

 更新时间:2025年10月30日 09:26:27   作者:Felix...  
在Spring Boot应用开发中,我们经常需要在应用启动时执行一些初始化逻辑,比如加载配置、初始化数据、启动后台任务等,Spring Boot提供了多种方式来实现这一需求,本文将详细介绍5种常用的方法,需要的朋友可以参考下

引言

在Spring Boot应用开发中,我们经常需要在应用启动时执行一些初始化逻辑,比如加载配置、初始化数据、启动后台任务等。Spring Boot提供了多种方式来实现这一需求,本文将详细介绍5种常用的方法,并分析它们的适用场景和优缺点。

1. 使用CommandLineRunner或ApplicationRunner接口(推荐)

Spring Boot专门提供了CommandLineRunner和ApplicationRunner接口,用于在应用启动后执行自定义逻辑。它们的区别在于参数传递方式不同:

1.1 CommandLineRunner

CommandLineRunner接收一个字符串数组(String... args),适合处理简单的命令行参数。

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

@Component
public class MyCommandLineRunner implements CommandLineRunner {
    
    @Override
    public void run(String... args) throws Exception {
        System.out.println("应用启动后执行 - CommandLineRunner");
        // 可以在这里访问Spring容器中的Bean
    }
}

1.2 ApplicationRunner

ApplicationRunner接收ApplicationArguments对象,提供了更结构化的参数访问方式(如getOptionNames()getNonOptionArgs()等)。

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

@Component
public class MyApplicationRunner implements ApplicationRunner {
    
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("应用启动后执行 - ApplicationRunner");
        // 可以访问命令行参数
        if (args.containsOption("debug")) {
            System.out.println("Debug模式已启用");
        }
    }
}

1.3 控制执行顺序

如果有多个Runner,可以使用@Order注解或实现Ordered接口来控制执行顺序:

@Component
@Order(1)  // 数字越小,优先级越高
public class FirstRunner implements CommandLineRunner {
    @Override
    public void run(String... args) {
        System.out.println("第一个Runner执行");
    }
}

@Component
@Order(2)
public class SecondRunner implements CommandLineRunner {
    @Override
    public void run(String... args) {
        System.out.println("第二个Runner执行");
    }
}

适用场景

  • 需要在应用完全启动后执行初始化逻辑(如加载数据、启动后台任务)。
  • 需要访问Spring容器中的Bean。

优点

  • 官方推荐,专为启动后执行设计。
  • 支持执行顺序控制。

缺点

  • 无法在Bean初始化阶段执行。

2. 使用@PostConstruct注解

@PostConstruct是JSR-250标准注解,用于标记在Bean初始化完成后执行的方法。

import javax.annotation.PostConstruct;
import org.springframework.stereotype.Component;

@Component
public class MyPostConstructBean {
    
    @PostConstruct
    public void init() {
        System.out.println("Bean初始化后执行 - @PostConstruct");
        // 可以在这里执行初始化逻辑
    }
}

适用场景

  • 需要在单个Bean初始化完成后执行逻辑(如数据库连接测试、缓存预热)。

优点

  • 简单易用,适用于单个Bean的初始化。

缺点

  • 无法控制多个Bean的执行顺序。
  • 执行时机较早(在Bean初始化后,但应用可能还未完全启动)。

3. 实现ApplicationListener监听启动事件

Spring Boot提供了多种事件,如ApplicationReadyEvent(应用完全启动后触发)、ApplicationStartedEvent(应用启动后但未处理请求时触发)等。

3.1 监听ApplicationReadyEvent

import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class MyApplicationListener implements ApplicationListener<ApplicationReadyEvent> {
    
    @Override
    public void onApplicationEvent(ApplicationReadyEvent event) {
        System.out.println("应用完全启动后执行 - ApplicationReadyEvent");
        // 可以在这里执行应用启动后的逻辑
    }
}

适用场景

  • 需要在应用完全启动后执行逻辑(如发送启动完成通知)。

优点

  • 精确控制执行时机(应用完全启动后)。

缺点

  • 代码稍显冗长,不如CommandLineRunner简洁。

4. 使用InitializingBean接口

InitializingBean是Spring提供的接口,其afterPropertiesSet()方法会在Bean属性设置完成后执行。

import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;

@Component
public class MyInitializingBean implements InitializingBean {
    
    @Override
    public void afterPropertiesSet() throws Exception {
        System.out.println("Bean属性设置后执行 - InitializingBean");
        // 可以在这里执行初始化逻辑
    }
}

适用场景

  • 需要在Bean属性设置完成后执行逻辑(如校验配置)。

优点

  • 适用于单个Bean的初始化。

缺点

  • 执行时机较早(在Bean初始化阶段)。
  • 不如@PostConstruct简洁。

5. 在main方法中直接执行

如果逻辑非常简单,可以直接在main方法中执行:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApplication {
    public static void main(String[] args) {
        System.out.println("Spring Boot启动前执行");
        
        SpringApplication.run(MyApplication.class, args);
        
        System.out.println("Spring Boot启动过程完成后执行");
        // 注意:这里的代码会在Spring Boot启动后立即执行,但不一定是所有Bean都初始化完成
    }
}

适用场景

  • 极简单的初始化逻辑(如打印日志)。

优点

  • 无需额外代码。

缺点

  • 无法保证所有Bean都已初始化。
  • 不推荐用于复杂逻辑。

总结

方法适用场景执行时机优点缺点
CommandLineRunner/ApplicationRunner应用启动后执行初始化逻辑应用完全启动后官方推荐,支持顺序控制无法在Bean初始化阶段执行
@PostConstruct单个Bean初始化后执行逻辑Bean初始化后简单易用无法控制多个Bean的执行顺序
ApplicationListener应用完全启动后执行逻辑应用完全启动后精确控制执行时机代码稍显冗长
InitializingBean单个Bean属性设置后执行逻辑Bean属性设置后适用于单个Bean执行时机较早
main方法直接执行极简单的初始化逻辑Spring Boot启动后无需额外代码无法保证所有Bean初始化

推荐选择

  • 需要应用完全启动后执行逻辑 → 使用CommandLineRunner或ApplicationRunner(推荐)。
  • 需要在单个Bean初始化后执行逻辑 → 使用@PostConstruct。
  • 需要精确控制执行时机 → 使用ApplicationListener监听ApplicationReadyEvent。

希望本文能帮助你选择最适合的方式,在Spring Boot启动时执行自定义逻辑!

以上就是SpringBoot启动时执行自定义内容的五种方法的详细内容,更多关于SpringBoot执行自定义内容的资料请关注脚本之家其它相关文章!

相关文章

  • SpringData关键字查询实现方法详解

    SpringData关键字查询实现方法详解

    这篇文章主要介绍了SpringData关键字查询实现方法详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-08-08
  • 运行Jar包出现提示xxx中没有主清单属性报错问题解决方法

    运行Jar包出现提示xxx中没有主清单属性报错问题解决方法

    这篇文章主要介绍了运行Jar包出现:xxx中没有主清单属性报错,当出现报错:xxx中没有主清单属性,解决方法也很简单,在pom.xml配置中,加上相应配置即可,需要的朋友可以参考下
    2023-08-08
  • Java 通过JDBC连接Mysql数据库

    Java 通过JDBC连接Mysql数据库

    本文给大家详细介绍了java如何使用JDBC连接Mysql的方法以及驱动包的安装,最后给大家附上了java通过JDBC连接其他各种数据库的方法,有需要的小伙伴可以参考下。
    2015-11-11
  • Eclipse转Itellij IDEA导入Git/svn本地项目的详细步骤

    Eclipse转Itellij IDEA导入Git/svn本地项目的详细步骤

    这篇文章主要介绍了Eclipse转Itellij IDEA导入Git/svn本地项目,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-10-10
  • SpringBoot处理跨域请求的四种方法

    SpringBoot处理跨域请求的四种方法

    在现代Web应用中,由于安全性和隐私的考虑,浏览器限制了从一个域向另一个域发起的跨域HTTP请求,解决这个问题的一种常见方式是实现跨域资源共享(CORS),SpringBoot提供了多种方式来处理跨域请求,本文将介绍其中的几种方法,感兴趣的朋友可以参考下
    2023-12-12
  • druid执行SQL出现错误但不影响返回结果的问题及解决

    druid执行SQL出现错误但不影响返回结果的问题及解决

    这篇文章主要介绍了druid执行SQL出现错误但不影响返回结果的问题及解决方案,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • 深入学习Spring Cloud-Ribbon

    深入学习Spring Cloud-Ribbon

    这篇文章主要介绍了Spring Cloud-Ribbon的相关知识,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友一起看看吧
    2021-03-03
  • Quarkus中RESTEasy Reactive集成合并master分支

    Quarkus中RESTEasy Reactive集成合并master分支

    这篇文章主要为大家介绍了Quarkus中RESTEasy Reactive集成合并master分支的详细作用分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步
    2022-02-02
  • Spring Cloud负载均衡组件Ribbon原理解析

    Spring Cloud负载均衡组件Ribbon原理解析

    本文主要讲述了微服务体系下的 Spring Cloud Netflix 套件中 Ribbon 的使用,并结合部分源码讲述了 Ribbon 的底层原理,重点讲述了 Ribbon 中是如何获取服务以及如何判定一个服务是否可用,最后也介绍了 Ribbon 中默认提供的 7 种负载均衡策略,感兴趣的朋友一起看看吧
    2022-04-04
  • Java 日期时间工具包–java.time的使用

    Java 日期时间工具包–java.time的使用

    这篇文章主要介绍了Java 日期时间工具包–java.time的使用,帮助大家更好的理解和学习使用Java,感兴趣的朋友可以了解下
    2021-04-04

最新评论