SpringBoot - ApplicationRunner的作用是什么？

我就是我 2023-10-08 16:28 64阅读 0赞

#### 写在前面 ####

有时针对一些特殊的业务场景，需要在系统启动时执行某些任务，如：配置文件的加载、数据库的初始化等等操作。SpringBoot 提供了两种解决方案：一种是使用CommandLineRunner，另一种是使用 ApplicationRunner。

#### 基本原理 ####

项目在启动时会遍历所有的 ApplicationRunner 的实现类并调用其中的 run 方法，如果在系统中有多个 ApplicationRunner的实现类，可以使用 @Order 注解对这些实现类的调用顺序进行排序(数字越小越先执行)；  
run方法的参数是系统启动时传入的参数，即入口类中main方法的参数(在调用SpringApplication.run方法时传入到 SpringBoot项目的上下文环境中)。

#### 如何使用 ####

@Component
    @Slf4j
    @Order(1)
    public class MyApplicationRunner implements ApplicationRunner {
        
    	// ApplicationArguments, 需要区分选项参数和非选项参数;
    	// 选项参数, 通过ApplicationArguments的getOptionNames()方法获取所有选项名称即参数的KEY, 然后通过 getOptionValues()方法根据参数KEY, 获取实际值(它会返回一个列表字符串), 一般为： --user-name=ROCKY --age=30
    	// 非选项参数, 通过ApplicationArguments的getNonOptionArgs()方法获取一个参数值数组;
        @Override
        public void run(ApplicationArguments args) throws Exception {
        
        	// TO DO SOMETHING...
        }
    }

#### ApplicationRunner和CommandLineRunner的区别 ####

@Component
    @Slf4j
    @Order(1)
    public class MyCommandLineRunner implements CommandLineRunner {
        
        @Override
        public void run(String... args) throws Exception {
        
        	// TO DO SOMETHING...
        }
    }

ApplicationRunner与CommandLineRunner的主要区别体现在run方法的参数上，CommandLineRunner中的run方法的参数是参数数组；ApplicationRunner中的run方法的参数是ApplicationArguments对象。

#### 执行顺序 ####

系统支持创建多个CommandLineRunner或ApplicationRunner的实现类，可以使用@Order注解或实现Ordered接口，来设定各个实现类的执行顺序。

#### 选项参数与非选项参数 ####

选项参数：可以理解为Spring Boot 提供的参数格式，以–开头，使用=分割键值对，如：java -jar XXX.jar --name=ROCKY --age=30 --spring.profiles.active=dev；  
非选项参数：不是以–开头，也没有设置值的单一参数KEY只有值，如：java -jar XXX.jar --name=ROCKY --age=30 --spring.profiles.active=dev 陕西 西安 雁塔区，其中"陕西 西安 雁塔区" 就是非选项参数；  
系统参数：\-Dxxxx是设置JAVA运行上下文的参数语法，用于配置一些环境变量，如：java -jar XXX.jar -Dserver.port=8081 --name=ROCKY --age=30 --spring.profiles.active=dev 陕西 西安 雁塔区，其中"-Dserver.port"就是系统参数。