Spring Boot实现在启动时执行一次的功能

àì夳堔傛蜴生んèń 2023-09-30 21:56 19阅读 0赞

#### Spring Boot实现在启动时执行一次的功能 ####

*  方法一：@PostConstruct
 *  方法二：使用Spring Boot提供的CommandLineRunner接口或ApplicationRunner接口
 *  方法三：使用Spring Boot提供的ApplicationListener接口

## 方法一：@PostConstruct ##

> 此方法可能是最常用的

可以使用Spring Boot的@PostConstruct注解来实现在启动时执行一次的功能。@PostConstruct注解标记的方法会在Bean初始化完成后自动调用，可以在该方法中执行只需要在启动时执行一次的操作。

如果想在生成对象时完成某些初始化操作，而偏偏这些初始化操作又依赖于依赖注入，那么就无法在构造函数中实现。为此，可以使用@PostConstruct注解一个方法来完成初始化，@PostConstruct注解的方法将会在依赖注入完成后被自动调用。

Constructor >> @Autowired >> @PostConstruct

例如，在一个Spring Boot应用程序的启动类中添加一个@PostConstruct注解标记的方法：

import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import javax.annotation.PostConstruct;
    
    @SpringBootApplication
    public class MyApplication {
        
    
        @PostConstruct
        public void init() {
        
            // 在这里执行仅需在启动时执行一次的操作
        }
    
        public static void main(String[] args) {
        
            SpringApplication.run(MyApplication.class, args);
        }
    }

在以上示例代码中，init()方法被标记为@PostConstruct注解，表示它会在MyApplication Bean初始化完成后自动调用。在init()方法中可以执行只需要在启动时执行一次的操作，例如初始化一些数据、建立数据库连接等。

## 方法二：使用Spring Boot提供的CommandLineRunner接口或ApplicationRunner接口 ##

> 此方法已经在项目中实践使用ok。

除了@PostConstruct注解，还可以使用Spring Boot提供的CommandLineRunner接口或ApplicationRunner接口来实现在启动时执行一次的功能。

这两个接口都有一个run()方法，在应用程序启动后会被自动调用。需要在该方法中实现需要在启动时执行的操作，例如初始化数据、开启定时任务等。

如果需要多个操作在启动时执行，可以定义多个实现了CommandLineRunner或ApplicationRunner接口的Bean，并通过@Order注解指定它们的执行顺序。

示例代码如下：

import org.springframework.boot.ApplicationArguments;
    import org.springframework.boot.ApplicationRunner;
    import org.springframework.core.annotation.Order;
    import org.springframework.stereotype.Component;
    
    @Component
    @Order(1) // 可以通过@Order注解指定执行顺序，数字越小越先执行
    public class MyCommandLineRunner implements CommandLineRunner {
        
    
        @Override
        public void run(String... args) throws Exception {
        
            // 在这里执行启动时需要执行的操作
        }
    }
    
    @Component
    @Order(2)
    public class MyApplicationRunner implements ApplicationRunner {
        
    
        @Override
        public void run(ApplicationArguments args) throws Exception {
        
            // 在这里执行启动时需要执行的操作
        }
    }

以上示例代码定义了两个Bean，分别是实现CommandLineRunner接口的MyCommandLineRunner和实现ApplicationRunner接口的MyApplicationRunner。它们的run()方法会在应用程序启动后自动调用，可以在这里实现需要在启动时执行的操作。其中，@Order注解用于指定它们的执行顺序，数字越小越先执行。

## 方法三：使用Spring Boot提供的ApplicationListener接口 ##

> 此方法暂未实践

还可以使用Spring Boot提供的ApplicationListener接口来实现在应用程序启动时执行一次的功能。这个接口定义了监听Spring Boot应用程序事件的方法，当应用程序触发相应的事件时，监听器会自动调用相应的方法进行处理。

具体实现步骤如下：

创建一个实现ApplicationListener接口的类，例如MyApplicationListener。

实现onApplicationEvent()方法，在该方法中编写需要在启动时执行的操作，例如初始化数据、建立数据库连接等。

通过@Component注解或@Bean注解将MyApplicationListener注册成Spring Bean。

示例代码如下：

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) {
        
            // 在这里执行启动时需要执行的操作
        }
    }

以上示例代码创建了一个名为MyApplicationListener的Bean，并实现了ApplicationListener接口，用于监听ApplicationReadyEvent事件。在onApplicationEvent()方法中编写需要在启动时执行的操作。最后通过@Component注解将MyApplicationListener注册成Spring Bean。

当应用程序启动完成后，MyApplicationListener会自动监听到ApplicationReadyEvent事件并执行其中的代码。可以在这里实现需要在启动时执行一次的操作，确保其只在应用程序启动时执行一次。