IoC(Inverse of Control,控制反转)是 Spring 容器的内核,它是指某一接口具体实现类的选择控制权从调用类中移除,转交给第三方决定,即由 Spring 容器借由 Bean 配置来进行控制。由于 IoC 不好理解,后来人们提出了 DI(Dependency Injection,依赖注入)的概念,即让调用类对某一接口实现类的依赖关系由第三方注入,以移除调用者对某一接口实现类的依赖。Spring 通过配置文件或注解描述类和类之前的依赖关系,自动完成类的初始化和依赖注入工作。

BeanFactory

Spring 会利用反射实例化 Bean 并建立 Bean 之间的依赖关系。Spring 的 IoC 容器在完成这些底层工作的基础之上,还提供了 Bean 实例缓存、生命周期管理、Bean 实例代理、事件发布、资源装载等高级服务。

BeanFactory 是 Spring 最核心的接口,提供了高级 IoC 的配置机制,它使得管理不同类型的 Java 对象成为可能。而 ApplicationContext 建立在 BeanFactory 基础之上,提供了更多面向应用的功能。BeanFactory 是 Spring 框架的基础设施,面向 Spring 本身;ApplicationContext 面向使用 Spring 框架的开发者。

BeanFactory 接口位于类结构树的顶端,它最主要的方法是 getBean(String name) 用于从容器中返回特定名称的 Bean。BeanFactory 的功能通过其子类接口得到不断扩展。
image.png

  • ListableBeanFactory:该接口定义了访问容器中 Bean 基本信息的若干方法,如查看 Bean 的个数、获取某一类型 Bean 的配置名等。

  • ConfigurableBeanFactory:该接口增强了 IoC 容器的可定制性。它定义了设置类装载器、属性编辑器、容器初始化后置处理器等方法。

  • AutowireCapableBeanFactory:定义了将容器中的 Bean 按某种规则(名字、类型等)进行自动装配的方法。

  • SingletonBeanRegistry:定义了允许在运行期向容器注册单实例 Bean 的方法。

  • BeanDefinitionRegistry:每一个 节点元素在 Spring 容器里都通过一个 BeanDefinition 对象表示,它描述了 Bean 的配置信息。而 BeanDefinitionRegistry 接口提供了向容器手工注册 BeanDefinition 对象的方法。

ApplicationContext

ApplicationContext 继承了 BeanFactory ,提供了更多面向实际应用的功能。它的主要实现类是 ClassPathXmlApplicationContext(默认从类路径加载配置文件)和 FileSystemXmlApplicationContext(默认从文件系统中装载配置文件)。以及为基于注解的 Bean 配置提供了专门的 AnnotationConfigApplicationContext。
image.png
在获取 ApplicationContext 实例后,就可以像 BeanFactory 一样获取 Bean 实例。但是 ApplicationContext 的初始化和 BeanFactory 有一个重大区别:

  • BeanFactory 初始化容器时,并未实例化 Bean,直到第一次访问某个 Bean 时才实例化目标 Bean。
  • ApplicationContext 初始化应用上下文时就实例化所有单例 Bean,因此初始化时间会久一点,但之后的调用则没有“第一次惩罚”的问题。

1. BeanFactoryPostProcessor

ApplicationContext 在启动时,将首先为配置文件中的每个 生成一个 BeanDefinition 对象。当配置文件中所有的 都被解析成 BeanDefinition 时,ApplicationContext 将调用工厂后处理器的方法。如果在配置文件中声明了工厂后处理器接口 BeanFactoryPostProcessor 的实现类,则应用上下文在装载配置文件之后、初始化 Bean 实例之前将调用这些实现类对配置信息进行加工处理。BeanFactoryPostProcessor 实例是容器级别的,仅在应用上下文初始化时调用一次,目的是完成一些配置文件的加工处理工作。

  1. public interface BeanFactoryPostProcessor {
  2. /**
  3. * 在标准初始化之后修改应用程序上下文的内部bean工厂,此时所有bean定义都将被加载,但还没有bean被实例化,这允许覆盖或添加自定义bean定义
  4. */
  5. void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException;
  6. }

