一张图帮你记忆，Spring Boot应用在启动阶段执行代码的几种方式("Spring Boot启动阶段执行代码的几种方式：一图速记攻略")

原创

ithorizon 6个月前 (10-21) 阅读数 26 #后端开发

Spring Boot启动阶段执行代码的几种对策：一图速记攻略

一、引言

Spring Boot 是一个开源的、基于 Spring 框架的轻量级应用开发框架，它简化了基于 Spring 的应用开发过程。在 Spring Boot 应用启动阶段，我们大概会需要执行一些特定的代码，以便于初始化数据、设置环境参数等。本文将介绍几种在 Spring Boot 启动阶段执行代码的对策，并通过一张图帮助大家飞速记忆。

二、Spring Boot 启动阶段执行代码的几种对策

以下是 Spring Boot 应用在启动阶段执行代码的几种对策：

1. 使用 @PostConstruct 注解

@PostConstruct 注解用于修饰一个非静态的 void() 方法，该方法会在 Spring 容器创建完 bean 之后调用。这种对策适用于执行一些明了的初始化操作。


public class MyService {
    @PostConstruct
    public void init() {
        // 初始化代码
    }
}

2. 实现 CommandLineRunner 接口

CommandLineRunner 接口包含一个 run 方法，该方法会在 Spring Boot 应用启动完成后调用。这种对策适用于需要在应用启动后立即执行的代码。


@Component
public class MyCommandLineRunner implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        // 执行代码
    }
}

3. 使用 ApplicationRunner 接口

ApplicationRunner 接口与 CommandLineRunner 接口类似，都包含一个 run 方法。不同之处在于，ApplicationRunner 的 run 方法可以接收一个 ApplicationArguments 对象，用于获取应用启动时传递的参数。


@Component
public class MyApplicationRunner implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 执行代码
    }
}

4. 使用 @EventListener 注解监听 ApplicationEvent

Spring Boot 赞成通过 @EventListener 注解监听 ApplicationEvent 事件。在应用启动阶段，我们可以监听 ApplicationStartingEvent、ApplicationEnvironmentPreparedEvent、ApplicationPreparedEvent 等事件，以执行相应的代码。


@Component
public class MyEventListener {
    @EventListener
    public void handleApplicationStartingEvent(ApplicationStartingEvent event) {
        // 执行代码
    }
    @EventListener
    public void handleApplicationEnvironmentPreparedEvent(ApplicationEnvironmentPreparedEvent event) {
        // 执行代码
    }
    @EventListener
    public void handleApplicationPreparedEvent(ApplicationPreparedEvent event) {
        // 执行代码
    }
}

5. 使用 Spring Factories

Spring Boot 赞成通过 Spring Factories 机制来注册一些初始化操作。在 Spring Boot 应用的 resources/META-INF/spring.factories 文件中，我们可以添加以下配置：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\

com.example.MyAutoConfiguration

然后，在 MyAutoConfiguration 类中，我们可以定义一些初始化操作：


@Configuration
public class MyAutoConfiguration {
    @Bean
    public InitializingBean myInitializingBean() {
        return new MyInitializingBean();
    }
}
public class MyInitializingBean implements InitializingBean {
    @Override
    public void afterPropertiesSet() throws Exception {
        // 执行代码
    }
}

三、总结与一图速记攻略

本文介绍了 Spring Boot 启动阶段执行代码的几种对策，包括使用 @PostConstruct 注解、实现 CommandLineRunner 接口、使用 ApplicationRunner 接口、使用 @EventListener 注解监听 ApplicationEvent 事件以及使用 Spring Factories 机制。下面是一张图，帮助大家飞速记忆这些方法：

Spring Boot 启动阶段执行代码的几种对策