欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

Spring Boot CommandLineRunner和ApplicationRunner

程序员文章站 2022-03-02 17:31:49
...

[转载自]https://blog.51cto.com/xiaok007/2152761?source=dra

(1)使用场景的提出;

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

(2)共同点和区别;

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

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

在实际项目开发中,我们会有在项目服务启动的时候就去加载一些数据或做一些事情这样的需求。

为了解决这样的问题,Spring Boot 为我们提供了一个方法,通过实现接口 CommandLineRunner 来实现。

很简单,只需要一个类就可以,无需其他配置。

创建实现接口 com.kfit.runner.CommandLineRunner 的类,具体实现代码如下:

import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
  
/**
 * 服务启动执行
 *
 */
@Component
public class MyStartupRunner1 implements CommandLineRunner {
  
    @Override
    public void run(String... args) throws Exception {
        System.out.println(">>>>>>>>>>>>>>>服务启动执行,执行加载数据等操作<<<<<<<<<<<<<");
    }
  
}

Spring Boot应用程序在启动后,会遍历CommandLineRunner接口的实例并运行它们的run方法。也可以利用@Order注解(或者实现Order接口)来规定所有CommandLineRunner实例的运行顺序。

如下我们使用@Order 注解来定义执行顺序。

import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
  
/**
 * 服务启动执行
 *
 * 
 */
@Component
@Order(value=2)
public class MyStartupRunner1 implements CommandLineRunner {
  
    @Override
    public void run(String... args) throws Exception {
        System.out.println(">>>>>>>>>>>>>>>服务启动执行,执行加载数据等操作 xxxxx <<<<<<<<<<<<<");
    }
  
}
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;
  
/**
 * 服务启动执行
 *
 * 
 */
@Component
@Order(value=1)
public class MyStartupRunner2 implements CommandLineRunner {
  
    @Override
    publicvoid run(String... args) throws Exception {
        System.out.println(">>>>>>>>>>>>>>>服务启动执行,执行加载数据等操作 ****** <<<<<<<<<<<<<");
    }
  
}

启动程序后,控制台输出结果为:

>>>>>>>>>>>>>>>服务启动执行,执行加载数据等操作 ***** <<<<<<<<<<<<<
 
>>>>>>>>>>>>>>>服务启动执行,执行加载数据等操作 xxxxx <<<<<<<<<<<<<

根据控制台结果可判断,@Order 注解的执行优先级是按value值从小到大顺序。

@Override
    publicvoid run(String... args) throws Exception {
                System.out.println(Arrays.asList(args));
        System.out.println(">>>>>>>>>>>>>>>服务启动执行,执行加载数据等操作11111111<<<<<<<<<<<<<");
    }

这里的args就是程序启动的时候进行设置的:

SpringApplication.run(App.class, new String[]{“hello,”,“林峰”});

这里为了做演示,配置为固定值了,其实直接接收main中的args即可,那么在运行的时候,进行配置即可。

eclipse中给java应用传args参数的方法如下:

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

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

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

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

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

ApplicationRunner接口也可以实现上述功能,代码如下:

@Component  
@Order(value = 0)  
class StartupRunner2 implements CommandLineRunner{  
    @Override  
    public void run(String... strings) throws Exception {  
        System.err.println(">>服务启动执行,执行加载数据等操作<222222");  
    }  
}  
   
@Component  
@Order(value = -1)  
class StartupRunner3 implements ApplicationRunner {  
   
    @Override  
    public void run(ApplicationArguments applicationArguments) throws Exception {  
        System.err.println(">>服务启动执行,执行加载数据等操作<333333");  
    }  
}  
   
   
   
>>服务启动执行,执行加载数据等操作<333333  
>>服务启动执行,执行加载数据等操作<222222
相关标签: SpringBoot