解析BeanPostProcessor系列之CommonAnnotationBeanPostProcessor

BeanPostProcessor是spring提供的一个扩展接口,通过定义的两个接口可以实现在初始化之前、之后对bean做一些修改,或者其他预处理,后处理等操作。

public interface BeanPostProcessor {

	/**
	 * Apply this {@code BeanPostProcessor} to the given new bean instance <i>before</i> any bean
	 * initialization callbacks (like InitializingBean's {@code afterPropertiesSet}
	 * or a custom init-method). The bean will already be populated with property values.
	 * The returned bean instance may be a wrapper around the original.
	 * <p>The default implementation returns the given {@code bean} as-is.
	 * @param bean the new bean instance
	 * @param beanName the name of the bean
	 * @return the bean instance to use, either the original or a wrapped one;
	 * if {@code null}, no subsequent BeanPostProcessors will be invoked
	 * @throws org.springframework.beans.BeansException in case of errors
	 * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
	 */
	@Nullable
	default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}

	/**
	 * Apply this {@code BeanPostProcessor} to the given new bean instance <i>after</i> any bean
	 * initialization callbacks (like InitializingBean's {@code afterPropertiesSet}
	 * or a custom init-method). The bean will already be populated with property values.
	 * The returned bean instance may be a wrapper around the original.
	 * <p>In case of a FactoryBean, this callback will be invoked for both the FactoryBean
	 * instance and the objects created by the FactoryBean (as of Spring 2.0). The
	 * post-processor can decide whether to apply to either the FactoryBean or created
	 * objects or both through corresponding {@code bean instanceof FactoryBean} checks.
	 * <p>This callback will also be invoked after a short-circuiting triggered by a
	 * {@link InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation} method,
	 * in contrast to all other {@code BeanPostProcessor} callbacks.
	 * <p>The default implementation returns the given {@code bean} as-is.
	 * @param bean the new bean instance
	 * @param beanName the name of the bean
	 * @return the bean instance to use, either the original or a wrapped one;
	 * if {@code null}, no subsequent BeanPostProcessors will be invoked
	 * @throws org.springframework.beans.BeansException in case of errors
	 * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
	 * @see org.springframework.beans.factory.FactoryBean
	 */
	@Nullable
	default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
		return bean;
	}

}

Spring自身在加载过程中,也利用了这个接口完成了一些操作,比如CommonAnnotationBeanPostProcessor处理@Resource注解,InitDestroyAnnotationBeanPostProcessor处理@PostConstruct、@PreDestroy注解,包括AOP的实现。

InitDestroyAnnotationBeanPostProcessor是CommonAnnotationBeanPostProcessor的父类

本文先了解一下几种内部的BeanPostProcessor是如何加载的?

refresh主流程方法,主要看registerBeanPostProcessors这个方法

	@Override
	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
			// Prepare this context for refreshing.
			prepareRefresh();

			// Tell the subclass to refresh the internal bean factory.
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

			// Prepare the bean factory for use in this context.
			prepareBeanFactory(beanFactory);

			try {
				// Allows post-processing of the bean factory in context subclasses.
				postProcessBeanFactory(beanFactory);

				// Invoke factory processors registered as beans in the context.
				invokeBeanFactoryPostProcessors(beanFactory);

				// Register bean processors that intercept bean creation.
				//注册bean processors
				registerBeanPostProcessors(beanFactory);

				// Initialize message source for this context.
				initMessageSource();

				// Initialize event multicaster for this context.
				initApplicationEventMulticaster();

				// Initialize other special beans in specific context subclasses.
				onRefresh();

				// Check for listener beans and register them.
				registerListeners();

				// Instantiate all remaining (non-lazy-init) singletons.
				finishBeanFactoryInitialization(beanFactory);

				// Last step: publish corresponding event.
				finishRefresh();
			}

			catch (BeansException ex) {
				if (logger.isWarnEnabled()) {
					logger.warn("Exception encountered during context initialization - " +
							"cancelling refresh attempt: " + ex);
				}

				// Destroy already created singletons to avoid dangling resources.
				destroyBeans();

				// Reset 'active' flag.
				cancelRefresh(ex);

				// Propagate exception to caller.
				throw ex;
			}

			finally {
				// Reset common introspection caches in Spring's core, since we
				// might not ever need metadata for singleton beans anymore...
				resetCommonCaches();
			}
		}
	}