比如,Spring 内部提供了一个 PropertyPlaceholderConfigurer,它能够使 Bean 在配置时引用外部属性文件。该类就实现了 BeanFactoryPostProcessor 接口,因而也属于一个 Bean 工厂后置处理器。这样,基于注解配置的 Bean 就可以通过 @Value("${XXX}") 注解为 Bean 的成员变量或方法入参自动注入容器已有的属性了。如果想要注入其他 Bean 的属性,可以通过 @Value("#{beanName.propName}") 表达式来引用。

ApplicationContext 和 BeanFactory 另一个最大的不同之处在于:前者会利用 Java 反射机制自动识别出配置文件中定义的 BeanPostProcessor、InstantiationAwareBeanPostProcessor 和 BeanFactoryPostProcessor,并自动将它们注册到应用上下文中;而后者需要在代码中通过手工调用 addBeanPostProcessor() 方法进行注册。

2. 容器构建过程

Spring 的 AbstractApplicationContext 是 ApplicationContext 的抽象实现类,该抽象类的 refresh() 方法定义了 Spring 容器在加载配置文件后的各项处理过程。

  1. public void refresh() throws BeansException, IllegalStateException {
  2. // 整个过程进行线程同步处理
  3. synchronized (this.startupShutdownMonitor) {
  4. // 准备刷新的上下文环境
  5. prepareRefresh();
  6. // 初始化BeanFactory
  7. ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
  8. // 对BeanFactory进行各种功能填充
  9. prepareBeanFactory(beanFactory);
  10. try {
  11. // 允许context的子类对bean工厂进行后置处理
  12. postProcessBeanFactory(beanFactory);
  13. // 激活各种BeanFactoryPostProcessors
  14. invokeBeanFactoryPostProcessors(beanFactory);
  15. // 注册BeanPostProcessors,这里只是注册,真正的调用是在getBean的时候
  16. registerBeanPostProcessors(beanFactory);
  17. // 初始化context的信息源,即不同语言的消息体,和国际化有关
  18. initMessageSource();
  19. // 初始化context的事件传播器
  20. initApplicationEventMulticaster();
  21. // 留给子类来初始化其它的Bean,这是一个钩子方法,子类可以借助这个方法执行一些特殊的操作
  22. onRefresh();
  23. // 在所有注册的bean中查找ApplicationListener bean,注册到消息广播器中
  24. registerListeners();
  25. // 实例化所有非懒加载单例
  26. finishBeanFactoryInitialization(beanFactory);
  27. // 完成刷新过程,发布对应容器刷新事件
  28. finishRefresh();
  29. }
  30. ......
  31. }
  32. }

2.1 obtainFreshBeanFactory

obtainFreshBeanFactory 方法从字面理解是获取 BeanFactory。之前有说过,ApplicationContext 是对 BeanFactory 的功能上的扩展,不但包含了 BeanFactory 的全部功能,更在其基础上添加了大量的扩展应用,那么 obtainFreshBeanFactory 正是实现 BeanFactory 的地方,经过了这个函数后 ApplicationContext 就已经拥有了 BeanFactory 的全部功能了。

  1. protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
  2. refreshBeanFactory();
  3. return getBeanFactory();
  4. }

在 obtainFreshBeanFactory() 方法中,核心逻辑在 refreshBeanFactory() 方法中,这个方法是由子类来实现具体逻辑的,此时 Bean 实例还未初始化。

  1. @Override
  2. protected final void refreshBeanFactory() throws BeansException {
  3. if (hasBeanFactory()) {
  4. destroyBeans();
  5. closeBeanFactory();
  6. }
  7. try {
  8. // BeanFactory的原始对象类型,即DefaultListableBeanFactory类型
  9. DefaultListableBeanFactory beanFactory = createBeanFactory();
  10. // 为了序列化指定id,如果需要的话,让这个BeanFactory从id反序列到BeanFactory对象
  11. beanFactory.setSerializationId(getId());
  12. // 定制BeanFactory,设置相关属性,包括是否允许覆盖同名称的不同定义的对象以及循环依赖
  13. customizeBeanFactory(beanFactory);
  14. // 加载、解析bean的定义,也就是把用户定义的数据结构转化为Ioc容器中的特定数据结构
  15. loadBeanDefinitions(beanFactory);
  16. synchronized (this.beanFactoryMonitor) {
  17. this.beanFactory = beanFactory;
  18. }
  19. } catch (IOException ex) {
  20. throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
  21. }
  22. }

