Spring Boot中的CommandLineRunner和ApplicationRunner有什么区别？

在Spring Boot中，CommandLineRunner 和 ApplicationRunner 是两种可以用来执行启动后的一些初始化任务的接口。它们的主要区别在于参数类型和灵活性方面。

CommandLineRunner

CommandLineRunner 是一个非常简单的接口，它只有一个方法 run，该方法接受一个 String[] 参数，代表命令行参数。CommandLineRunner 的主要用途是在应用启动后立即执行一些必要的初始化任务。

CommandLineRunner 接口定义

public interface CommandLineRunner {
    void run(String... args) throws Exception;
}

示例代码

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        // 执行一些初始化任务
        System.out.println("Application started with arguments: " + String.join(", ", args));
    }
}

ApplicationRunner

ApplicationRunner 是 CommandLineRunner 的扩展，它同样只有一个 run 方法，但是它接受一个 ApplicationArguments 类型的参数，这个类提供了更多关于命令行参数的信息，包括原始参数、选项、非选项参数等。

ApplicationRunner 接口定义

public interface ApplicationRunner extends CommandLineRunner {
    void run(ApplicationArguments args) throws Exception;
}

示例代码

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.stereotype.Component;

@Component
public class MyApplicationRunner implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 执行一些初始化任务
        System.out.println("Application started with non-option arguments: " + args.getNonOptionArgs());
        System.out.println("Application started with option names: " + args.getOptionNames());
    }
}

主要区别

1. 参数类型：

   • CommandLineRunner 接受 String[] 类型的参数。
   • ApplicationRunner 接受 ApplicationArguments 类型的参数，提供了更丰富的命令行参数信息。

2. 灵活性：

   • ApplicationRunner 更灵活，因为它允许您更方便地访问命令行参数，并且可以区分选项和非选项参数。

3. 默认行为：

   • ApplicationRunner 继承自 CommandLineRunner，因此它们可以互换使用，但是 ApplicationRunner 提供了更高级的功能。

总结

• 何时使用 CommandLineRunner：

  • 当您只需要简单的命令行参数列表，并且不需要区分选项和非选项参数时。
  • 当您想要快速执行一些初始化任务时。

• 何时使用 ApplicationRunner：

  • 当您需要更详细的命令行参数信息时，例如区分选项和非选项参数。
  • 当您想要更灵活地处理命令行参数时。

在大多数情况下，ApplicationRunner 提供了更多的灵活性，尤其是在需要处理复杂命令行参数的情况下。然而，对于简单的任务，CommandLineRunner 就足够了，并且它的使用更为简单直接。根据您的具体需求选择合适的接口即可。