spring 扩展点

113 阅读7分钟

spring 扩展点

ApplicationContextInitializer
执行时机: spring 容器正式启动refresh() 之前
生效方式:

  • springApplication.addInitializers(new TestApplicationContextInitializer());
  • Spring SPI扩展,在spring.factories中加入org.springframework.context.ApplicationContextInitializer=xx.xxApplicationContextInitializer

使用场景: 动态字节码注入等操作

BeanDefinitionRegistryPostProcessor
执行时机: 对beanDefinition加载完成之后
生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式 使用场景: 可以在这里动态注册自己的beanDefinition,可以加载classpath之外的bean。spring的@configuration 中的@bean注解就是通过这种方式额外的将这些bean生成了BeanDefinition

BeanFactoryPostProcessor
执行时机: 对beanDefinition加载完成之后,这里包含自定义的BeanDefinitionRegistryPostProcessor中额外注册的
生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式 使用场景: 可以在这里修改BeanDefinition的元信息

InstantiationAwareBeanPostProcessor
执行时机:

  • postProcessBeforeInstantiation:实例化bean之前,相当于new这个bean之前
  • postProcessAfterInstantiation:实例化bean之后,相当于new这个bean之后
  • postProcessPropertyValues:bean已经实例化完成,在属性注入时阶段触发,@Autowired,@Resource等注解原理基于此方法实现
  • postProcessBeforeInitialization:初始化bean之前,相当于把bean注入spring上下文之前
  • postProcessAfterInitialization:初始化bean之后,相当于把bean注入spring上下文之后 生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式 使用场景: 中间件和业务中,都能利用这个特性。比如对实现了某一类接口的bean在各个生命期间进行收集,或者对某个类型的bean进行统一的设值等等

SmartInstantiationAwareBeanPostProcessor
执行时机:

  • predictBeanType:该触发点发生在postProcessBeforeInstantiation之前(在图上并没有标明,因为一般不太需要扩展这个点),这个方法用于预测Bean的类型,返回第一个预测成功的Class类型,如果不能预测返回null;当你调用BeanFactory.getType(name)时当通过bean的名字无法得到bean类型信息时就调用该回调方法来决定类型信息。
  • determineCandidateConstructors:该触发点发生在postProcessBeforeInstantiation之后,用于确定该bean的构造函数之用,返回的是该bean的所有构造函数列表。用户可以扩展这个点,来自定义选择相应的构造器来实例化这个bean。
  • getEarlyBeanReference:该触发点发生在postProcessAfterInstantiation之后,当有循环依赖的场景,当bean实例化好之后,为了防止有循环依赖,会提前暴露回调方法,用于bean实例化的后置处理。这个方法就是在提前暴露的回调方法中触发。
    生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式
    使用场景: --

BeanFactoryAware
执行时机: bean的实例化之后,注入属性之前
生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式
使用场景: 你可以在bean实例化之后,但还未初始化之前,拿到 BeanFactory,在这个时候,可以对每个bean作特殊化的定制

