spring boot 2源码系列（四）- ApplicationRunner和CommandLineRunner

spring boot工程启动成功后会回调ApplicationRunner和CommandLineRunner接口的run方法，这两个接口主要有两点不同：

1、ApplicationRunner的run(ApplicationArguments args)接收一个ApplicationArguments类型的参数，ApplicationArguments是对原始程序参数的封装类。CommandLineRunner的run(String... args)接收原始的程序参数。

2、若未加上@Order注解定义排序值或排序值相同，ApplicationRunner比CommandLineRunner先运行。

ApplicationRunner、CommandLineRunner使用

1、新建4个类

//未定义@Order排序值
@Component
public class ApplicationRunnerOne implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("#######启动加载器--ApplicationRunnerOne。原始程序参数："+args.getSourceArgs()
                +"。test="+args.getOptionValues("test").toString());
    }
}

//@Order排序值为2
@Order(2)
@Component
public class ApplicationRunnerTwo implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("#######启动加载器--ApplicationRunnerTwo");
    }
}

//未定义@Order排序值
@Component
public class CommandLineRunner1 implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("#######启动加载器--CommandLineRunner1");
    }
}

//@Order排序值为2
@Order(2)
@Component
public class CommandLineRunner2 implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
        System.out.println("#######启动加载器--CommandLineRunner2");
    }
}

2、添加程序参数 --test=value01

3、启动spring boot，控制台输出如下：

#######启动加载器--ApplicationRunnerTwo
#######启动加载器--CommandLineRunner2
#######启动加载器--ApplicationRunnerOne。原始程序参数：[Ljava.lang.String;@39fa8ad2。test=[value01]
#######启动加载器--CommandLineRunner1

ApplicationRunnerTwo、CommandLineRunner2的@Order排序值相同，ApplicationRunnerTwo比CommandLineRunner2先运行。没加上@Order排序值的后运行。

源码

ApplicationRunner、CommandLineRunner的源码比较简单，只需要在实现类的run方法中打一个断点，程序调用栈就很清晰了。

调用栈不深，开始分析源码。

1、在 SpringApplication#run(java.lang.String...) 中，ApplicationStartedEvent事件发布、监听完成之后，便调用Runner。

// 源码位置 org.springframework.boot.SpringApplication#run(java.lang.String...)
// 仅列出主要代码
public ConfigurableApplicationContext run(String... args) {

    // 使用程序参数创建ApplicationArguments对象
    ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);

    listeners.started(context);

    // 在ApplicationStartedEvent事件之后执行Runners
    callRunners(context, applicationArguments);

}

1.1 ApplicationArguments applicationArguments = new DefaultApplicationArguments(args); 源码

// 源码位置 org.springframework.boot.DefaultApplicationArguments#DefaultApplicationArguments
public DefaultApplicationArguments(String... args) {
    Assert.notNull(args, "Args must not be null");
    // 通过args创建this.source
    this.source = new DefaultApplicationArguments.Source(args);
    // 依旧将args原始值存储在this.args属性中
    this.args = args;
}

1.1.2 对args的处理在 org.springframework.core.env.SimpleCommandLineArgsParser#parse(String... args) 方法中，主要逻辑是通过  -- 和 = 分隔程序参数。

1.2、callRunners(context, applicationArguments); 源码

// 源码位置 org.springframework.boot.SpringApplication#callRunners
private void callRunners(ApplicationContext context, ApplicationArguments args) {
    List