Spring Boot 定义系统启动任务的多种方式

 更新时间:2019年04月15日 10:56:50   作者:江南一点雨   我要评论

这篇文章主要介绍了Spring Boot 定义系统启动任务的多种方式,看看你都会哪几种 ,感兴趣的朋友跟随小编一起看看吧

在 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

运行结果如下:

总结

整体来说 ,这两种的用法的差异不大 ,主要体现在对参数的处理上,小伙伴可以根据项目中的实际情况选择合适的解决方案。

相关文章

  • SpringBoot AOP控制Redis自动缓存和更新的示例

    SpringBoot AOP控制Redis自动缓存和更新的示例

    今天小编就为大家分享一篇关于SpringBoot AOP控制Redis自动缓存和更新的示例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • java网上图书商城(5)购物车模块2

    java网上图书商城(5)购物车模块2

    这篇文章主要为大家详细介绍了java网上图书商城,购物车模块第二篇,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • 浅谈fastjson的常用使用方法

    浅谈fastjson的常用使用方法

    下面小编就为大家带来一篇浅谈fastjson的常用使用方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-08-08
  • Java并发编程总结——慎用CAS详解

    Java并发编程总结——慎用CAS详解

    下面小编就为大家带来一篇Java并发编程总结——慎用CAS详解。小编觉得挺不错的, 现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2016-06-06
  • Java 8 lambda表达式引入详解及实例

    Java 8 lambda表达式引入详解及实例

    这篇文章主要介绍了Java 8 lambda表达式引入详解及实例的相关资料,需要的朋友可以参考下
    2017-05-05
  • Intellij IDEA实现SpringBoot项目多端口启动的两种方法

    Intellij IDEA实现SpringBoot项目多端口启动的两种方法

    有时候使用springboot项目时遇到这样一种情况,用一个项目需要复制很多遍进行测试,除了端口号不同以外,没有任何不同。遇到这种情况怎么办呢?这时候可以使用Intellij IDEA解决
    2018-06-06
  • 详解Spring整合Quartz实现动态定时任务

    详解Spring整合Quartz实现动态定时任务

    本篇文章主要介绍了详解Spring整合Quartz实现动态定时任务,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-03-03
  • Ubuntu 15下安装JDK1.8教程

    Ubuntu 15下安装JDK1.8教程

    这篇文章主要为大家详细介绍了Ubuntu 15下JDK1.8安装教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-12-12
  • JFreeChart实现实时曲线图

    JFreeChart实现实时曲线图

    这篇文章主要为大家详细介绍了JFreeChart实现实时曲线图的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-06-06
  • Java私有构造器使用方法示例

    Java私有构造器使用方法示例

    这篇文章主要介绍了Java私有构造器的含义、关键字,同时通过实例向大家展示其使用方法,需要的朋友可以参考下
    2017-09-09

最新评论