2.2 prepareBeanFactory

进入函数 prepareBeanFactory 前,Spring 已经完成了对配置的解析,而 ApplicationContext 在功能上的扩展也由此展开。

  1. protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
  2. // 设置 beanFactory 的 classLoader 为当前 context 的 classLoader
  3. beanFactory.setBeanClassLoader(getClassLoader());
  4. // 设置 beanFactory 的表达式语言处理器,默认可以使用#{bean.xxx}的形式来调用相关属性值
  5. beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
  6. beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment()));
  7. // 添加 BeanPostProcessor 处理器,用于回调Aware相关接口
  8. beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
  9. // 设置了几个忽略自动装配的接口
  10. beanFactory.ignoreDependencyInterface(EnvironmentAware.class);
  11. beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class);
  12. beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class);
  13. beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class);
  14. beanFactory.ignoreDependencyInterface(MessageSourceAware.class);
  15. beanFactory.ignoreDependencyInterface(ApplicationContextAware.class);
  16. // 设置了几个自动装配的特殊规则
  17. beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory);
  18. beanFactory.registerResolvableDependency(ResourceLoader.class, this);
  19. beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this);
  20. beanFactory.registerResolvableDependency(ApplicationContext.class, this);
  21. // 添加 BeanPostProcessor 处理器
  22. beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this));
  23. // 增加对 AspectJ 的支持
  24. if (beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) {
  25. beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory));
  26. beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader()));
  27. }
  28. // 添加默认的系统环境bean
  29. if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) {
  30. beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment());
  31. }
  32. if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) {
  33. beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties());
  34. }
  35. if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) {
  36. beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment());
  37. }
  38. }

2.3 invokeBeanFactoryPostProcessors

从 BeanDefinitionRegistry 中找出所有实现了 BeanFactoryPostProcessor 接口的 Bean,然后通过反射机制进行实例化,并调用其 postProcessBeanFactory() 方法执行自定义逻辑。

  1. protected void invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory) {
  2. PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(beanFactory, getBeanFactoryPostProcessors());
  3. ......
  4. }

2.4 registerBeanPostProcessors

BeanPostProcessor 真正被调用其实是在 bean 的实例化阶段进行的,这里只是进行注册,但这是一个很重要的步骤,也是很多功能 BeanFactory 不支持的重要原因。因此 Spring 中大部分功能都是通过后处理器的方式进行扩展的,但是在 BeanFactory 中其实并没有实现后处理器的自动注册,所以在调用的时候如果没有进行手动注册其实是不能使用的。但是在 ApplicationContext 中却添加了自动注册功能,避免了手动注册。

  1. public static void registerBeanPostProcessors(ConfigurableListableBeanFactory beanFactory, AbstractApplicationContext applicationContext) {
  2. // 获取所有的BeanPostProcessor处理器名称
  3. String[] postProcessorNames = beanFactory.getBeanNamesForType(BeanPostProcessor.class, true, false);
  4. // 使用PriorityOrdered接口保证BeanPostProcessor的执行顺序
  5. List<BeanPostProcessor> priorityOrderedPostProcessors = new ArrayList<>();
  6. List<BeanPostProcessor> internalPostProcessors = new ArrayList<>();
  7. // 使用Ordered接口保证BeanPostProcessor的执行顺序
  8. List<String> orderedPostProcessorNames = new ArrayList<>();
  9. // 无序BeanPostProcessor
  10. List<String> nonOrderedPostProcessorNames = new ArrayList<>();
  11. for (String ppName : postProcessorNames) {
  12. // 排序
  13. if (beanFactory.isTypeMatch(ppName, PriorityOrdered.class)) {
  14. BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
  15. priorityOrderedPostProcessors.add(pp);
  16. if (pp instanceof MergedBeanDefinitionPostProcessor) {
  17. internalPostProcessors.add(pp);
  18. }
  19. } else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
  20. orderedPostProcessorNames.add(ppName);
  21. } else {
  22. nonOrderedPostProcessorNames.add(ppName);
  23. }
  24. }
  25. // 第1步,注册所有实现PriorityOrdered接口的BeanPostProcessor
  26. sortPostProcessors(priorityOrderedPostProcessors, beanFactory);
  27. registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);
  28. // 第2步,注册所有实现Ordered接口的BeanPostProcessor
  29. List<BeanPostProcessor> orderedPostProcessors = new ArrayList<>(orderedPostProcessorNames.size());
  30. for (String ppName : orderedPostProcessorNames) {
  31. BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
  32. orderedPostProcessors.add(pp);
  33. if (pp instanceof MergedBeanDefinitionPostProcessor) {
  34. internalPostProcessors.add(pp);
  35. }
  36. }
  37. sortPostProcessors(orderedPostProcessors, beanFactory);
  38. registerBeanPostProcessors(beanFactory, orderedPostProcessors);
  39. // 第3步,注册所有无序的BeanPostProcessor
  40. List<BeanPostProcessor> nonOrderedPostProcessors = new ArrayList<>(nonOrderedPostProcessorNames.size());
  41. for (String ppName : nonOrderedPostProcessorNames) {
  42. BeanPostProcessor pp = beanFactory.getBean(ppName, BeanPostProcessor.class);
  43. nonOrderedPostProcessors.add(pp);
  44. if (pp instanceof MergedBeanDefinitionPostProcessor) {
  45. internalPostProcessors.add(pp);
  46. }
  47. }
  48. registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
  49. // 第4步,注册所有MergedBeanDefinitionPostProcessor类型的BeanPostProcessor
  50. // 这里并非重复注册,因为在注册时会先移除已经存在的BeanPostProcessor
  51. sortPostProcessors(internalPostProcessors, beanFactory);
  52. registerBeanPostProcessors(beanFactory, internalPostProcessors);
  53. // 手动添加ApplicationListenerDetector处理器
  54. beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
  55. }

