102. Spring Boot之CommandLineRunner和ApplicationRunner

Posted 2021-04-30 SpringBoot

需求缘起：在有【】文章中介绍了CommandLineRunner的使用，有人评论说实现ApplicationRunner接口也可以，那么本节就是要介绍ComandLineRunner和ApplicationRunner区别和使用。

本节大纲：

（1）使用场景的提出；

（2）共同点和区别；

（3）CommandLineRunner使用例子；

（4）ApplicationRunner使用例子；

（5）使用Ordered接口或者Order注解修改执行顺序；

（6）再次理解共同点和区别以及使用时机；

（7）题外话；

    

   具体内容接着往下看：

（1）使用场景的提出；

       我们在开发过程中会有这样的场景：需要在容器启动的时候执行一些内容，比如：读取配置文件信息，数据库连接，删除临时文件，清除缓存信息，在Spring框架下是通过ApplicationListener监听器来实现的。在Spring Boot中给我们提供了两个接口来帮助我们实现这样的需求。这两个接口就是我们今天要讲的CommandLineRunner和ApplicationRunner，他们的执行时机为容器启动完成的时候。

 

（2）共同点和区别；

共同点：其一执行时机都是在容器启动完成的时候进行执行；其二这两个接口中都有一个run()方法；

不同点：ApplicationRunner中run方法的参数为ApplicationArguments，而CommandLineRunner接口中run方法的参数为String数组。

 

（3）CommandLineRunner使用例子；

       CommandLineRunner例子大体的思路是：编写一个class，然后实现CommandLineRunner接口，最后添加@Component注解，具体代码如下：

package com.kfit.config;

 

import org.springframework.boot.CommandLineRunner;

import org.springframework.stereotype.Component;

 

/**

 * 注意：需要注解：@Component

 * @author Angel --守护天使

 * @version v.0.1

 * @date 2017年1月15日

 */

@Component

public class MyStartupRunner1 implements CommandLineRunner{

    @Override

    public void run(String... args) throws Exception {

        System.out.println("<<<<<<<<<<<<这个是测试CommandLineRunn接口>>>>>>>>>>>>>>");

    }

}

运行代码，观察控制台输出：

<<<<<<<<<<<<这个是测试CommandLineRunn接口>>>>>>>>>>>>>>

 

（4）ApplicationRunner使用例子；

       ApplicationRunner例子大体的思路是：编写一个class，然后实现ApplicationRunner接口，最后添加@Component注解，具体代码如下：

package com.kfit.config;

 

import org.springframework.boot.ApplicationArguments;

import org.springframework.boot.ApplicationRunner;

import org.springframework.stereotype.Component;

 

/**

 * 注意：需要添加@Component注解

 * @author Angel --守护天使

 * @version v.0.1

 * @date 2017年1月15日

 */

@Component

public class MyStartupRunner2 implements ApplicationRunner{

 

    @Override

    public void run(ApplicationArguments args) throws Exception {

        System.out.println("<<<<<<<<<<<<这个是测试ApplicationRunner接口>>>>>>>>>>>>>>");

    }

   

}

运行，观察控制台输出：

<<<<<<<<<<<<这个是测试ApplicationRunner接口>>>>>>>>>>>>>>

 

（5）使用Ordered接口或者Order注解修改执行顺序；

问题提出: 如果有多个实现类，而我们需要按照一定的顺序执行的话，那么应该怎么办呢？

解决方案：其一可以在实现类上加上@Order注解指定执行的顺序；其二可以在实现类上实现Ordered接口来标识。

需要注意：数字越小，优先级越高，也就是@Order(1)注解的类会在@Order(2)注解的类之前执行。

 

（6）再次理解共同点和区别以及使用时机；

在之前谈过的区别就不说了，我们看看官方文档对CommandLineRunner和ApplicationRunner的区别说明：

Interface used to indicate that abean should run when it is contained within 
a SpringApplication. Multiple CommandLineRunner beans can be defined 
within the same application context and can be ordered using the Ordered 
interface or @Order annotation. 
If you need access to ApplicationArguments instead of the raw String arrayconsider using ApplicationRunner.

 

其实没有很大区别，如果想要更详细地获取命令行参数，那就使用ApplicationRunner接口。

 

（7）题外话；

Eclipse中给java应用传args参数的方法如下：

1、先写好Java代码，比如文件名为IntArrqy.java；

2、在工具栏或菜单上点run as下边有个Run Configuration；

3、在弹出窗口点选第二个标签arguments；

4、把你想输入的参数写在program argumenst就可以了，多个参数使用空格隔开。

完成后点run即可通过运行结果看到参数使用情况了。