1. 程式人生 > 程式設計 >Spring Bean 方法自動觸發的N種方式

Spring Bean 方法自動觸發的N種方式

有時候我們需要在系統啟動後自動執行一些初始化動作,如載入自定義的資源,啟動業務相關定時器,或是在bean初始化後執行一些其他的註冊動作。這裡面有個核心的要素就是方法的執行時機,總結來講spring裡面有兩大類的方法執行時機:

  1. 生命週期回撥觸發。
  2. spring 事件觸發。

通過生命週期回撥觸發

spring官網中的有對生命週期回撥的總結了初始化回撥的三種方式:

  1. Methods annotated with @PostConstruct
  2. afterPropertiesSet() as defined by the InitializingBean callback interface
  3. A custom configured init()
    method,通常用在xml配置中,在bean標籤中配置一個init-method實現

對應的登出回撥的三種方式:

  1. Methods annotated with @PreDestroy
  2. destroy() as defined by the DisposableBean callback interface
  3. A custom configured destroy() method,通常用在xml配置中,在bean標籤中配置一個destroy-method實現

這三種方式的執行時機如上述的順序。

PostConstruct的執行時機

afterPropertiesSet的執行時機

afterPropertiesSet是在AbstractAutowireCapableBeanFactoryinitializeBean中呼叫的,也就是bean的例項化流程中的初始化bean的時候,這個時候spring已經對bean完成了代理、依賴注入,開始執行一些初始化方法。

具體執行的方法如下,注意啟動的invokeInitMethods,就是呼叫afterPropertiesSet的入口,這個方法的執行時機是後置處理器執行postProcessBeforeInitializationapplyBeanPostProcessorsAfterInitialization之間。

protected
Object initializeBean(final String beanName,final Object bean,@Nullable RootBeanDefinition mbd)
{ if (System.getSecurityManager() != null) { AccessController.doPrivileged((PrivilegedAction<Object>) () -> { invokeAwareMethods(beanName,bean); return null; },getAccessControlContext()); } else { invokeAwareMethods(beanName,bean); } Object wrappedBean = bean; if (mbd == null || !mbd.isSynthetic()) { wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean,beanName); } try { invokeInitMethods(beanName,wrappedBean,mbd); } catch (Throwable ex) { throw new BeanCreationException( (mbd != null ? mbd.getResourceDescription() : null),beanName,"Invocation of init method failed",ex); } if (mbd == null || !mbd.isSynthetic()) { wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean,beanName); } return wrappedBean; } 複製程式碼

再看看invokeInitMethods的具體實現

protected void invokeInitMethods(String beanName,final Object bean,@Nullable RootBeanDefinition mbd)
			throws Throwable {

		boolean isInitializingBean = (bean instanceof InitializingBean);
		if (isInitializingBean && (mbd == null || !mbd.isExternallyManagedInitMethod("afterPropertiesSet"))) {
			if (System.getSecurityManager() != null) {
				try {
					AccessController.doPrivileged((PrivilegedExceptionAction<Object>) () -> {
						((InitializingBean) bean).afterPropertiesSet();
						return null;
					},getAccessControlContext());
				}
				catch (PrivilegedActionException pae) {
					throw pae.getException();
				}
			}
			else {
				((InitializingBean) bean).afterPropertiesSet();
			}
		}
	}
複製程式碼

通過spring事件來觸發

這種觸發方式是通過使用@EventListener註解來監聽spring釋出的事件,收到事件後執行某些業務操作。比如希望spring容器初始化完成後才開始我們的業務邏輯,如下是一個程式碼示例:

@EventListener(classes = ContextRefreshedEvent.class)
public void enableSchedule() {  
    this.scheduleFlag = true;
}
複製程式碼

spring官網的1.15.2 standard and custom events 中提到了spring的內建事件,詳細介紹如下:

ontextRefreshedEvent Published when the ApplicationContext is initialized or refreshed (for example,by using the refresh() method on the ConfigurableApplicationContext interface). Here,“initialized” means that all beans are loaded,post-processor beans are detected and activated,singletons are pre-instantiated,and the ApplicationContext object is ready for use. As long as the context has not been closed,a refresh can be triggered multiple times,provided that the chosen ApplicationContext actually supports such “hot” refreshes. For example,XmlWebApplicationContext supports hot refreshes,but GenericApplicationContext does not.
ContextStartedEvent Published when the ApplicationContext is started by using the start() method on the ConfigurableApplicationContext interface. Here,“started” means that all Lifecycle beans receive an explicit start signal. Typically,this signal is used to restart beans after an explicit stop,but it may also be used to start components that have not been configured for autostart (for example,components that have not already started on initialization).
ContextStoppedEvent Published when the ApplicationContext is stopped by using the stop() method on the ConfigurableApplicationContext interface. Here,“stopped” means that all Lifecycle beans receive an explicit stop signal. A stopped context may be restarted through a start() call.
ContextClosedEvent Published when the ApplicationContext is being closed by using the close() method on the ConfigurableApplicationContext interface or via a JVM shutdown hook. Here,"closed" means that all singleton beans will be destroyed. Once the context is closed,it reaches its end of life and cannot be refreshed or restarted.
RequestHandledEvent A web-specific event telling all beans that an HTTP request has been serviced. This event is published after the request is complete. This event is only applicable to web applications that use Spring’s DispatcherServlet.
ServletRequestHandledEvent A subclass of RequestHandledEvent that adds Servlet-specific context information.

spring應用上下文啟動事件——ontextRefreshedEvent

這個事件是在AbstractApplicationContext#finishRefresh方法中執行,執行到這裡的時候整個spring容器的初始化、例項化(單例)已經完成,具體程式碼如下:

	protected void finishRefresh() {
		......

		// Publish the final event.
		publishEvent(new ContextRefreshedEvent(this));

		// Participate in LiveBeansView MBean,if active.
		LiveBeansView.registerApplicationContext(this);
	}
複製程式碼

如果應用系統中,需要在容器初始化完成後(對應用bean有依賴)立即執行某些操作,可以監聽這個事件,絕對不會出現依賴的bean未初始化的問題。