跳至主要內容

45. 如何在 SpringBoot 启动时执行特定代码？有哪些方式？

PangHu大约 3 分钟

在 Spring Boot 中，有多种方式可以在应用启动时执行特定代码。这对于执行初始化任务、加载资源、检查环境配置等操作非常有用。以下是几种常见的方法来实现这一需求：

1. 使用 CommandLineRunner 接口

CommandLineRunner 是 Spring Boot 提供的一个非常简单的接口，用于在应用启动完成后执行一段代码。你只需要实现这个接口，并在其 run 方法中编写需要执行的逻辑。

示例：

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

@Component
public class MyStartupRunner implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println("Application started with CommandLineRunner");
        // 执行启动时需要的逻辑
    }
}
  • run(String... args)：该方法在 Spring Boot 应用启动完成后立即执行，参数 args 是命令行传递的参数。

2. 使用 ApplicationRunner 接口

ApplicationRunner 与 CommandLineRunner 类似，只不过它接收的参数类型不同。ApplicationRunner 的 run 方法接收的是一个 ApplicationArguments 对象，可以更方便地处理应用的启动参数。

示例：

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

@Component
public class MyStartupApplicationRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("Application started with ApplicationRunner");
        // 执行启动时需要的逻辑
    }
}
  • run(ApplicationArguments args)：该方法在 Spring Boot 应用启动完成后立即执行，ApplicationArguments 提供了对命令行参数的更高级的访问方式。

3. 使用 @PostConstruct 注解

你还可以使用 @PostConstruct 注解在 Spring 容器初始化 bean 时执行方法。这是 JSR-250 提供的一个标准注解，它在依赖注入完成后自动调用。

示例：

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

@Component
public class MyBean {

    @PostConstruct
    public void init() {
        System.out.println("Application started with @PostConstruct");
        // 执行启动时需要的逻辑
    }
}
  • @PostConstruct：方法将在类的依赖注入完成后立即执行，通常用于类的初始化。

4. 使用 ApplicationListener 监听 ApplicationReadyEvent

你可以通过实现 ApplicationListener 接口来监听特定的事件，并在事件触发时执行代码。ApplicationReadyEvent 是 Spring Boot 应用完全启动并准备好接收请求时触发的事件。

示例：

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

@Component
public class MyApplicationReadyListener implements ApplicationListener<ApplicationReadyEvent> {

    @Override
    public void onApplicationEvent(ApplicationReadyEvent event) {
        System.out.println("Application started with ApplicationReadyEvent");
        // 执行启动时需要的逻辑
    }
}
  • onApplicationEvent(ApplicationReadyEvent event)：该方法在 Spring Boot 应用完全启动并准备好接收请求时执行。

5. 使用 @EventListener 注解

@EventListener 是 Spring 提供的注解，可以简化事件监听的代码。你可以使用 @EventListener 注解来监听 ApplicationReadyEvent 或其他事件。

示例：

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

@Component
public class MyEventListener {

    @EventListener
    public void handleApplicationReadyEvent(ApplicationReadyEvent event) {
        System.out.println("Application started with @EventListener");
        // 执行启动时需要的逻辑
    }
}
  • @EventListener：方法将在监听到指定事件时执行。与 ApplicationListener 类似，但实现更简单。

6. 使用 InitializingBean 接口

InitializingBean 是 Spring 提供的一个接口，可以用于在 bean 的属性设置完成后执行初始化代码。你可以通过实现 afterPropertiesSet 方法来执行初始化逻辑。

示例：

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("Application started with InitializingBean");
        // 执行启动时需要的逻辑
    }
}
  • afterPropertiesSet()：在 bean 的所有属性设置完成后立即执行。

7. 总结

在 Spring Boot 中，有多种方式可以在应用启动时执行特定的代码。每种方式都有其适用的场景：

  • CommandLineRunner 和 ApplicationRunner：适合在应用启动后立即执行任务，特别是需要处理命令行参数时。
  • @PostConstruct：适合在 bean 初始化时执行一些依赖注入后的逻辑。
  • ApplicationListener 和 @EventListener：适合监听应用启动的特定阶段，并在特定事件发生时执行任务。
  • InitializingBean：适合在所有依赖注入完成后执行初始化逻辑。

根据具体的需求和代码组织方式，你可以选择最适合的方法来在 Spring Boot 应用启动时执行特定的代码。