Spring Boot2 系列教程(十五)定义系统启动任务的两种方式

在 Servlet/Jsp 项目中，若是涉及到系统任务，例如在项目启动阶段要作一些数据初始化操做，这些操做有一个共同的特色，只在项目启动时进行，之后都再也不执行，这里，容易想到web基础中的三大组件（ Servlet、Filter、Listener ）之一 Listener ，这种状况下，通常定义一个 ServletContextListener，而后就能够监听到项目启动和销毁，进而作出相应的数据初始化和销毁操做，例以下面这样：

public class MyListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        //在这里作数据初始化操做
    }
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        //在这里作数据备份操做
    }
}

固然，这是基础 web 项目的解决方案，若是使用了 Spring Boot，那么咱们能够使用更为简便的方式。Spring Boot 中针对系统启动任务提供了两种解决方案，分别是 CommandLineRunner 和 ApplicationRunner，分别来看。

CommandLineRunner

使用 CommandLineRunner 时，首先自定义 MyCommandLineRunner1 而且实现 CommandLineRunner 接口：

@Component
@Order(100)
public class MyCommandLineRunner1 implements CommandLineRunner {
    @Override
    public void run(String... args) throws Exception {
    }
}

关于这段代码，我作以下解释：

1. 首先经过 @Compoent 注解将 MyCommandLineRunner1 注册为Spring容器中的一个 Bean。
2. 添加 @Order注解，表示这个启动任务的执行优先级，由于在一个项目中，启动任务可能有多个，因此须要有一个排序。@Order 注解中，数字越小，优先级越大，默认状况下，优先级的值为 Integer.MAX_VALUE，表示优先级最低。
3. 在 run 方法中，写启动任务的核心逻辑，当项目启动时，run方法会被自动执行。
4. run 方法的参数，来自于项目的启动参数，即项目入口类中，main方法的参数会被传到这里。

此时启动项目，run方法就会被执行，至于参数，能够经过两种方式来传递，若是是在 IDEA 中，能够经过以下方式来配置参数：

另外一种方式，则是将项目打包，在命令行中启动项目，而后启动时在命令行传入参数，以下：

java -jar devtools-0.0.1-SNAPSHOT.jar 三国演义 西游记

注意，这里参数传递时没有 key，直接写 value 便可，执行结果以下：

ApplicationRunner

ApplicationRunner 和 CommandLineRunner 功能一致，用法也基本一致，惟一的区别主要体如今对参数的处理上，ApplicationRunner 能够接收更多类型的参数（ApplicationRunner 除了能够接收 CommandLineRunner 的参数以外，还能够接收 key/value 形式的参数）。

使用 ApplicationRunner ，自定义类实现 ApplicationRunner 接口便可，组件注册以及组件优先级的配置都和 CommandLineRunner 一致，以下：

@Component
@Order(98)
public class MyApplicationRunner1 implements ApplicationRunner {
    @Override
    public void run(ApplicationArguments args) throws Exception {
        List<String> nonOptionArgs = args.getNonOptionArgs();
        System.out.println("MyApplicationRunner1>>>"+nonOptionArgs);
        Set<String> optionNames = args.getOptionNames();
        for (String key : optionNames) {
            System.out.println("MyApplicationRunner1>>>"+key + ":" + args.getOptionValues(key));
        }
        String[] sourceArgs = args.getSourceArgs();
        System.out.println("MyApplicationRunner1>>>"+Arrays.toString(sourceArgs));
    }
}

当项目启动时，这里的 run 方法就会被自动执行，关于 run 方法的参数 ApplicationArguments ，我说以下几点：

1. args.getNonOptionArgs();能够用来获取命令行中的无key参数（和CommandLineRunner同样）。
2. args.getOptionNames();能够用来获取全部key/value形式的参数的key。
3. args.getOptionValues(key));能够根据key获取key/value 形式的参数的value。
4. args.getSourceArgs(); 则表示获取命令行中的全部参数。

ApplicationRunner 定义完成后，传启动参数也是两种方式，参数类型也有两种，第一种和 CommandLineRunner 一致，第二种则是 --key=value 的形式，在 IDEA 中定义方式以下：

或者使用 以下启动命令：

java -jar devtools-0.0.1-SNAPSHOT.jar 三国演义 西游记 --age=99

运行结果以下：

总结

总体来讲 ，这两种的用法的差别不大 ，主要体如今对参数的处理上，小伙伴能够根据项目中的实际状况选择合适的解决方案。相关案例已经上传到 GitHub，欢迎小伙伴们们下载：https://github.com/lenve/javaboy-code-samples

关注公众号【江南一点雨】，专一于 Spring Boot+微服务以及先后端分离等全栈技术，按期视频教程分享，关注后回复 Java ，领取松哥为你精心准备的 Java 干货！