发的多财经网
@PostConstruct 注解源码分析
迪丽瓦拉
2024-05-21 13:11:36
0次

说明

  1. 本文基于 jdk 8, spring-framework 5.2.x 编写。
  2. @author JellyfishMIX - github / blog.jellyfishmix.com
  3. LICENSE GPL-2.0

机制

@PostConstruct 注解加在一个 bean 的方法上，当此 bean 被 spring-ioc 初始化时，自动调用此方法。注意，此类的实例需要作为 bean 交由 spring-ioc 管理时，注解才能生效。

public Object OneBean {@PostConstructpublic void init() {// doSomething}
}

实现原理是借助了 BeanPostProcessor 的机制，具体地说，是 InitDestroyAnnotationBeanPostProcessor。

BeanPostProcessor 的调用时机

org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#initializeBean

  1. spring-ioc 在创建 并初始化 bean 时，AbstractAutowireCapableBeanFactory#doCreateBean -> #initializeBean 方法中，执行 invokeInitMethods 方法，调用 bean 的 init 方法及此阶段相关生命周期函数来初始化 bean。

  2. invokeInitMethods 方法执行之前和之后，调用了 BeanPostProcessor 的 postProcessBeforeInitialization 方法，postProcessAfterInitialization 方法。

	/*** 初始化 bean*/protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) {// invokeAwareMethods 方法，对特殊的 bean 进行处理: 实现了 Aware, BeanClassLoaderAware, BeanFactoryAware 等接口的 bean 的处理。if (System.getSecurityManager() != null) {AccessController.doPrivileged((PrivilegedAction) () -> {invokeAwareMethods(beanName, bean);return null;}, getAccessControlContext());}else {invokeAwareMethods(beanName, bean);}Object wrappedBean = bean;if (mbd == null || !mbd.isSynthetic()) {// 在初始化 bean 之前，调用 BeanPostProcessor#postProcessBeforeInitialization 方法，bean 的生命周期函数wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);}try {// 调用 bean 的 init 方法及此阶段相关生命周期函数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()) {// 在初始化 bean 之后，调用 BeanPostProcessor#postProcessAfterInitialization 方法，bean 的生命周期函数wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);}// 返回 wrappedBeanreturn wrappedBean;}@Overridepublic Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName)throws BeansException {Object result = existingBean;for (BeanPostProcessor processor : getBeanPostProcessors()) {Object current = processor.postProcessBeforeInitialization(result, beanName);if (current == null) {return result;}result = current;}return result;}@Overridepublic Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName)throws BeansException {Object result = existingBean;for (BeanPostProcessor processor : getBeanPostProcessors()) {Object current = processor.postProcessAfterInitialization(result, beanName);if (current == null) {return result;}result = current;}return result;}
 

InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization 方法–实现 BeanPostProcessor 的生命周期方法
 

org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor#postProcessBeforeInitialization
 

实现 BeanPostProcessor 的生命周期方法，在目标 bean 初始化前交由当前 BeanPostProcessor 做处理。
 

  1. 获取 bean 类的生命周期元数据。
  2. 调用元数据的初始化方法。
 

public class InitDestroyAnnotationBeanPostProcessor implements DestructionAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, PriorityOrdered, Serializable {@Overridepublic Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {// 获取 bean 类的生命周期元数据LifecycleMetadata metadata = findLifecycleMetadata(bean.getClass());try {// 调用元数据的初始化方法metadata.invokeInitMethods(bean, beanName);}catch (InvocationTargetException ex) {throw new BeanCreationException(beanName, "Invocation of init method failed", ex.getTargetException());}catch (Throwable ex) {throw new BeanCreationException(beanName, "Failed to invoke init method", ex);}return bean;}
}

 

InitDestroyAnnotationBeanPostProcessor#findLifecycleMetadata 方法–获取 bean 类的生命周期元数据
 

org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor#findLifecycleMetadata
 

获取 bean 类的生命周期元数据。
 

  1. 生命周期元数据缓存 map，如果为空则创建。
  2. 双检锁创建当前 clazz 的生命周期元数据。
 

	private LifecycleMetadata findLifecycleMetadata(Class clazz) {// 生命周期元数据缓存 map 如果为空则创建if (this.lifecycleMetadataCache == null) {// Happens after deserialization, during destruction...return buildLifecycleMetadata(clazz);}// Quick check on the concurrent map first, with minimal locking.// 双检锁创建当前 clazz 的生命周期元数据LifecycleMetadata metadata = this.lifecycleMetadataCache.get(clazz);if (metadata == null) {synchronized (this.lifecycleMetadataCache) {metadata = this.lifecycleMetadataCache.get(clazz);if (metadata == null) {metadata = buildLifecycleMetadata(clazz);this.lifecycleMetadataCache.put(clazz, metadata);}return metadata;}}return metadata;}

 

InitDestroyAnnotationBeanPostProcessor#buildLifecycleMetadata 方法 – 创建目标 clazz 的生命周期元数据
 

org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor#buildLifecycleMetadata
 

创建目标 clazz 的生命周期元数据。
 

  1. 声明初始化方法集合和销毁方法集合。
  2. 收集目标 clazz 的本地方法(本地方法即不包含从父类继承的) 
    1. 收集 init 类型注解标记的方法，至初始化方法集合中。收集 destroy 类型注解标记的方法，至初销毁方法集合中。
    2. 遍历目标 clazz 的父类，重复上述收集过程。
     
 

public class InitDestroyAnnotationBeanPostProcessor implements DestructionAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, PriorityOrdered, Serializable {/*** 创建目标 clazz 的生命周期元数据*/private LifecycleMetadata buildLifecycleMetadata(final Class clazz) {if (!AnnotationUtils.isCandidateClass(clazz, Arrays.asList(this.initAnnotationType, this.destroyAnnotationType))) {return this.emptyLifecycleMetadata;}// 初始化方法集合List initMethods = new ArrayList<>();// 销毁方法集合List destroyMethods = new ArrayList<>();Class targetClass = clazz;do {// 表示 lambda 中对象不可变，为了代码规整final List currInitMethods = new ArrayList<>();final List currDestroyMethods = new ArrayList<>();// 收集目标 clazz 的本地方法(本地方法即不包含从父类继承的)ReflectionUtils.doWithLocalMethods(targetClass, method -> {// 收集 init 类型注解标记的方法，至初始化方法集合中if (this.initAnnotationType != null && method.isAnnotationPresent(this.initAnnotationType)) {LifecycleElement element = new LifecycleElement(method);currInitMethods.add(element);if (logger.isTraceEnabled()) {logger.trace("Found init method on class [" + clazz.getName() + "]: " + method);}}// 收集 destroy 类型注解标记的方法，至初销毁方法集合中if (this.destroyAnnotationType != null && method.isAnnotationPresent(this.destroyAnnotationType)) {currDestroyMethods.add(new LifecycleElement(method));if (logger.isTraceEnabled()) {logger.trace("Found destroy method on class [" + clazz.getName() + "]: " + method);}}});initMethods.addAll(0, currInitMethods);destroyMethods.addAll(currDestroyMethods);targetClass = targetClass.getSuperclass();// 遍历目标 clazz 的父类，重复上述收集过程} while (targetClass != null && targetClass != Object.class);return (initMethods.isEmpty() && destroyMethods.isEmpty() ? this.emptyLifecycleMetadata :new LifecycleMetadata(clazz, initMethods, destroyMethods));}
}public abstract class ReflectionUtils {/*** spring 反射工具类的方法，遍历 clazz 所有本地方法作为入参，触发回调函数。*/public static void doWithLocalMethods(Class clazz, MethodCallback mc) {Method[] methods = getDeclaredMethods(clazz, false);for (Method method : methods) {try {mc.doWith(method);}catch (IllegalAccessException ex) {throw new IllegalStateException("Not allowed to access method '" + method.getName() + "': " + ex);}}}
}

 

InitDestroyAnnotationBeanPostProcessor 中使用的 initAnnotationType 和 destroyAnnotationType 成员变量，由子类指定具体值(具体注解)，在子类 CommonAnnotationBeanPostProcessor 中被赋值为 JSR-250 规范提供的 javax.annotation.PostConstruct 和 javax.annotation.PreDestroy。如果使用自定义的 InitDestroyAnnotationBeanPostProcessor 子类，也可以赋值自定义的注解。
 

public class InitDestroyAnnotationBeanPostProcessor implements DestructionAwareBeanPostProcessor, MergedBeanDefinitionPostProcessor, PriorityOrdered, Serializable {@Nullableprivate Class initAnnotationType;@Nullableprivate Class destroyAnnotationType;
}public class CommonAnnotationBeanPostProcessor extends InitDestroyAnnotationBeanPostProcessor implements InstantiationAwareBeanPostProcessor, BeanFactoryAware, Serializable {public CommonAnnotationBeanPostProcessor() {setOrder(Ordered.LOWEST_PRECEDENCE - 3);setInitAnnotationType(PostConstruct.class);setDestroyAnnotationType(PreDestroy.class);ignoreResourceType("javax.xml.ws.WebServiceContext");}
}

 

LifecycleMetadata#invokeInitMethods 方法 – 调用生命周期元数据的初始化方法
 

org.springframework.beans.factory.annotation.InitDestroyAnnotationBeanPostProcessor.LifecycleMetadata#invokeInitMethods
 

遍历 clazz 生命周期元数据的初始化方法并调用。
 

		/*** 调用生命周期元数据的初始化方法*/public void invokeInitMethods(Object target, String beanName) throws Throwable {Collection checkedInitMethods = this.checkedInitMethods;Collection initMethodsToIterate =(checkedInitMethods != null ? checkedInitMethods : this.initMethods);if (!initMethodsToIterate.isEmpty()) {// 遍历 clazz 生命周期元数据的初始化方法for (LifecycleElement element : initMethodsToIterate) {if (logger.isTraceEnabled()) {logger.trace("Invoking init method on bean '" + beanName + "': " + element.getMethod());}// 调用实际方法element.invoke(target);}}}

                
            
            
            

                
                
                词库加载错误:未能找到文件“E:\highferrum_mysql\Configuration\Dict_Stopwords.txt”。
                            

            

                

                    上一篇：JAVA01_30学习总结(Spring入门)

                

                

                    下一篇：Linux移植加载内核、设备树、根文件系统的几种方法总结（TFTP、nfs、SD卡、eMMC）                

            

            
            

                
                
相关内容

                
            

            

            
            

                
            



        
        
    
    

    
    

        
        

            
            

                
                

                    
                    

                        
                        热门资讯
                        
                    

                    
                

                
            

            
            
            


                                
                

                    
                    

                        

                    

                    
                    
                    

                        国信期货20230404：金银...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        4月21日外汇交易提醒：美元下...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        CWG资讯：美元周四连续第四个...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        闫瑞祥：美指承压下跌，欧美支撑...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        外汇交易提醒：美联储鸽派加息，...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        闫瑞祥：美指关注昨低得失，欧美...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        6月16日外汇交易提醒：美联储...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        7月20日机构对金融市场观点汇...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        田洪良：6月28日主要货币短线...
                        
                    

                    
                

                                
                

                    
                    

                        

                    

                    
                    
                    

                        一张图：6月13日黄金白银、原...