在应用程序bean的任何实例化之前,按顺序实例化并注册所有BeanPostProcessor bean 。

	/**
	 * Instantiate and register all BeanPostProcessor beans,
	 * respecting explicit order if given.
	 * <p>Must be called before any instantiation of application beans.
	 */
	protected void registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory) {
		PostProcessorRegistrationDelegate.registerBeanPostProcessors(beanFactory, this);
	}
	public static void registerBeanPostProcessors(
			ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) {
		//从beanDefinitionNames里面获取所有实现了BeanPostProcessor接口的类,实际上一般就下面两个类
	//internalAutowiredAnnotationProcessor即AutowiredAnnotationBeanPostProcessor
	//internalCommonAnnotationProcessor即CommonAnnotationBeanPostProcessor
		String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);

		// Register BeanPostProcessorChecker that logs an info message when
		// a bean is created during BeanPostProcessor instantiation, i.e. when
		// a bean is not eligible for getting processed by all BeanPostProcessors.
		int beanProcessorTargetCount = beanFactory.getBeanPostProcessorCount() + 1 + postProcessorNames.length;
		beanFactory.addBeanPostProcessor(new BeanPostProcessorChecker(beanFactory, beanProcessorTargetCount));

		// Separate between BeanPostProcessors that implement PriorityOrdered,
		// Ordered, and the rest.
		List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
		List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
		List<String> orderedPostProcessorNames = new ArrayList<>();
		List<String> nonOrderedPostProcessorNames = new ArrayList<>();
		//遍历BeanPostProcessor的实现类
		for (String ppName : postProcessorNames) {
			if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
				//此处调用getBean就会触发实例化,所以BeanPostProcessor的实现类优先实例化
				BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
				priorityOrderedPostProcessors.add(pp);
				if (pp instanceof MergedBeanDefinitionPostProcessor) {
					internalPostProcessors.add(pp);
				}
			}
			else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
				orderedPostProcessorNames.add(ppName);
			}
			else {
				nonOrderedPostProcessorNames.add(ppName);
			}
		}

		// First, register the BeanPostProcessors that implement PriorityOrdered.
		//按照顺序,注册BeanPostProcessors的实现类
		sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
		//注册到beanPostProcessors集合中
		registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);

		// Next, register the BeanPostProcessors that implement Ordered.
		List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size());
		for (String ppName : orderedPostProcessorNames) {
			BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
			orderedPostProcessors.add(pp);
			if (pp instanceof MergedBeanDefinitionPostProcessor) {
				internalPostProcessors.add(pp);
			}
		}
		sortPostProcessors(orderedPostProcessors, beanFactory);
		registerBeanPostProcessors(beanFactory, orderedPostProcessors);

		// Now, register all regular BeanPostProcessors.
		List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size());
		for (String ppName : nonOrderedPostProcessorNames) {
			BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
			nonOrderedPostProcessors.add(pp);
			if (pp instanceof MergedBeanDefinitionPostProcessor) {
				internalPostProcessors.add(pp);
			}
		}
		registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);

		// Finally, re-register all internal BeanPostProcessors.
		sortPostProcessors(internalPostProcessors, beanFactory);
		registerBeanPostProcessors(beanFactory, internalPostProcessors);

		// Re-register post-processor for detecting inner beans as ApplicationListeners,
		// moving it to the end of the processor chain (for picking up proxies etc).
		beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
	}

Spring加载ConfigurationClassPostProcessor等其他内部处理类的流程,这篇文章介绍了ConfigurationClassPostProcessor等如何注册到beanDefinitionNames中的。。。

registerBeanPostProcessors

	private static void registerBeanPostProcessors(
			ConfigurableListableBeanFactory beanFactory, List<BeanPostProcessor> postProcessors) {

		for (BeanPostProcessor postProcessor : postProcessors) {
			beanFactory.addBeanPostProcessor(postProcessor);
		}
	}

添加到beanPostProcessors集合中

	@Override
	public void addBeanPostProcessor(BeanPostProcessor beanPostProcessor) {
		Assert.notNull(beanPostProcessor, "BeanPostProcessor must not be null");
		// Remove from old position, if any
		this.beanPostProcessors.remove(beanPostProcessor);
		// Track whether it is instantiation/destruction aware
		if (beanPostProcessor instanceof InstantiationAwareBeanPostProcessor) {
			this.hasInstantiationAwareBeanPostProcessors = true;
		}
		if (beanPostProcessor instanceof DestructionAwareBeanPostProcessor) {
			this.hasDestructionAwareBeanPostProcessors = true;
		}
		// Add to end of list
		this.beanPostProcessors.add(beanPostProcessor);
	}

