30. 如何在Spring Boot中使用`CommandLineRunner`和`ApplicationRunner`？

PangHu大约 3 分钟

在Spring Boot中，CommandLineRunner和ApplicationRunner是两个非常有用的接口，用于在Spring Boot应用启动完成后执行一些代码。它们通常用于在应用启动时执行初始化任务，例如加载初始数据、启动后台任务或执行配置检查等。

1. `CommandLineRunner`和`ApplicationRunner`的区别

CommandLineRunner：
- 接口中有一个run(String... args)方法，接收应用程序启动时传递的参数（字符串数组args）。
- args是从命令行传入的参数（或者通过Spring Boot的启动配置传入），这些参数会作为run方法的输入。
ApplicationRunner：
- 接口中有一个run(ApplicationArguments args)方法，ApplicationArguments对象提供了更丰富的API来访问传递给应用程序的参数。
- ApplicationArguments不仅能获取原始的字符串参数，还能获取命名参数和非命名参数。

2. 使用`CommandLineRunner`

2.1 简单示例

通过实现CommandLineRunner接口，可以在Spring Boot应用启动后立即执行一些代码。

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

@Component
public class MyCommandLineRunner implements CommandLineRunner {

    @Override
    public void run(String... args) {
        System.out.println("CommandLineRunner - Application started with arguments:");
        for (String arg : args) {
            System.out.println(arg);
        }
        // 执行初始化任务
    }
}

在这个示例中，MyCommandLineRunner将在应用启动后执行，并输出传入的参数。

2.2 传递命令行参数

你可以通过命令行传递参数，Spring Boot会自动将它们传递给CommandLineRunner的run方法。

$ java -jar myapp.jar arg1 arg2 arg3

在应用启动时，控制台将输出：

CommandLineRunner - Application started with arguments:
arg1
arg2
arg3

3. 使用`ApplicationRunner`

3.1 简单示例

通过实现ApplicationRunner接口，可以在Spring Boot应用启动后执行代码，并使用ApplicationArguments对象来处理命令行参数。

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) {
        System.out.println("ApplicationRunner - Application started with arguments:");
        System.out.println("Option Names: " + args.getOptionNames());
        if (args.containsOption("name")) {
            System.out.println("Name: " + args.getOptionValues("name"));
        }
        System.out.println("Non-option args: " + args.getNonOptionArgs());
        // 执行初始化任务
    }
}

在这个示例中，MyApplicationRunner使用ApplicationArguments对象来访问命令行参数。

3.2 传递命令行参数

你可以通过命令行传递命名参数和非命名参数。

$ java -jar myapp.jar --name=JohnDoe arg1 arg2

在应用启动时，控制台将输出：

ApplicationRunner - Application started with arguments:
Option Names: [name]
Name: [JohnDoe]
Non-option args: [arg1, arg2]

4. 多个`CommandLineRunner`或`ApplicationRunner`

如果在Spring Boot应用中有多个CommandLineRunner或ApplicationRunner实现，它们会根据Spring Bean的加载顺序依次执行。

4.1 使用`@Order`注解指定执行顺序

你可以通过@Order注解或实现Ordered接口来指定多个CommandLineRunner或ApplicationRunner的执行顺序。

import org.springframework.core.annotation.Order;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;

@Component
@Order(1)
public class FirstRunner implements CommandLineRunner {
    @Override
    public void run(String... args) {
        System.out.println("First Runner");
    }
}

@Component
@Order(2)
public class SecondRunner implements CommandLineRunner {
    @Override
    public void run(String... args) {
        System.out.println("Second Runner");
    }
}

在这个示例中，FirstRunner将在SecondRunner之前执行，因为@Order(1)的值比@Order(2)的值小。

5. 实际应用场景

CommandLineRunner和ApplicationRunner常用于以下场景：

加载初始数据：在应用启动时从数据库或文件中加载初始数据。
启动后台任务：在应用启动后立即启动一些后台任务，如消息队列消费者或定时任务。
配置检查：在应用启动时执行一些检查，确保必要的配置已正确加载。
日志记录：记录应用启动时的环境信息或参数，以便于调试和分析。

在Spring Boot中，CommandLineRunner和ApplicationRunner提供了在应用启动后执行代码的便利方式。通过实现这些接口，你可以轻松地在应用启动时执行初始化任务。CommandLineRunner更适合简单的字符串参数处理，而ApplicationRunner提供了更丰富的参数访问功能，适合处理复杂的启动配置。这两个接口都可以通过@Order注解或Ordered接口来控制执行顺序，确保多个初始化任务按需执行。