spring中BeanPostProcessor之二：CommonAnnotationBeanPostProce
|
在上篇博客中分享了InstantiationAwareBeanPostProcessor接口中的四个方法，分别对其进行了详细的介绍，在文末留下了一个问题，那就是postProcessProperties方法，说到此方法是用来进行属性填充的，并且引出了CommonAnnotationBeanPostProcessor类。 一、概述CommonAnnotationBeanPostProcessor类在spring中是一个极其重要的类，它负责解析@Resource、@WebServiceRef、@EJB三个注解。这三个注解都是定义在javax.*包下的注解，属于java中的注解。既然要解析这三个属性，那么在CommonAnnotationBeanPostProcessor类中肯定要有这三个注解，下面看这段代码， static { try { @SuppressWarnings("unchecked") Class<? extends Annotation> clazz = (Class<? extends Annotation>) ClassUtils.forName("javax.xml.ws.WebServiceRef",CommonAnnotationBeanPostProcessor.class.getClassLoader()); webServiceRefClass = clazz; } catch (ClassNotFoundException ex) { webServiceRefClass = null; } ) ClassUtils.forName("javax.ejb.EJB",1)">.getClassLoader()); ejbRefClass = (ClassNotFoundException ex) { ejbRefClass = ; } //添加@Resource注解 resourceAnnotationTypes.add(Resource.); if (webServiceRefClass != ) { 上面是一个静态代码块，我们知道静态代码块在什么时候会执行，那就是在类初始化（如未加载则先加载）的时候，也就说在CommonAnnotationBeanPostProcessor类加载的时候就会执行上面的静态代码块，我们看静态代码块中的逻辑，可以看出就是向resourceAnnotationTypes中添加了三个注解，就是这个类要解析的注解所代表的接口。 在CommonAnnoatationBeanPostProcessor类中还有一个重要的属性即injectionMetaDataCache，这个属性会存储类中的被CommonAnnoatationBeanPostProcessor解析的字段或方法信息，也就是标注了三个属性的字段或方法的元信息。 二、详述1、方法概述下面看CommonAnnoatationBeanPostProcessor类中的方法，
上面是CommonAnnoatationBeanPostProcessor中比较重要的方法，有两个比较熟悉的方法，在前面已经分析过即postProcessBeforeInstantiation和postProcessAfterInstantiation方法。 @Override public Object postProcessBeforeInstantiation(Class<?> beanClass,String beanName) { return ; } 上面是postProcessBeforeInstantiation方法，该方法的返回值为null，即不会在bean实例化前产生一个代理对象。 public boolean postProcessAfterInstantiation(Object bean,1)">true; } 上面是postProcessAfterInstantiation方法，该方法的返回值为true，也就是说该类不会阻止属性的注入。 在CommonAnnoatationBeanPostProcessor中的postProcessProperties方法， public PropertyValues postProcessProperties(PropertyValues pvs,Object bean,String beanName) { InjectionMetadata metadata = findResourceMetadata(beanName,bean.getClass(),pvs); { metadata.inject(bean,beanName,pvs); } (Throwable ex) { throw new BeanCreationException(beanName,"Injection of resource dependencies failed",ex); } return pvs; } 先看下这个方法，今天这个方法不是主角。主角是下面这个方法， void postProcessMergedBeanDefinition(RootBeanDefinition beanDefinition,Class<?> beanType,1)">super.postProcessMergedBeanDefinition(beanDefinition,beanType,beanName); InjectionMetadata metadata = findResourceMetadata(beanName,); metadata.checkConfigMembers(beanDefinition); } 这个方法首先会调用父类的postProcessMergedBeanDefinition方法，然后调用findResourceMetadata方法。 CommonAnnoatationBeanPostProcessor的父类是InitDestoryAnnoatationBeanPostProcessor，在InitDestoryAnnoatationBeanPostProcessor类中postProcessMergedBeanDefinition方法主要完成的解析和初始化（@PostConstruct）和销毁（@PreDestory）相关的注解并缓存到lifecycleMetadataCache中。 CommonAnnoatationBeanPostProcessor的findResourceMetadata方法主要完成的是解析@Resource、@WebServiceRef、@EJB三个注解并缓存到injectionMetadataCache中。今天重点分析CommonAnnoatationBeanPostProcessor的postProcessMergedBeanDefinition方法。 2、postProcessMergedBeanDefinition方法此方法是在什么时候调用的，从spring的源码中可以找到如下，在doCreateBean方法中，下面仅贴出部分代码， synchronized (mbd.postProcessingLock) { if (!mbd.postProcessed) { { //2、调用beanPostProcessor即bean后置处理器MergedBeanDefinitionPostProcessor，执行其postProcessMergedBeanDefinition方法 applyMergedBeanDefinitionPostProcessors(mbd,beanName); } (Throwable ex) { new BeanCreationException(mbd.getResourceDescription(),"Post-processing of merged bean definition failed"; } } 上面的代码中调用了applyMergedBeanDefinitionPostProcessor方法，applyMergedBeanDefinitionPostProcessor方法如下， protected void applyMergedBeanDefinitionPostProcessors(RootBeanDefinition mbd,1)">for (BeanPostProcessor bp : getBeanPostProcessors()) { if (bp instanceof MergedBeanDefinitionPostProcessor) { MergedBeanDefinitionPostProcessor bdp = (MergedBeanDefinitionPostProcessor) bp; bdp.postProcessMergedBeanDefinition(mbd,beanName); } } } 这里会循环beanFactory中的beanPostProcessor，这里肯定会有CommonAnnoatationBeanPostProcessor后置处理器，那么就会调用到其postProcessMergedBeanDefinition方法。 postProcessMergedBeanDefinition方法如下， );
metadata.checkConfigMembers(beanDefinition);
}
上面已经提到先不分析其父类，那么重点分析的就是findResourceMetadata和checkConfigMembers。findResourceMetadata如下 private InjectionMetadata findResourceMetadata(String beanName,1)">final Class<?> clazz,@Nullable PropertyValues pvs) { Fall back to class name as cache key,for backwards compatibility with custom callers. String cacheKey = (StringUtils.hasLength(beanName) ? beanName : clazz.getName()); Quick check on the concurrent map first,with minimal locking. InjectionMetadata metadata = this.injectionMetadataCache.get(cacheKey); if (InjectionMetadata.needsRefresh(metadata,clazz)) { synchronized (.injectionMetadataCache) { metadata = .injectionMetadataCache.get(cacheKey); if (metadata != ) { metadata.clear(pvs); } 下面看buildResourceMetadata方法， private InjectionMetadata buildResourceMetadata( clazz) { AnnotationUtils.isCandidateClass(clazz,resourceAnnotationTypes)) { InjectionMetadata.EMPTY; } List<InjectionMetadata.InjectedElement> elements = new ArrayList<>(); Class<?> targetClass = clazz; do { final List<InjectionMetadata.InjectedElement> currElements = (); //判断属性上是否有注解 ReflectionUtils.doWithLocalFields(targetClass,field -> { null && field.isAnnotationPresent(webServiceRefClass)) { (Modifier.isStatic(field.getModifiers())) { new IllegalStateException("@WebServiceRef annotation is not supported on static fields"); } currElements.add(new WebServiceRefElement(field,field,1)">)); } else field.isAnnotationPresent(ejbRefClass)) { new IllegalStateException("@EJB annotation is not supported on static fields"new EjbRefElement(field,1)">if (field.isAnnotationPresent(Resource.)) { new IllegalStateException("@Resource annotation is not supported on static fields"); } .ignoredResourceTypes.contains(field.getType().getName())) { currElements.add(new ResourceElement(field,1)">)); } } }); //判断方法上是否有注解 ReflectionUtils.doWithLocalMethods(targetClass,method -> { Method bridgedMethod = BridgeMethodResolver.findBridgedMethod(method); BridgeMethodResolver.isVisibilityBridgeMethodPair(method,bridgedMethod)) { ; } (method.equals(ClassUtils.getMostSpecificMethod(method,clazz))) { bridgedMethod.isAnnotationPresent(webServiceRefClass)) { (Modifier.isStatic(method.getModifiers())) { new IllegalStateException("@WebServiceRef annotation is not supported on static methods"); } if (method.getParameterCount() != 1) { new IllegalStateException("@WebServiceRef annotation requires a single-arg method: " + method); } PropertyDescriptor pd = BeanUtils.findPropertyForMethod(bridgedMethod,clazz); currElements.add( WebServiceRefElement(method,bridgedMethod,pd)); } bridgedMethod.isAnnotationPresent(ejbRefClass)) { new IllegalStateException("@EJB annotation is not supported on static methods"new IllegalStateException("@EJB annotation requires a single-arg method: " + EjbRefElement(method,1)">if (bridgedMethod.isAnnotationPresent(Resource.)) { new IllegalStateException("@Resource annotation is not supported on static methods"); } Class<?>[] paramTypes = method.getParameterTypes(); if (paramTypes.length != 1new IllegalStateException("@Resource annotation requires a single-arg method: " + method); } this.ignoredResourceTypes.contains(paramTypes[0].getName())) { PropertyDescriptor pd = ResourceElement(method,pd)); } } } }); elements.addAll(0 targetClass.getSuperclass(); } while (targetClass != null && targetClass != Object.); InjectionMetadata.forElements(elements,clazz); } 此方法较长，不过主要完成了两件事，分别从属性和方法上判断是否有@Resource、@WebServiceRef、@EJB注解，如果存在则放入injectionMetadataCache中。从这里还可以看出这三个注解可以用在方法和属性上。 到这里CommonAnnoatationBeanPostProcessor类的postProcssMergedBeanDefinition方法已经分析完毕，其作用（不包含其父类的作用）分别从解析类中的@Resource、@WebServiceRef、@EJB三个注解，并放入injectionMetadataCache缓存中，以便postProcessProperties方法使用。 三、使用场景从上面的分析中已经知道了CommonAnnoatationBeanProcessor的postProcessMergedBeanDefinition方法的作用。就是解析@Resource、@WebServiceRef、@EJB三个注解并缓存元数据信息。下面会分析如何使用缓存在injectionMetadataCache中的信息，也就是postProcessPerties方法的逻辑。 ? 原创不易，有不正之处欢迎指正。 （编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |
