CommandLineRunner接口介绍

文章目录

CommandLineRunner接口介绍
- 1. CommandLineRunner接口使用
- 2. ApplicationRunner与CommandLineRunner
- 3. ApplicationArguments 源码分析

CommandLineRunner接口介绍

CommandLineRunner接口是在容器启动成功后的最后一步回调（类似开机自启动）。

1. CommandLineRunner接口使用

写一个类，实现CommandLineRunner接口，将该类注入到Spring容器中；
可以通过@Order注解（属性指定数字越小表示优先级越高）或者Ordered接口来控制执行顺序。

例如，我们自定义两个类，实现CommandLineRunner接口，实现run方法，在run方法中添加处理逻辑。

@Order(5)
@Component
public class AppStartReport implements CommandLineRunner {@Overridepublic void run(String... args) throws Exception {System.out.println("AppStartReport : 项目成功启动------------------");}
}

@Order(2)
@Component
public class AppStartReport2 implements CommandLineRunner {@Overridepublic void run(String... args) throws Exception {System.out.println("AppStartReport2 : 项目成功启动------------------");}
}

项目启动效果如下，AppStartReport2 较AppStartReport 先执行：

2. ApplicationRunner与CommandLineRunner

ApplicationRunner与CommandLineRunner功能类似，区别在于方法参数不同：

CommandLineRunner的方法参数是原始的参数，未做任何处理；
ApplicationRunner的参数为ApplicationArguments对象，是对原始参数的进一步封装。ApplicationArguments是对参数（主要针对main方法）做了进一步的处理，可以解析--name=value的参数，我们就可根据name获取value。

@Component
public class AppStartReport3 implements ApplicationRunner {@Overridepublic void run(ApplicationArguments args) throws Exception {System.out.println("AppStartReport3 : 项目成功启动，参数为: " + Arrays.asList(args.getSourceArgs()));}
}

由于我们使用的是main方法的args参数，而这个参数未指定过，因此这里获取值为空；

我们接下来进行参数值的手动指定，再查看效果：

@SpringBootApplication
public class App {public static void main(String[] args) {SpringApplication application = new SpringApplication(App.class);ConfigurableApplicationContext context = application.run("aaa", "bbb");context.close();}
}

以上是自行指定的参数值，未使用main方法的系统参数值，效果如下：

那我们如何指定系统参数值呢？可以在Program arguments选项框设置初始值，“–key=value“形式，如“–argname=ccc”，如下图所示：

@SpringBootApplication
public class App {public static void main(String[] args) {SpringApplication application = new SpringApplication(App.class);ConfigurableApplicationContext context = application.run(args);context.close();}
}

启动器传入参数为main方法的参数args，效果如下：

我们发现获取到的是我们设置的整个参数信息，那如何根据key获取具体的value呢，接下来就需要看一下ApplicationArguments的源码了。

3. ApplicationArguments 源码分析

public interface ApplicationArguments {String[] getSourceArgs();Set<String> getOptionNames();boolean containsOption(String name);List<String> getOptionValues(String name);List<String> getNonOptionArgs();}

我们可以看到5个方法。
从前面的例子中我们可以看出，资源参数分为两种，一种是在调用run方法时传入的（”aaa”,”bbb”），一种是配置的系统参数即main方法的args参数（”ccc”）。

首先getSourceArgs方法，可以获取到所有参数，可以是自己传入的参数，也可以是配置的系统参数；
getNonOptionArgs方法即可获得我们传入的参数（”aaa”,”bbb”）。
其余3个方法，可获得系统参数。实际用法如下：

@SpringBootApplication
public class App {public static void main(String[] args) {SpringApplication application = new SpringApplication(App.class);ConfigurableApplicationContext context = application.run(args);ApplicationArguments arguments = context.getBean(ApplicationArguments.class);System.out.println("参数个数：" + arguments.getSourceArgs().length);System.out.println("Non OptionArgs：" + arguments.getNonOptionArgs());System.out.println("Option Names：" + arguments.getOptionNames());System.out.println("获取key为argname的value值：" + arguments.getOptionValues("argname"));System.out.println("是否包含key为argname的参数：" + arguments.containsOption("argname"));context.close();}
}

输出效果如图：