ApplicationContextAwareProcessor
执行时机:

  • EnvironmentAware:用于获取EnviromentAware的一个扩展类,这个变量非常有用, 可以获得系统内的所有参数。当然个人认为这个Aware没必要去扩展,因为spring内部都可以通过注入的方式来直接获得。
  • EmbeddedValueResolverAware:用于获取StringValueResolver的一个扩展类, StringValueResolver用于获取基于String类型的properties的变量,一般我们都用@Value的方式去获取,如果实现了这个Aware接口,把StringValueResolver缓存起来,通过这个类去获取String类型的变量,效果是一样的。
  • ResourceLoaderAware:用于获取ResourceLoader的一个扩展类,ResourceLoader可以用于获取classpath内所有的资源对象,可以扩展此类来拿到ResourceLoader对象。
  • ApplicationEventPublisherAware:用于获取ApplicationEventPublisher的一个扩展类,ApplicationEventPublisher可以用来发布事件,结合ApplicationListener来共同使用,下文在介绍ApplicationListener时会详细提到。这个对象也可以通过spring注入的方式来获得。
  • MessageSourceAware:用于获取MessageSource的一个扩展类,MessageSource主要用来做国际化。
  • ApplicationContextAware:用来获取ApplicationContext的一个扩展类,ApplicationContext应该是很多人非常熟悉的一个类了,就是spring上下文管理器,可以手动的获取任何在spring上下文注册的bean,我们经常扩展这个接口来缓存spring上下文,包装成静态方法。同时ApplicationContext也实现了BeanFactory,MessageSource,ApplicationEventPublisher等接口,也可以用来做相关接口的事情。
    生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式
    使用场景: 你可以在bean实例化之后,但还未初始化之前,拿到 BeanFactory,在这个时候,可以对每个bean作特殊化的定制

BeanNameAware
执行时机: bean的初始化之前
生效方式: 自定义的bean 只需要被spring管理即可,比如通过@component等方式
使用场景: 在初始化bean之前拿到spring容器中注册的的beanName,来自行修改这个beanName的值。

@PostConstruct
执行时机: postProcessBeforeInitialization之后,InitializingBean.afterPropertiesSet之前
生效方式: 自定义的bean 只需要被spring管理切方法标注@PostConstruct即可,比如通过@component等方式
使用场景: 可以对某一方法进行标注,来进行初始化某一个属性

FactoryBean
执行时机: 自定义创建bean的逻辑
生效方式: 自定义的bean 只需要被spring管理切方法标注,比如通过@component等方式
使用场景: 用户可以扩展这个类,来为要实例化的bean作一个代理,比如为该对象的所有的方法作一个拦截,在调用前后输出一行log,模仿ProxyFactoryBean的功能。

SmartInitializingSingleton
执行时机: postProcessAfterInitialization之后
生效方式: 自定义的bean 只需要被spring管理切方法标注,比如通过@component等方式
使用场景: 用户可以扩展此接口在对所有单例对象初始化完毕后,做一些后置的业务处理

CommandLineRunner
执行时机: 整个项目启动完毕后
生效方式: 自定义的bean 只需要被spring管理切方法标注,比如通过@component等方式
使用场景: 用户扩展此接口,进行启动项目之后一些业务的预处理

DisposableBean
执行时机: 对象销毁时,会自动执行这个方法
生效方式: 自定义的bean 只需要被spring管理切方法标注,比如通过@component等方式
使用场景: 对象销毁时,资源清理

ApplicationListener

  • ContextRefreshedEvent ApplicationContext 被初始化或刷新时,该事件被发布。这也可以在ConfigurableApplicationContext接口中使用 refresh()方法来发生。此处的初始化是指:所有的Bean被成功装载,后处理Bean被检测并激活,所有Singleton Bean 被预实例化,ApplicationContext容器已就绪可用。
  • ContextStartedEvent 当使用 ConfigurableApplicationContext (ApplicationContext子接口)接口中的 start() 方法启动 ApplicationContext时,该事件被发布。你可以调查你的数据库,或者你可以在接受到这个事件后重启任何停止的应用程序。
  • ContextStoppedEvent 当使用 ConfigurableApplicationContext接口中的 stop()停止ApplicationContext 时,发布这个事件。你可以在接受到这个事件后做必要的清理的工作
  • ContextClosedEvent 当使用 ConfigurableApplicationContext接口中的 close()方法关闭 ApplicationContext 时,该事件被发布。一个已关闭的上下文到达生命周期末端;它不能被刷新或重启
  • RequestHandledEvent 这是一个 web-specific 事件,告诉所有 bean HTTP 请求已经被服务。只能应用于使用DispatcherServlet的Web应用。在使用Spring作为前端的MVC控制器时,当Spring处理用户请求结束后,系统会自动触发该事件