2.5 initApplicationEventMulticaster

initApplicationEventMulticaster 方法逻辑比较简单,主要用于初始化应用上下文的事件广播器。

  1. protected void initApplicationEventMulticaster() {
  2. ConfigurableListableBeanFactory beanFactory = getBeanFactory();
  3. if (beanFactory.containsLocalBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME)) {
  4. this.applicationEventMulticaster = beanFactory.getBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, ApplicationEventMulticaster.class);
  5. } else {
  6. this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory);
  7. beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, this.applicationEventMulticaster);
  8. }
  9. }
  • 如果用户自定义了事件广播器,那么直接使用用户自定义的事件广播器。
  • 如果用户没有自定义事件广播器,那么使用默认的 SimpleApplicationEventMulticaster。

2.6 registerListeners

�registerListeners 方法主要用来注册事件监听器:

  1. protected void registerListeners() {
  2. // 硬编码方式注册ApplicationListener
  3. for (ApplicationListener<?> listener : getApplicationListeners()) {
  4. getApplicationEventMulticaster().addApplicationListener(listener);
  5. }
  6. // 配置文件注册的监听器处理
  7. String[] listenerBeanNames = getBeanNamesForType(ApplicationListener.class, true, false);
  8. for (String listenerBeanName : listenerBeanNames) {
  9. getApplicationEventMulticaster().addApplicationListenerBean(listenerBeanName);
  10. }
  11. }

2.7 finishBeanFactoryInitialization

该方法用来完成 BeanFactory 初始化工作,其中包括非延迟加载的 Bean 的初始化工作。

  1. protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
  2. ......
  3. // 不使用TempClassLoader
  4. beanFactory.setTempClassLoader(null);
  5. // 禁止修改当前bean的配置信息,说明注册的bean定义将不被修改或进行任何进一步的处理
  6. beanFactory.freezeConfiguration();
  7. // 实例化所有被标记为non-lazy-init的单例bean
  8. beanFactory.preInstantiateSingletons();
  9. }

