Spring钩子方法和钩子接口的使用详解

本文转自：http://www.sohu.com/a/166804449_714863

前言

SpringFramework其实具备很高的扩展性，只是不多人喜欢挖掘那些扩展点，并且官方的Refrence也不多提到那些Hook类或Hook接口，至因而不是Spring官方有意为之就不得而知。

目前看到的Spring的一些对外开放的扩展点、Hook接口或者Hook类，若是有什么错误，但愿多多交流指正，一切以Spring的源码为准，文章编写使用的Spring版本为4.3.8.Release,对应SpringBoot的版本为1.5.3.RELEASE

一、Aware接口族

Spring中提供了各类Aware接口，方便从上下文中获取当前的运行环境，比较常见的几个子接口有：

BeanFactoryAware,BeanNameAware,ApplicationContextAware,EnvironmentAware，BeanClassLoaderAware等，这些Aware的做用均可以从命名得知，而且其使用也是十分简单。

例如咱们常常看到SpringContext工具类：

实现ApplicationContextAware接口能够获取ApplicationContext

又例如想获取到当前的一个Spring Bean的BeanFactory：

通常来讲，拿到的应该是DefaultListableBeanFactory，由于这个BeanFactory是BeanFactory一族的最底层的BeanFactory实现类，拥有全部父BeanFactory的功能。

其余的Aware能够本身尝试下功能。

二、InitializingBean接口和DisposableBean接口

InitializingBean接口只有一个方法#afterPropertiesSet，做用是：当一个Bean实现InitializingBean，#afterPropertiesSet方法里面能够添加自定义的初始化方法或者作一些资源初始化操做(Invoked by a BeanFactory after it has set all bean properties supplied ==> "当BeanFactory 设置完全部的Bean属性以后才会调用#afterPropertiesSet方法")。

DisposableBean接口只有一个方法#destroy，做用是：当一个单例Bean实现DisposableBean，#destroy能够添加自定义的一些销毁方法或者资源释放操做(Invoked by a BeanFactory on destruction of a singleton ==>"单例销毁时由BeanFactory调用#destroy")

使用例子:

三、ImportBeanDefinitionRegistrar接口

功能：

先看官方的注释

翻译一下大概以下：

1.当处理Java编程式配置类(使用了@Configuration的类)的时候，ImportBeanDefinitionRegistrar接口的实现类能够注册额外的bean definitions;

2.ImportBeanDefinitionRegistrar接口的实现类必须提供给@Import注解或者是ImportSelector接口返回值

3.ImportBeanDefinitionRegistrar接口的实现类可能还会实现下面org.springframework.beans.factory.Aware接口中的一个或者多个，它们各自的方法优先于ImportBeanDefinitionRegistrar#registerBeanDefinitions被调用

org.springframework.beans.factory.Aware的部分接口以下：

• org.springframework.context.EnvironmentAware(读取或者修改Environment的变量)

• org.springframework.beans.factory.BeanFactoryAware (获取Bean自身的Bean工厂)

• org.springframework.beans.factory.BeanClassLoaderAware(获取Bean自身的类加载器)

• org.springframework.context.ResourceLoaderAware(获取Bean自身的资源加载器)

我的理解：

1.首先须要自定义一个类去实现ImportBeanDefinitionRegistrar接口， #registerBeanDefinitions方法的参数有(使用了@Import的类型)元注解AnnotationMetadata以及BeanDefinitionRegistry(Bean注册相关方法的提供接口)，经过BeanDefinitionRegistry的方法能够实现BeanDefinition注册、移除等相关操做；

2.为了保证1生效，必须定义一个Java配置类(带有注解@Configuration)经过@Import指定1中定义的实现类

一个例子：

目标是经过自定义注解@EnableThrowable里面的targets属性指定须要注册进去Spring容器的class，当注解使用在@Configuration的类上，实现指定class的注册，而后可使用@Autowire实现自动注入。

定义ImportBeanDefinitionRegistrar的实现类EnableThrowableRegistrar：

定义一个注解@EnableThrowable：

定义一个Java配置类ConcreteConfiguration：

定义一个非Spring管理的Service类ConcreteService：

测试代码：

结果：

能够看到读取Environment属性成功，同时普通Java类ConcreteService成功注册到Spring容器而且自动注入和调用成功。

