在 SpringBoot 项目中,main 方法调用了 SpringApplication.run 方法,在 SpringApplication.run 方法执行之前还可以执行一些启动任务。具体的方式是实现 ApplicationRunner 或者 CommandLineRunner 这两个接口。
ApplicationRunner 和 CommandLineRunner 的区别
ApplicationRunner 和 CommandLineRunner 两个接口都有只有一个方法 —— run 方法。两个 run 方法的参数不同,ApplicationRunner 接口的 run 方法的参数是 ApplicationArguments 类型的,CommandLineRunner 接口的 run 方法的参数是 String 数组类型的。
ApplicationRunner 接口的 run 方法比 CommandLineRunner 接口的 run 方法要先执行。
具体实现
创建一个 SpringBoot 项目,然后再分别创建 Test1 和 Test2 ,然后让它们全部实现 ApplicationRunner 和 CommandLineRunner 两个接口。
Test1 的代码如下:
public class Test1 implements CommandLineRunner, ApplicationRunner { @Override public void run(String... args) throws Exception { log.info("Test1:CommandLineRunner:run "+ args[0]); } @Override public void run(ApplicationArguments args) throws Exception { log.info("Test1:ApplicationRunner:run "+ args.getSourceArgs()[0]); } }
Test2 的代码也与此类似,代码如下:
public class Test2 implements CommandLineRunner, ApplicationRunner { @Override public void run(String... args) throws Exception { log.info("Test2:CommandLineRunner:run "+ args[1]); } @Override public void run(ApplicationArguments args) throws Exception { log.info("Test2:ApplicationRunner:run "+ args.getSourceArgs()[1]); } }
在 DemoApplication 上也完成同样的代码。然后我们打包,通过命令行启动该 jar 包。
java -jar demo-0.0.1-SNAPSHOT.jar abc xyz
观察输出结果:
cn.coderup.demo.DemoApplication : DemoApplication:ApplicationRunner:run xyz cn.coderup.demo.DemoApplication : DemoApplication:CommandLineRunner:run abc cn.coderup.demo.Test2 : Test2:ApplicationRunner:run xyz cn.coderup.demo.Test2 : Test2:CommandLineRunner:run xyz cn.coderup.demo.Test1 : Test1:ApplicationRunner:run abc cn.coderup.demo.Test1 : Test1:CommandLineRunner:run abc
输出的顺序是,DemoApplication、Test2 和 Test1。
调整顺序
有些时候我们需要按照我们指定的顺序执行每个类中的 ApplicationRunner 和 CommandLIneRunner 中的 run 方法。想要按照我们的顺序来执行,可以使用 @Order 注解,或者实现 Ordered 接口。两种方法我们都使用。
给 Test1 的类上增加 @Order 注解,代码如下:
@Order(value=1) public class Test1 implements CommandLineRunner, ApplicationRunner {
给 DemoApplication 也增加 @Order 注解,代码如下:
@Order(value=3) public class DemoApplication implements CommandLineRunner, ApplicationRunner {
让 Test2 类实现 Ordered 接口,代码如下:
public class Test2 implements CommandLineRunner, ApplicationRunner, Ordered { @Override public int getOrder() { return 2; }
重新打包执行,运行结果如下:
cn.coderup.demo.Test1 : Test1:ApplicationRunner:run abc cn.coderup.demo.Test1 : Test1:CommandLineRunner:run abc cn.coderup.demo.Test2 : Test2:ApplicationRunner:run xyz cn.coderup.demo.Test2 : Test2:CommandLineRunner:run xyz cn.coderup.demo.DemoApplication : DemoApplication:ApplicationRunner:run xyz cn.coderup.demo.DemoApplication : DemoApplication:CommandLineRunner:run abc
执行顺序按照我们指定的顺序进行了输出,分别是 Test1、Test2 和 DemoApplication 这样的顺序。
小结
这是 Spring Boot 的一个小小知识点,希望对大家有所帮助。