ApplicationContext 实现的默认行为就是在启动时将所有单例 bean 提前进行实例化。提前实例化意味着作为初始化过程的一部分,ApplicationContext 实例会创建并配置所有的单例 bean。通常情况下这是一件好事,因为这样在配置中的任何错误就会即刻被发现。其中,非延迟加载的 Bean 的实例化过程是在 BeanFactory 中完成的,preInstantiateSingletons() 方法的代码逻辑具体如下:

  1. public void preInstantiateSingletons() throws BeansException {
  2. List<String> beanNames = new ArrayList<>(this.beanDefinitionNames);
  3. for (String beanName : beanNames) {
  4. RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
  5. // 不是抽象类、是单例类型、不是懒加载
  6. if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
  7. // 如果bean继承了FactoryBean,执行用户自定义产生实例对象的方法
  8. if (isFactoryBean(beanName)) {
  9. Object bean = getBean("&" + beanName);
  10. if (bean instanceof FactoryBean) {
  11. final FactoryBean<?> factory = (FactoryBean<?>) bean;
  12. ......
  13. getBean(beanName);
  14. }
  15. } else {
  16. // getBean方法封装了实例化bean的整个流程
  17. getBean(beanName);
  18. }
  19. }
  20. }
  21. // 触发所有适用bean的初始化后回调
  22. for (String beanName : beanNames) {
  23. Object singletonInstance = getSingleton(beanName);
  24. if (singletonInstance instanceof SmartInitializingSingleton) {
  25. final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
  26. ......
  27. smartSingleton.afterSingletonsInstantiated();
  28. }
  29. }
  30. }

2.8 finishRefresh

在 Spring 中还提供了 Lifecycle 接口,Lifecycle 中包含 start、stop 方法,实现此接口后 Spring 会保证在启动时调用其 start 方法开始生命周期,并在 Spring 关闭时调用 stop 方法来结束生命周期,通常用来配置一些后台程序,ApplicationContext 的初始化最后正是保证了这一功能的实现。

  1. protected void finishRefresh() {
  2. clearResourceCaches();
  3. // 获取容器中LifecycleProcessor接口
  4. initLifecycleProcessor();
  5. // 调用已注册的LifecycleProcessor接口的onRefresh回调方法
  6. getLifecycleProcessor().onRefresh();
  7. // 当完成 ApplicationContext 初始化时,要通过Spring中的事件发布机制来发出 ContextRefreshedEvent 事件,以保证对应的监听器可以做进一步的逻辑处理
  8. publishEvent(new ContextRefreshedEvent(this));
  9. }

3. 容器事件机制

Spring 的 ApplicationContext 能够发布事件并且允许注册相应的事件监听器,因此,它拥有一套完整的事件发布和监听机制。事件源产生事件(EventObject),通过事件广播器把事件通知给事件监听器(EventListener)。
image.png

3.1 Spring 事件类型

1)事件类
目前 Spring 框架本身仅定义了几个事件,ApplicationEvent 的唯一构造函数是 ApplicationEvent(Object source),通过 source 指定事件源,它有两个子类。

  • ApplicationContextEvent:容器事件,它有 4 个子类,分别表示容器启动、刷新、停止及关闭事件。

    • ContextStartedEvent:当 ApplicationContext 启动的时候发布事件。
    • ContextRefreshEvent:当 ApplicationContext 容器初始化完成或者被刷新的时候,就会发布该事件。此处的容器初始化指的是所有的 Bean 都被成功装载,后处理(post-processor)Bean 被检测到并且激活,所有单例 Bean 都被预实例化,ApplicationContext 容器已经可以使用。只要上下文没有被关闭,刷新可以被多次触发。
    • ContextStoppedEvent:当 ApplicationContext 容器停止的时候发布事件。
    • ContextClosedEvent:当 ApplicationContext 关闭的时候发布事件,关闭指的是所有的单例 Bean 都被销毁,关闭后不能重新刷新或重新启动。
  • RequestHandleEvent:这是一个与 Web 应用相关的事件,当一个 HTTP 请求被处理后,产生该事件。

image.png

2)事件监听接口
Spring 的事件监听器都继承自 ApplicationListener 接口。该接口只定义了一个方法:onApplicationEvent(E event),该方法接收 ApplicationEvent 事件对象,在该方法中编写事件的响应处理逻辑。在 Spring 中的,如果一个 Bean 实现了 ApplicationListener 接口,并且已经发布到容器中去,则当 ApplicationContext 通过 publishEvent 方法发布一个 ApplicationEvent 事件时,这个 Bean 就会接到通知。
image.png

  1. public interface SmartApplicationListener extends ApplicationListener<ApplicationEvent>, Ordered {
  2. // 指定监听器支持哪种类型的容器事件,即它只会对该类型的事件做出响应
  3. boolean supportsEventType(Class<? extends ApplicationEvent> eventType);
  4. // 指定监听器仅对何种事件源对象做出响应
  5. default boolean supportsSourceType(@Nullable Class<?> sourceType) { return true; }
  6. }

