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

时间:2022-08-27 19:04:15

在 servlet/jsp 项目中,如果涉及到系统任务,例如在项目启动阶段要做一些数据初始化操作,这些操作有一个共同的特点,只在项目启动时进行,以后都不再执行,这里,容易想到web基础中的三大组件( servlet、filter、listener )之一 listener ,这种情况下,一般定义一个 servletcontextlistener,然后就可以监听到项目启动和销毁,进而做出相应的数据初始化和销毁操作,例如下面这样:

?
1
2
3
4
5
6
7
8
9
10
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 接口:

?
1
2
3
4
5
6
7
@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方法的参数会被传到这里。

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

此时启动项目,run方法就会被执行,至于参数,可以通过两种方式来传递,如果是在 idea 中,可以通过如下方式来配置参数:

另一种方式,则是将项目打包,在命令行中启动项目,然后启动时在命令行传入参数,如下:

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

注意,这里参数传递时没有key,直接写value即可,执行结果如下:

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

applicationrunner

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

使用 applicationrunner ,自定义类实现 applicationrunner 接口即可,组件注册以及组件优先级的配置都和 commandlinerunner 一致,如下:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@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 中定义方式如下:

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

或者使用 如下启动命令:

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

运行结果如下:

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

总结

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

原文链接:https://www.cnblogs.com/lenve/p/10709123.html