Spring Boot应用启动时自动执行代码的五种方式(常见方法)
更新时间：2024年04月10日 12:05:21 作者：不掉头发的阿水
Spring Boot为开发者提供了多种方式在应用启动时执行自定义代码,这些方式包括注解、接口实现和事件监听器,本文我们将探讨一些常见的方法,以及如何利用它们在应用启动时执行初始化逻辑,感兴趣的朋友一起看看吧
Spring Boot为开发者提供了多种方式在应用启动时执行自定义代码，这些方式包括注解、接口实现和事件监听器。在本篇博客中，我们将探讨一些常见的方法，以及如何利用它们在应用启动时执行初始化逻辑。
1. @PostConstruct注解
`@PostConstruct`注解可以标注在方法上，该方法将在类被初始化后调用。在Spring Boot应用中，你可以使用这个注解来执行一些初始化的逻辑。
@PostConstruct
public void doSomething(){
// 在应用启动后执行的代码
System.out.println("do something");
}2. ApplicationListener接口
实现`ApplicationListener`接口并监听`ApplicationStartedEvent`事件，这样你的逻辑将在应用启动后被触发。
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.ApplicationListener;
public class MyApplicationListener implements ApplicationListener<ApplicationStartedEvent> {
@Override
public void onApplicationEvent(ApplicationStartedEvent event) {
// 在应用启动后执行的代码
System.out.println("ApplicationListener executed");
}
}3. @EventListener注解
使用`@EventListener`注解，可以将方法标记为事件监听器，并在特定事件发生时执行。
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.event.EventListener;
public class MyEventListener {
@EventListener(ApplicationStartedEvent.class)
public void onApplicationEvent() {
// 在应用启动后执行的代码
System.out.println("@EventListener executed");
}
}4. ApplicationRunner接口
实现`ApplicationRunner`接口，该接口的`run`方法会在Spring Boot应用启动后执行。
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
public class MyApplicationRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
// 在应用启动后执行的代码
System.out.println("ApplicationRunner executed");
}
}5. CommandLineRunner接口
与`ApplicationRunner`类似，`CommandLineRunner`接口的`run`方法也在应用启动后执行。
public class MyCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
// 在应用启动后执行的代码
System.out.println("CommandLineRunner executed");
}
}Demo代码
完整如下
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.event.ApplicationStartedEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.EventListener;
import javax.annotation.PostConstruct;
@SpringBootApplication
public class Application implements
ApplicationListener<ApplicationStartedEvent>,
CommandLineRunner,
ApplicationRunner
{
/**
* 本次执行先后顺序为（没有设置order）
* PostConstruct、ApplicationListener、@EventListener注解、ApplicationRunner、CommandLineRunner
* @param args
*/
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
@PostConstruct
public void doSomething(){
// 在应用启动后执行的代码
System.out.println("do something 11111111111");
System.out.println("PostConstruct注解启动");
System.out.println("===============");
}
@EventListener(ApplicationStartedEvent.class)
public void onApplicationEvent() {
// 在应用启动后执行的代码
System.out.println("do something 22222222222");
System.out.println("@EventListener 注解启动 executed");
System.out.println("===============");
}
@Override
public void onApplicationEvent(ApplicationStartedEvent event) {
// 在应用启动后执行的代码
System.out.println("do something 3333333333");
System.out.println("ApplicationListener executed");
System.out.println("===============");
}
@Override
public void run(String... args) throws Exception {
// 在应用启动后执行的代码
System.out.println("do something 44444444");
System.out.println("CommandLineRunner启动");
System.out.println("===============");
}
@Override
public void run(ApplicationArguments args) throws Exception {
// 在应用启动后执行的代码
System.out.println("do something 55555555");
System.out.println("ApplicationRunner启动");
System.out.println("===============");
}
}Demo分析
@PostConstruct注解方法 (doSomething方法) 在类初始化后被调用，因此会首先输出。
ApplicationListener接口方法 (onApplicationEvent方法) 在应用启动后执行，会输出其相关的信息。
@EventListener注解方法 (onApplicationEvent方法) 同样在应用启动后执行，会输出其相关的信息。
ApplicationRunner接口方法 (run方法) 在ApplicationListener之后执行，它用于在Spring Boot应用启动后执行一些额外的逻辑。
CommandLineRunner接口方法 (run方法) 也在ApplicationListener之后执行，用于在Spring Boot应用启动后执行一些额外的逻辑。
总结
通过以上几种方式，你可以根据项目的需求选择合适的初始化方法。无论是使用注解、接口实现，还是事件监听器，Spring Boot提供了灵活的机制来管理应用启动时的自定义逻辑，使得开发者能够更方便地控制应用的初始化过程。在实际项目中，通常根据具体场景选择其中一种或多种方式，以满足不同的需求。
到此这篇关于Spring Boot应用启动时自动执行代码的五种方式(常见方法)的文章就介绍到这了,更多相关Spring Boot启动时自动执行代码内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要为大家分享了Ubuntu 15下安装Eclipse经验，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2016-12-12
这篇文章主要介绍了链表的原理及java实现代码示例，涉及单向链表的基本介绍，单向链表的Java实现代码分享等相关内容，具有一定参考价值，需要的朋友可以参考下。2017-11-11
这篇文章主要介绍了java servlet手机app访问接口(二)，短信验证，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2016-12-12
通常来说，大家都是对Java中的Exception进行捕获和进行相应的处理，有些人说，error就无法捕获了。其实，error也是可以捕获的。Error和Exception都是Throwable的子类。既然可以catch Throwable，那么error也是可以catch的2014-01-01
这篇文章主要介绍了java通过控制鼠标实现屏幕广播的方法,针对前面一篇Java屏幕共享功能进行了改进,实现了鼠标控制功能,具有一定的实用价值,需要的朋友可以参考下2014-12-12
本文主要介绍Java 高并发NIO和AIO 的知识，这里整理了详细的资料，并详细介绍了 1. 什么是NIO 2. Buffer 3. Channel 4. 网络编程 5. AIO的知识，有需要的小伙伴可以参考下2016-09-09
在Spring框架中,循环依赖是指两个或多个Bean相互依赖,形成闭环,导致无法完成初始化,此问题仅存在于单例Bean中,而原型Bean会抛出异常,Spring通过三级缓存及提前暴露策略解决循环依赖：一级缓存存放完全初始化的Bean2024-11-11
FactoryBean BeanFactory方法使用示例详解讲解
这篇文章主要为大家介绍了FactoryBean BeanFactory方法使用示例详解讲解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-12-12
这篇文章主要介绍了Java中的DecimalFormat用法解析,DecimalFormat是Java中用于格式化数字的类,它提供了一种简单而灵活的方式来格式化数字,包括指定小数位数、千位分隔符、货币符号等,需要的朋友可以参考下2023-10-10
这篇文章主要介绍了深入浅出讲解Java集合之Collection接口，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-09-09
最新评论