如何在Spring Boot中使用ApplicationRunner和CommandLineRunner

小蓝 • 2024-12-16 14:55 • 编程

一、ApplicationRunner是什么

在Spring Boot中，如果你需要在启动应用程序时执行一些特定的代码逻辑，可以使用Spring Boot提供的ApplicationRunner接口。实现该接口让你的代码在Spring Boot应用启动后自动执行，因此可以用于执行一些初始化操作等。

二、CommandLineRunner是什么

CommandLineRunner是另一个与ApplicationRunner类似的接口，同样用于在Spring Boot应用启动后执行一些特定的代码逻辑。不同于ApplicationRunner，CommandLineRunner接口的run()方法接收一个字符串数组作为参数，该数组包含了启动应用程序时传递给程序的所有命令行参数。

三、使用ApplicationRunner和CommandLineRunner

1. ApplicationRunner 示例代码

@Component
public class MyApplicationRunner implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("MyApplicationRunner is running...");
    }
}

我们创建了一个名为MyApplicationRunner的类，实现了ApplicationRunner接口，将我们希望执行的逻辑放在了run()方法中。在上面的示例中，我们只是简单地输出了一句话。

需要注意的是，ApplicationRunner接口的run()方法中接收的参数为ApplicationArguments类型，它包含了Spring Boot应用启动时传递给程序的所有参数。ApplicationArguments中除了包含命令行参数外，还提供了许多方便我们获取参数的方法。

2. CommandLineRunner 示例代码

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
       
    @Bean
    public CommandLineRunner commandLineRunner(){
        return new CommandLineRunner() {
            @Override
            public void run(String... args) throws Exception {
                System.out.println("CommandLineRunner is running...");
            }
        };
    }
}

在上面的示例中，我们通过@Bean注解创建了一个CommandLineRunner类型的bean，并在其run()方法中输出了一句话。因此，在Spring Boot应用启动后，该bean中的run()方法会被自动执行。

需要注意的是，CommandLineRunner接口中的run()方法接收一个表示启动应用程序时传递给程序的所有命令行参数的字符串数组。在上例中，我们未使用args参数，如果您需要访问这些参数，只需在run()方法中使用该参数即可。

四、结语

使用ApplicationRunner和CommandLineRunner接口非常方便，帮助我们在Spring Boot应用程序启动后执行特定的代码逻辑。当您需要在项目启动时完成一些特定的初始化操作时，请尝试使用这两个类并实现它们，它们的使用将使您的生活更轻松。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/271430.html