Spring Boot ApplicationRunner 与 CommandLineRunner 接口使用大全：掌握命令行参数技巧

Spring Boot ApplicationRunner 与 CommandLineRunner 接口：详解及其用法

在 Spring Boot 应用中，ApplicationRunner 和 CommandLineRunner 接口扮演着至关重要的角色，让开发者可以在应用启动时执行自定义任务。这两个接口看似相似，但细微差别不可忽视。

ApplicationRunner 接口

ApplicationRunner 接口允许你在应用的任意位置运行任务，而无需局限于主方法。它的 run 方法接收一个 ApplicationArguments 参数，提供有关命令行参数的信息。run 方法可以抛出任意类型的异常。

CommandLineRunner 接口

CommandLineRunner 接口仅允许你在应用的主方法中运行任务。它的 run 方法接收一个 String[] 参数，代表命令行参数。run 方法只能抛出 RuntimeException。

用例场景

ApplicationRunner 和 CommandLineRunner 常用于执行以下任务：

• 打印信息或日志
• 加载数据或配置
• 初始化数据库连接
• 启动其他服务或进程

注意事项

• 任务应轻量级，避免耗时操作。
• 避免修改应用状态。
• 任务应独立，不依赖其他任务。
• 如需在任务中抛出异常，使用 ApplicationRunner 接口的 run 方法。

代码示例

// 使用 ApplicationRunner 接口
@Component
public class MyApplicationRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 获取命令行参数
        List<String> nonOptionArgs = args.getNonOptionArgs();

        // 处理参数
        for (String arg : nonOptionArgs) {
            System.out.println("参数：" + arg);
        }
    }
}

// 使用 CommandLineRunner 接口
@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        // 获取命令行参数
        int numArgs = args.length;

        // 处理参数
        System.out.println("命令行参数数量：" + numArgs);
        for (String arg : args) {
            System.out.println("参数：" + arg);
        }
    }
}

常见问题解答

1. 这两个接口之间有什么根本区别？

   • ApplicationRunner 可在应用任意位置运行任务，而 CommandLineRunner 仅限于主方法。

2. 哪个接口更适合我的任务？

   • 如果需要在应用启动的不同阶段执行任务，使用 ApplicationRunner 。对于只在主方法中运行的任务，使用 CommandLineRunner 。

3. 任务中可以抛出什么类型的异常？

   • ApplicationRunner ：任意类型
   • CommandLineRunner ：仅限 RuntimeException

4. 任务应该做什么？

   • 避免耗时操作或修改应用状态。任务应独立且轻量级。

5. 如何自定义任务执行顺序？

   • 使用 @Order 注解，为任务设置优先级，数字越小，优先级越高。