Spring Boot定义系统启动任务

梦里梦外; 2021-11-05 22:04 303阅读 0赞

### Spring Boot定义系统启动任务 ###

*  前言
 *  CommandLineRunner
 *  ApplicationRunner

# 前言 #

在java web项目中，如果涉及到系统任务，例如在项目启动阶段要做一些数据初始化操作，这些操作有一个共同的特点，只在项目启动时进行，以后都不再执行，这里，容易想到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(10)
    public class MyCommandLineRunner1 implements CommandLineRunner { 
        @Override
        public void run(String... args) throws Exception { 
            for (String arg:args) { 
                System.out.println("MyConmandRunner1>>>"+arg);
            }
        }
    }

MyCommandLineRunner2

@Component
    @Order(9)
    public class MyCommandLineRunner2 implements CommandLineRunner { 
        @Override
        public void run(String... args) throws Exception { 
            for (String arg:args) { 
                System.out.println("MyConmandRunner2>>>"+arg);
            }
        }
    }

首先通过 @Compoent 注解将 MyCommandLineRunner1 注册为Spring容器中的一个 Bean。  
添加 @Order注解，表示这个启动任务的执行优先级，因为在一个项目中，启动任务可能有多个，所以需要有一个排序。@Order 注解中，数字越小，优先级越大，默认情况下，优先级的值为 Integer.MAX\_VALUE，表示优先级最低。  
在 run 方法中，写启动任务的核心逻辑，当项目启动时，run方法会被自动执行。  
run 方法的参数，来自于项目的启动参数，即项目入口类中，main方法的参数会被传到这里。  
此时启动项目，run方法就会被执行，至于参数，可以通过两种方式来传递，如果是在 IDEA 中，可以通过如下方式来配置参数：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lqbjE5OTU_size_16_color_FFFFFF_t_70]  
  也可以将项目打包：  
  用命令行启动项目时输入参数：

java -jar systemstarttask-0.0.1-SNAPSHOT.jar Java C++

这里参数传递时没有key，直接写value即可，执行结果如下：  
![在这里插入图片描述][20190809113136748.png]

# ApplicationRunner #

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

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

import org.springframework.boot.ApplicationArguments;
    import org.springframework.boot.ApplicationRunner;
    import org.springframework.core.annotation.Order;
    import org.springframework.stereotype.Component;
    
    import java.util.Arrays;
    import java.util.List;
    import java.util.Set;
    
    @Component
    @Order(8)
    public class ApplicationRunner1 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:

args.getNonOptionArgs();可以用来获取命令行中的无key参数（和CommandLineRunner一样）。  
args.getOptionNames();可以用来获取所有key/value形式的参数的key。  
args.getOptionValues(key));可以根据key获取key/value 形式的参数的value。  
args.getSourceArgs(); 则表示获取命令行中的所有参数。

ApplicationRunner 定义完成后，传启动参数也是两种方式，参数类型也有两种，第一种和 CommandLineRunner 一致，第二种则是 –key=value 的形式，在 IDEA 中定义方式如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lqbjE5OTU_size_16_color_FFFFFF_t_70 1]  
或者启动如下命令：

java -jar systemstarttask-0.0.1-SNAPSHOT.jar Java C++ --age=18

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lqbjE5OTU_size_16_color_FFFFFF_t_70 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lqbjE5OTU_size_16_color_FFFFFF_t_70]: /images/20211104/6106b82e237f4706bffab935d4d93552.png
[20190809113136748.png]: /images/20211104/dd70dceb36d2485d8728f338084044c0.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lqbjE5OTU_size_16_color_FFFFFF_t_70 1]: /images/20211104/66cf74b8cde442fcb65e381bb823ab1f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3lqbjE5OTU_size_16_color_FFFFFF_t_70 2]: /images/20211104/4d4c2c6e7fc84f63aab11fe9c0a00b1a.png