在添加到beanPostProcessors集合之前,就通过调用getBean完成了实例化,之后要用到BeanPostProcessor的实现类,都会从beanPostProcessors这个集合中获取。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
### 回答1: BeanPostProcessorSpring框架中的一个接口,它允许开发人员在bean实例化和依赖注入之后对bean进行自定义处理。BeanPostProcessor接口有两个方法:postProcessBeforeInitialization和postProcessAfterInitialization。这两个方法分别在bean实例化之后和依赖注入之后被调用。 BeanPostProcessor的源码解析可以从以下几个方面入手: 1. BeanPostProcessor的实现类 Spring框架中有很多实现了BeanPostProcessor接口的类,比如AutowiredAnnotationBeanPostProcessorCommonAnnotationBeanPostProcessor等。这些类都是用来处理bean的,可以通过查看它们的源码来了解BeanPostProcessor的具体实现。 2. postProcessBeforeInitialization方法 postProcessBeforeInitialization方法在bean实例化之后、依赖注入之前被调用。这个方法可以用来修改bean的属性或者执行一些初始化操作。在源码中可以看到,postProcessBeforeInitialization方法的实现类似于以下代码: public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { // 执行一些初始化操作 return bean; } 3. postProcessAfterInitialization方法 postProcessAfterInitialization方法在bean实例化和依赖注入之后被调用。这个方法可以用来对bean进行一些后处理操作。在源码中可以看到,postProcessAfterInitialization方法的实现类似于以下代码: public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { // 对bean进行一些后处理操作 return bean; } 4. BeanPostProcessor的执行顺序 在Spring框架中,BeanPostProcessor的执行顺序是固定的。首先会执行所有实现了PriorityOrdered接口的BeanPostProcessorpostProcessBeforeInitialization方法,然后执行所有实现了Ordered接口的BeanPostProcessorpostProcessBeforeInitialization方法,最后执行所有其他的BeanPostProcessorpostProcessBeforeInitialization方法。在执行postProcessAfterInitialization方法时,执行顺序与执行postProcessBeforeInitialization方法时相同。 总之,BeanPostProcessorSpring框架中非常重要的一个接口,它允许开发人员对bean进行自定义处理。通过对BeanPostProcessor源码的分析,我们可以更好地理解它的实现原理和使用方法。 ### 回答2: BeanPostProcessorSpring框架的一个非常重要的组件。它可以在Bean的创建周期中对Bean进行一些处理,它提供了在初始化Bean之前和之后执行自定义逻辑的机会。本文将深入剖析BeanPostProcessor的源码实现及其作用。 1. BeanPostProcessor的接口: BeanPostProcessor是一个接口,定义了两个方法: (1)postProcessBeforeInitialization(Object bean, String beanName): 在初始化之前对Bean做一些操作。 (2)postProcessAfterInitialization(Object bean, String beanName): 在初始化之后对Bean做一些操作。 2. BeanPostProcessor的源码实现: 它是一个接口,BeanPostProcessor是一个在SpringBean加载过程中非常重要的组件,它主要负责Bean的实例化、属性赋值和初始化过程中提供额外的自定义处理逻辑。 BeanPostProcessor接口的定义如下: public interface BeanPostProcessor { Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException; Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException; } 在Spring IoC容器中,BeanPostProcessor的主要作用是在Bean实例化、属性赋值和初始化过程中提供额外的自定义处理逻辑。在创建Bean实例之后,Spring容器会遍历所有注册的BeanPostProcessor,调用它们的postProcessBeforeInitialization和postProcessAfterInitialization方法。 3. BeanPostProcessor的应用: (1)扩展Bean生命周期: 可以通过实现BeanPostProcessor接口来自定义对一个或者所有的Bean的初始化过程,可以在初始化之前或之后执行额外的逻辑。 (2)实现依赖注入: 可以通过实现BeanPostProcessor接口,来实现依赖注入。例如可以通过注解的方式,来实现自动为所有Bean中标注了特定注解的属性注入值。 (3)实现AOP: 可以通过Spring的AOP机制来实现AOP,而BeanPostProcessor是实现AOP的重要底层组件之一。 总之,BeanPostProcessorSpring框架中非常重要的一个组件,它提供了对Bean创建周期中的两个关键事件——初始化之前和初始化之后进行处理的机会。使用BeanPostProcessor可以实现很多功能,如扩展Bean的生命周期、实现依赖注入、实现AOP等,对于自定义框架和组件开发来说,非常有用。 ### 回答3: BeanPostProcessorSpring 框架中的一个扩展点,它允许我们在一个 bean 被实例化时或者在 bean 的初始化过程中修改 bean 的一些属性或者执行一些操作。本文将在源码层面上对 BeanPostProcessor 进行详细解析。 首先,我们需要了解 BeanPostProcessor 接口的定义: ```java public interface BeanPostProcessor { /** * 在 bean 的初始化之前执行,返回一个代理对象用来替换原始的 bean 对象。 * 在 Spring 内部,Spring 会在这个方法被调用时对当前 bean 对象进行代理, * 然后交给后续的 bean 处理流程处理。 * * @param bean 待初始化的 bean 对象 * @param beanName 当前 bean 对象的名称 * @return 可以替代原始 bean 对象的代理对象 * @throws BeansException 如果出现任何异常,将导致 bean 的初始化过程被中断。 */ @Nullable default Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { return bean; } /** * 在 bean 的初始化之后执行。这个方法在最终返回 bean 对象之前调用, * 因此在这里面进行的任何操作都可以生效,包括修改 bean 对象的属性值等等。 * * @param bean 待初始化的 bean 对象 * @param beanName 当前 bean 对象的名称 * @return 可以替代原始 bean 对象的代理对象 * @throws BeansException 如果出现任何异常,将导致 bean 的初始化过程被中断。 */ @Nullable default Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException { return bean; } } ``` 可以看到,BeanPostProcessor 接口中只定义了两个方法,分别在 bean 实例化前后执行。这两个方法都有一个相同的传参,即需要处理的 bean 和这个 bean 的名称。 然后我们看看 Spring 框架是如何调用 BeanPostProcessor 的实现类的。在 AbstractAutowireCapableBeanFactory 类中,有一个名为 applyBeanPostProcessorsAfterInitialization 的方法: ```java protected Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName) throws BeansException { Object result = existingBean; // 遍历所有的 BeanPostProcessor 实现类,依次执行 postProcessAfterInitialization 方法 for (BeanPostProcessor processor : getBeanPostProcessors()) { Object current = processor.postProcessAfterInitialization(result, beanName); if (current == null) { return result; } result = current; } return result; } ``` 在这个方法中,Spring 会遍历所有的 BeanPostProcessor 实现类,依次调用 postProcessAfterInitialization 方法,返回代理对象。如果最终的代理对象返回 null,那么就会返回原始 bean 对象。这样保证了 BeanPostProcessor 的后续执行不会受到任何异常的干扰。 在 AbstractAutowireCapableBeanFactory 中还有一个方法 applyBeanPostProcessorsBeforeInitialization,其代码结构与 applyBeanPostProcessorsAfterInitialization 类似,不再赘述。 除了上述方法,AbstractAutowireCapableBeanFactory 类还有一个名为 getBeanPostProcessors 的方法。这个方法返回 Spring 容器内所有的 BeanPostProcessor 实现类,它们会依次被调用。 ```java protected List<BeanPostProcessor> getBeanPostProcessors() { List<BeanPostProcessor> processors = new ArrayList<>(); // 往集合里添加 BeanPostProcessor 实现类 processors.addAll(beanFactory.getBeansOfType(BeanPostProcessor.class, true, false).values()); // 往集合里添加 SmartInstantiationAwareBeanPostProcessor 实现类 processors.addAll(beanFactory.getBeansOfType(SmartInstantiationAwareBeanPostProcessor.class, true, false).values()); return processors; } ``` 可以看到,getBeanPostProcessors 方法主要作用是将 Spring 容器内所有的 BeanPostProcessor 实现类添加到一个 List 集合里,并返回这个集合。 至此,我们从源码层面上对 BeanPostProcessor 接口进行了详细的解析。相信读完这篇文档,你对 BeanPostProcessor 接口的作用以及 Spring 框架是如何使用它进行初始化 bean 过程中的各种扩展操作有了更深层次的理解。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

打赏作者

码拉松

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

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

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

打赏作者

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

抵扣说明:

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

余额充值