[TOC]
# 简介
有时候需要在Springboot启动后执行某操作,实现ApplicationRunner和CommandLineRunner接口(都有run方法)就可以解决这个问题。
所有实现这两个接口的,如果要执行一系列操作,可以通过实现Ordered接口或用Order注解来指定执行顺序(默认从小到大开始执行)。
SpringBoot应用启动成功以后就会callRunners方法,方法中调用ApplicationRunner和CommandLineRunner接口的run方法,只在启动成功以后**调用一次**。
所以,在这基础上就可以实现相当于开机自启的一个操作,具体执行的逻辑代码就看在应用启动后需要做什么事情了
# ApplicationRunner
实现ApplicationRunner接口,重写run方法,方法参数是ApplicationArguments,解析封装过后的args参数
通过该对象既可以拿到原始命令行参数,也可以拿到解析后的参数,对应方法写在下面的代码里了。其中@Order中的值指定了执行顺序,值小的先执行。默认值是Integer.MAX\_VALUE;
~~~
import java.util.Arrays;
import java.util.Set;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
@Component
@Order(1)
public class MyApplicationRunner implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
System.out.println("====================MyApplicationRunner================");
System.out.println("order值: 1");
System.out.println("原始参数:"+Arrays.asList(args.getSourceArgs()));
Set keys = args.getOptionNames();
for (String key : keys) {
System.out.println("解析后的key: ["+key+"] value: "+args.getOptionValues(key));
}
System.out.println("无OptionName的参数: "+args.getNonOptionArgs());
System.out.println("=======================================================");
}
}
~~~
启动项目,在SpringApplication.run()方法执行的最后,就会callRunners
至于参数,如下,后面两个参数只是为了测试随便加的,无意义,除了在编码工具里添加命令行参数,也可以在项目打包以后,启动的时候在`java -jar`后面直接加,是一样的
~~~
Program arguments:
--spring.config.location=file:E:\AllWorkSpace\custom.properties --key haha
~~~
# CommandLineRunner
同样的实现CommandLineRunner接口,重写run方法,方法参数是原始args参数。上面MyApplicationRunner的order值指定是1,这里MyCommandLineRunner的order值指定为2,那么前者会先执行
~~~
import java.util.Arrays;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
@Component
@Order(2)
public class MyCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
// TODO Auto-generated method stub
System.out.println("====================MyCommandLineRunner================");
System.out.println("order值: 2");
System.out.println("原始参数: "+Arrays.asList(args));
System.out.println("=======================================================");
}
}
~~~
两种方法用法可以说是一样的,区别只在于方法的参数,一个是经过解析后的,一个是原始的命令行参数,具体用哪个,可看实际情况定夺。