SpringBoot项目启动后执行指定方法的四种实现-Toy模板网

这篇具有很好参考价值的文章主要介绍了SpringBoot项目启动后执行指定方法的四种实现。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

今日的好天气
SpringBoot项目启动后执行指定方法的四种实现

距离上一次更新帖子已经过了很久很久，久到我也不知道我在搞什么飞机。
国庆节第一天终于搬到了新家，最近量子纠缠比较火，冬天也在路上，匆匆又一年。

方式一：方法上添加注解@PostConstruct

1、定义

@PostConstruct是Java自带的注解，在方法上加该注解会在项目启动的时候执行该方法，也可以理解为在spring容器初始化的时候执行该方法。可作为一些数据的常规化加载，比如数据字典之类的。

从Java EE5规范开始，Servlet中增加了两个影响Servlet生命周期的注解，@PostConstruct和@PreDestroy，这两个注解被用来修饰一个非静态的void()方法。

2、@PostConstruct和@Autowired、构造函数的执行顺序

构造方法 > @Autowired > @PostConstruct

3、@PostConstruct使用时注意事项：

被注解方法不得有任何参数；
被注解方法返回值为void；
被注解方法不得抛出已检查异常；
被注解方法需是非静态方法；
此方法只会被执行一次；
耗时长的逻辑可放到独立线程中执行，减少Spring容器初始化时间

SpringBoot中Bean的加载过程，简单点说就是SpringBoot会把标记了Bean相关注解（例如@Component、@Service、@Repository等）的类或接口自动初始化全局的单一实例，如果标记了初始化顺序会按照用户标记的顺序，否则按照默认顺序初始化。在初始化的过程中，执行完一个Bean的构造方法后会执行该Bean的@PostConstruct方法（如果有），然后初始化下一个Bean。

那么：如果@PostConstruct方法内的逻辑处理时间较长，就会增加SpringBoot应用初始化Bean的时间，进而增加应用启动的时间。因为只有在Bean初始化完成后，SpringBoot应用才会打开端口提供服务，所以在此之前，应用不可访问。

4、几点建议

所以，如果应用有一些初始化操作，有以下几点建议：

轻量的逻辑可放在Bean的@PostConstruct方法中
耗时长的逻辑如果放在@PostConstruct方法中，可使用独立线程执行
初始化操作放在CommandLineRunner或ApplicationRunner的实现组件中（马上讲到）

方式二：实现CommandLineRunner接口

1、定义

CommandLineRunner接口是在容器启动成功后的最后一步回调（类似开机自启动）。
可以通过@Order注解（属性指定数字越小表示优先级越高）或者Ordered接口来控制执行顺序。

2、使用

实现CommandLineRunner接口然后在run方法里面调用需要调用的方法即可，好处是方法执行时，项目已经初始化完毕，是可以正常提供服务的。（与@PostConstruct区别之一）

同时该方法也可以接受参数，可以根据项目启动时: java -jar xxx.jar arg1 arg2 arg3 传入的参数进行一些处理。

@Component
@Order(value = 1)
public class StartRunnerOne implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println(">>>服务启动第一个开始执行的任务<<<<");
    }
}

@Component
@Order(value = 2)
public class StartupRunnerTwo implements CommandLineRunner {

    @Override
    public void run(String... args) throws Exception {
        System.out.println(">>>>服务第二顺序启动执行<<<<");
    }
}

方式三：实现ApplicationRunner接口

1、定义

ApplicationRunner接口是在容器启动成功后的最后一步回调（类似开机自启动）。

实现ApplicationRunner接口和实现CommandLineRunner接口基本是一样的，唯一的不同是启动时传参的格式，CommandLineRunner对于参数格式没有任何限制，更加松散一些，ApplicationRunner接口参数格式必须是：–key=value。

可以通过@Order注解（属性指定数字越小表示优先级越高）或者Ordered接口来控制执行顺序。

2、使用

@Component  //此类一定要交给spring管理
public class ConsumerRunner implements ApplicationRunner{
	@Override
	public void run(ApplicationArgumers args) throws Exception{
		//代码
		System.out.println("需要在springBoot项目启动时执行的代码---");
	}
}

方式四：实现ApplicationListener接口

1、定义

实现接口ApplicationListener方式和实现ApplicationRunner，CommandLineRunner接口都不影响服务，都可以正常提供服务，注意监听的事件，通常是ApplicationStartedEvent 或者ApplicationReadyEvent，其他的事件可能无法注入bean。

2、使用

@Component
public class ApplicationListenerImpl implements ApplicationListener<ApplicationStartedEvent> {
    @Override
    public void onApplicationEvent(ApplicationStartedEvent event) {
        System.out.println("listener");
    }
}

四种方式的执行顺序如何？

注解方式@PostConstruct 始终最先执行
如果监听的是ApplicationStartedEvent 事件，则一定会在CommandLineRunner和ApplicationRunner 之前执行。
如果监听的是ApplicationReadyEvent 事件，则一定会在CommandLineRunner和ApplicationRunner 之后执行。
CommandLineRunner和ApplicationRunner 默认是ApplicationRunner先执行，如果双方指定了@Order 则按照@Order的大小顺序执行，数字越小优先级越高。