GenericApplicationListener 增强了对泛型事件类型的支持,supportsEventType() 方法的参数不再仅限于 ApplicationEvent 子类型,而是采用可解析类型 ResolvableType。

  1. public interface GenericApplicationListener extends ApplicationListener<ApplicationEvent>, Ordered {
  2. // 指定监听器是否实际支持给定的事件类型,即它只会对该类型的事件做出响应
  3. boolean supportsEventType(ResolvableType eventType);
  4. // 指定监听器仅对何种事件源对象做出响应
  5. default boolean supportsSourceType(@Nullable Class<?> sourceType) { return true; }
  6. }

3)事件广播器
当发生容器事件时,容器将调用事件广播器将事件通知给事件监听器注册表中的事件监听器,事件监听器分别对事件进行响应。Spring 为事件广播器定义了接口,并提供了实现类。
image.png

3.2 Spring 事件体系实现原理

Spring 在 ApplicationContext 接口的抽象实现类 AbstractApplicationContext 中完成了事件体系的搭建。该抽象类拥有一个 ApplicationEventMulticaster 成员变量,该变量提供了容器监听器的注册表。AabstractApplicationContext 在 refresh() 这个容器启动方法中通过以下三步搭建了事件的基础设施。

  1. // 5:初始化应用上下文事件广播器
  2. initApplicationEventMulticaster();
  3. // 7:注册事件监听器
  4. registerListeners();
  5. // 9:完成刷新并发布容器刷新事件
  6. finishRefresh();

在 5 处,Spring 初始化事件的广播器。用户可用自定义一个事件广播器,只要实现 ApplicationEventMulticaster 即可,Spring 会通过反射机制将其注册成容器的事件广播器。如果没有找到自定义的,则 Spring 使用 SimpleApplicationEventMulticaster 作为事件广播器。

  1. protected void initApplicationEventMulticaster() {
  2. ConfigurableListableBeanFactory beanFactory = getBeanFactory();
  3. if (beanFactory.containsLocalBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME)) {
  4. this.applicationEventMulticaster = beanFactory.getBean(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, ApplicationEventMulticaster.class);
  5. } else {
  6. this.applicationEventMulticaster = new SimpleApplicationEventMulticaster(beanFactory);
  7. beanFactory.registerSingleton(APPLICATION_EVENT_MULTICASTER_BEAN_NAME, this.applicationEventMulticaster);
  8. }
  9. }

在 7 处,Spring 根据反射机制,从 BeanDefinitionRegistry 中找出所有实现了 ApplicationListener 的 Bean,将它们注册为容器的事件监听器,就是将其添加到事件广播器所提供的事件监听器注册表中。在 9 处,容器启动完成,调用事件发布接口向容器中所有的监听器发布事件。通过 publishEvent() 方法发布一个容器刷新事件,然后根据事件监听器注册表通知监听该事件的监听器。

3.3 使用示例

  1. @Component
  2. public class MailSend implements ApplicationContextAware {
  3. private ApplicationContext context;
  4. @Override
  5. public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
  6. this.context = applicationContext;
  7. }
  8. @PostConstruct
  9. public void sendMail() {
  10. System.out.println("SendMail:发送邮件");
  11. MailSendEvent event = new MailSendEvent(this.context, "Allen");
  12. context.publishEvent(event);
  13. }
  14. }

Event 定义:

  1. public class MailSendEvent extends ApplicationContextEvent {
  2. private String to;
  3. public MailSendEvent(ApplicationContext source, String to) {
  4. super(source);
  5. this.to = to;
  6. }
  7. @Override
  8. public Object getSource() { return super.getSource(); }
  9. @Override
  10. public String toString() { return super.toString(); }
  11. public String getTo() { return to; }
  12. }

Listener 定义:

  1. @Component
  2. public class MailSendListener implements ApplicationListener<MailSendEvent> {
  3. @Override
  4. public void onApplicationEvent(MailSendEvent event) {
  5. System.out.println("MailSendListener: 向[" + event.getTo() + "]发送一封邮件");
  6. }
  7. }