当前位置: 首页 > 编程笔记 >

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

向苗宣
2023-03-14
本文向大家介绍Spring Boot 定义系统启动任务的多种方式,包括了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在服务器上的几种启动方式(小结),包括了springboot在服务器上的几种启动方式(小结)的使用技巧和注意事项,需要的朋友参考一下 一、使用内置的tomcat,通过java -jar的方式启动 比如:java -jar bms.jar  但是这种启动方式 一旦关闭控制台 或者crtl+c 退出 此时应用就关闭了 所以我们需要换种方式 springboot中的ma

  • 服务启动事件 function onWorkerStart(\swoole_server $server,$workerId); 此事件在Worker进程/Task进程启动时发生。这里创建的对象可以在进程生命周期内使用,需要注意的是 Task进程也会触发此事件 发生致命错误或者代码中主动调用exit时,Worker/Task进程会退出,管理进程会重新创建新的进程,也会触发本事件 onWorkerS

  • 本文向大家介绍springboot动态定时任务的实现方法示例,包括了springboot动态定时任务的实现方法示例的使用技巧和注意事项,需要的朋友参考一下 1、maven引入quartz包 2、创建定时任务工厂类 3、创建定时任务抽象类 4、创建定时任务业务实现类 这里可以写你的业务代码,实现具体的业务逻辑。 5、创建定时任务管理器 包括项目启动时添加定时任务,手动添加定时任务,更新定时任务,删除

  • 服务启动前事件 function beforeWorkerStart(\swoole_server $server); 在执行beforeWorkerStart事件时,框架已经完成的工作有: frameInitialize 事件内的全部事务 frameInitialized 事件内的全部事务 错误处理函数的注册 swoole_http_server对象创建,且设置了启动参数。(未启动) 在该回调事

  • 本文向大家介绍SpringBoot执行定时任务@Scheduled的方法,包括了SpringBoot执行定时任务@Scheduled的方法的使用技巧和注意事项,需要的朋友参考一下 在做项目时,需要一个定时任务来接收数据存入数据库,后端再写一个接口来提供该该数据的最新的那一条。 数据保持最新:设计字段sign的值(0,1)来设定是否最新 定时任务插入数据:首先进行更新,将所有为1即新数据设置过期,然

  • 本文向大家介绍SpringBoot中实现启动任务的实现步骤,包括了SpringBoot中实现启动任务的实现步骤的使用技巧和注意事项,需要的朋友参考一下 我们在项目中会用到项目启动任务,即项目在启动的时候需要做的一些事,例如:数据初始化、获取第三方数据等等,那么如何在SpringBoot 中实现启动任务,一起来看看吧 SpringBoot 中提供了两种项目启动方案,CommandLineRunner