Spring SmartLifecycle 在容器所有bean加载和初始化完毕执行

在使用Spring开发时,我们都知道,所有bean都交给Spring容器来统一管理,其中包括每一个bean的加载和初始化。
有时候我们需要在Spring加载和初始化所有bean后,接着执行一些任务或者启动需要的异步服务,这样我们可以使用 SmartLifecycle 来做到。

这个和 @PostConstruct、@PreDestroy 的bean的初始化和销毁方法不同,Bean生命周期级别和容器生命周期级别在应用场景上是有区别的。

SmartLifecycle 是一个接口。当Spring容器加载所有bean并完成初始化之后,会接着回调实现该接口的类中对应的方法(start()方法)。
如下是一个实例:
我在对应的方法上注上了明确的说明,注意看一下。

package com.shanhy.sboot;

import org.springframework.context.SmartLifecycle;
import org.springframework.stereotype.Component;

/**
 * SmartLifecycle测试
 *
 * @author 单红宇(CSDN CATOOP)
 * @create 2017年5月6日
 */
@Component
public class TestSmartLifecycle implements SmartLifecycle {
	
	private boolean isRunning = false;

	/**
	 * 1. 我们主要在该方法中启动任务或者其他异步服务,比如开启MQ接收消息<br/>
	 * 2. 当上下文被刷新(所有对象已被实例化和初始化之后)时,将调用该方法,默认生命周期处理器将检查每个SmartLifecycle对象的isAutoStartup()方法返回的布尔值。
	 * 如果为“true”,则该方法会被调用,而不是等待显式调用自己的start()方法。
	 */
	@Override
	public void start() {
		System.out.println("start");
		
		// 执行完其他业务后,可以修改 isRunning = true
		isRunning = true;
	}

	/**
	 * 如果工程中有多个实现接口SmartLifecycle的类,则这些类的start的执行顺序按getPhase方法返回值从小到大执行。<br/>
	 * 例如:1比2先执行,-1比0先执行。 stop方法的执行顺序则相反,getPhase返回值较大类的stop方法先被调用,小的后被调用。
	 */
	@Override
	public int getPhase() {
		// 默认为0
		return 0;
	}

	/**
	 * 根据该方法的返回值决定是否执行start方法。<br/> 
	 * 返回true时start方法会被自动执行,返回false则不会。
	 */
	@Override
	public boolean isAutoStartup() {
		// 默认为false
		return true;
	}

	/**
	 * 1. 只有该方法返回false时,start方法才会被执行。<br/>
	 * 2. 只有该方法返回true时,stop(Runnable callback)或stop()方法才会被执行。
	 */
	@Override
	public boolean isRunning() {
		// 默认返回false
		return isRunning;
	}

	/**
	 * SmartLifecycle子类的才有的方法,当isRunning方法返回true时,该方法才会被调用。
	 */
	@Override
	public void stop(Runnable callback) {
		System.out.println("stop(Runnable)");
		
		// 如果你让isRunning返回true,需要执行stop这个方法,那么就不要忘记调用callback.run()。
		// 否则在你程序退出时,Spring的DefaultLifecycleProcessor会认为你这个TestSmartLifecycle没有stop完成,程序会一直卡着结束不了,等待一定时间(默认超时时间30秒)后才会自动结束。
		// PS:如果你想修改这个默认超时时间,可以按下面思路做,当然下面代码是springmvc配置文件形式的参考,在SpringBoot中自然不是配置xml来完成,这里只是提供一种思路。
		// <bean id="lifecycleProcessor" class="org.springframework.context.support.DefaultLifecycleProcessor">
	    // 		<!-- timeout value in milliseconds -->
		// 		<property name="timeoutPerShutdownPhase" value="10000"/>
		// </bean>
		callback.run();
		
		isRunning = false;
	}

	/**
	 * 接口Lifecycle的子类的方法,只有非SmartLifecycle的子类才会执行该方法。<br/>
	 * 1. 该方法只对直接实现接口Lifecycle的类才起作用,对实现SmartLifecycle接口的类无效。<br/>
	 * 2. 方法stop()和方法stop(Runnable callback)的区别只在于,后者是SmartLifecycle子类的专属。
	 */
	@Override
	public void stop() {
		System.out.println("stop");
		
		isRunning = false;
	}

}

  • 8
    点赞
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 3
    评论
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

catoop

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值