SpringBoot - 实现启动时执行指定任务（CommandLineRunner、ApplicationRunner）

### CommandLineRunner 的作用与用法 #### 1. **CommandLineRunner 接口的定义** `CommandLineRunner` 是 Spring Boot 提供的一个接口，主要用于在应用程序启动完成后执行某些特定任务或代码块。它是一种非常灵活的机制，允许开发者在应用启动过程中插入自定义逻辑[^1]。 #### 2. **运行时机** `CommandLineRunner` 的 `run` 方法会在以下阶段被调用： - 当 `SpringApplication.run()` 被触发时，Spring Boot 开始启动应用程序。 - Spring 容器（通常是 ApplicationContext）完成初始化后，所有 Bean 已经被创建并完成了依赖注入。 - 此时，Spring Boot 会自动扫描所有实现了 `CommandLineRunner` 接口的 Bean，并按照一定顺序依次调用其 `run` 方法。 - 所有 `CommandLineRunner` 实现类的 `run` 方法执行完毕后，应用程序正式进入就绪状态[^2]。 #### 3. **基本用法** 要使用 `CommandLineRunner`，可以通过以下方式实现： ##### (1) 创建一个组件类并实现 `CommandLineRunner` 通过标注 `@Component` 将其实例化为 Spring 容器中的一个 Bean，同时重写 `run` 方法，在其中编写需要执行的业务逻辑。 ```java @Component public class MyInitService implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println("项目启动成功后的初始化操作..."); } } ``` ##### (2) 多个实现类的执行顺序 如果存在多个 `CommandLineRunner` 实现类，则默认情况下它们会被随机执行。为了控制执行顺序，可以引入 `@Order` 注解或者实现 `Ordered` 接口来指定优先级。数值越小，优先级越高。 ```java @Component @Order(1) public class FirstTask implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println("第一个任务被执行"); } } @Component @Order(2) public class SecondTask implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println("第二个任务被执行"); } } ``` #### 4. **应用场景** `CommandLineRunner` 可广泛应用于以下场景： - 数据库初始化：例如加载初始数据到数据库中[^5]。 - 缓存预热：提前填充缓存以提高性能。 - 日志记录：打印启动日志或其他调试信息。 - 自动测试：在集成测试环境中模拟用户行为。 #### 5. **与其他接口的关系** 除了 `CommandLineRunner`，Spring Boot 还提供了另一个类似的接口——`ApplicationRunner`。两者的主要区别在于参数的不同以及适用场景的选择上[^4]。 | 特性 | CommandLineRunner | ApplicationRunner | |-------------------|------------------------------------------|----------------------------------------| | 参数类型 | String 数组 | ApplicationArguments 对象 | | 使用场景 | 更适合处理命令行传参 | 支持更复杂的参数解析 | 尽管如此，对于大多数简单的启动任务来说，`CommandLineRunner` 已经足够满足需求。 --- ### 示例代码 以下是完整的示例代码展示如何使用 `CommandLineRunner` 来执行启动任务： ```java package com.example.demo; import org.springframework.boot.CommandLineRunner; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.stereotype.Component; @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Component public static class StartupTask implements CommandLineRunner { @Override public void run(String... args) throws Exception { System.out.println("Spring Boot 启动后执行的任务！"); } } } ``` ---