四、BeanPostProcessor接口和BeanFactoryPostProcessor接口

通常咱们叫这两个接口为Spring的Bean后置处理器接口,做用是为Bean的初始化先后提供可扩展的空间。先看接口的方法：

BeanPostProcessor

BeanFactoryPostProcessor

BeanFactoryPostProcessor能够对bean的定义（配置元数据）进行处理。也就是说，Spring IoC容器容许BeanFactoryPostProcessor在容器实际实例化任何其它的bean以前读取配置元数据，并有可能修改它。

若是你愿意，你能够配置多个BeanFactoryPostProcessor。你还能经过设置'order'属性来控制BeanFactoryPostProcessor的执行次序。(大概能够这样理解:Spring容器加载了bean的定义文件以后，在bean实例化以前执行的)

实现BeanPostProcessor接口能够在Bean(实例化以后)初始化的先后作一些自定义的操做，可是拿到的参数只有BeanDefinition实例和BeanDefinition的名称，也就是没法修改BeanDefinition元数据,这里说的Bean的初始化是：

1）bean实现了InitializingBean接口，对应的方法为afterPropertiesSet

2）在bean定义的时候，经过init-method设置的方法

PS:BeanFactoryPostProcessor回调会先于BeanPostProcessor

使用例子：

实现一个BeanPostProcessor==>ConcreteBeanPostProcessor

实现一个BeanFactoryPostProcessor==>ConcreteBeanFactoryPostProcessor

定义一个Spring的Bean

测试类：

结果：

五、BeanDefinitionRegistryPostProcessor 接口

BeanDefinitionRegistryPostProcessor 接口能够看做是BeanFactoryPostProcessor和ImportBeanDefinitionRegistrar的功能集合，既能够获取和修改BeanDefinition的元数据，也能够实现BeanDefinition的注册、移除等操做。

例子：

定义一个BeanDefinitionRegistryPostProcessor==>ConcreteBeanDefinitionRegistryPostProcessor

定义一个普通的Java类：

测试类：

结果：

六、FactoryBean接口

首先第一眼要注意，是FactoryBean接口而不是BeanFactory接口。通常状况下，Spring经过反射机制利用bean的class属性指定实现类来实例化bean ，实例化bean过程比较复杂。

FactoryBean接口就是为了简化此过程，把bean的实例化定制逻辑下发给使用者。

在该接口中还定义了如下3个方法。

T getObject()：返回由FactoryBean建立的bean实例，若是isSingleton()返回true，则该实例会放到Spring容器中单实例缓存池中。

boolean isSingleton()：返回由FactoryBean建立的bean实例的做用域是singleton仍是prototype。

Class<T> getObjectType()：返回FactoryBean建立的bean类型。

注意一点：经过Spring容器的getBean()方法返回的不是FactoryBean自己，而是FactoryBean#getObject()方法所返回的对象，至关于FactoryBean#getObject()代理了getBean()方法。

若是但愿获取CarFactoryBean的实例，则须要在使用getBean(beanName) 方法时在beanName前显示的加上 "&" 前缀。

一个例子：

实体类：

自定义FactoryBean:

测试类：

结果：

结果和预期同样，经过ApplicationContext#getBean(beanName)获取到的其实是FactoryBean#getObject的实例，ApplicationContext#getBean(“&” + beanName)获取到的才是FruitFactoryBean自己的实例。

7.ApplicationListener

ApplicationListener是一个接口，里面只有一个onApplicationEvent(E event)方法，这个泛型E必须是ApplicationEvent的子类，而ApplicationEvent是Spring定义的事件，继承于EventObject，构造要求必须传入一个Object类型的source，这个source能够做为一个存储对象。

将会在ApplicationListener的onApplicationEvent里面获得回调。若是在上下文中部署一个实现了ApplicationListener接口的bean，那么每当在一个ApplicationEvent发布到 ApplicationContext时，这个bean获得通知。

其实这就是标准的Oberver设计模式。另外，ApplicationEvent的发布由ApplicationContext经过#publishEvent方法完成。其实这个实现从原理和代码上看都有点像Guava的eventbus。

贴一个例子：

EmailEvent:

EmailApplicationListener：

测试类：