柳州网站建设22火蝠电商代运营公司
SpringBoot源码系列文章
SpringBoot源码解析(一):SpringApplication构造方法
SpringBoot源码解析(二):引导上下文DefaultBootstrapContext
SpringBoot源码解析(三):启动开始阶段
目录
- 前言
- 一、入口
- 二、SpringApplicationRunListener
- 1、作用及触发时机
- 2、示例
- 三、事件和广播器
- 1、事件SpringApplicationEvent
- 1.1、介绍
- 1.1.1、EventObject
- 1.1.2、ApplicationEvent
- 1.1.3、SpringApplicationEvent
- 1.2、常见的子事件
- 2、广播器ApplicationEventMulticaster
- 2.1、ApplicationEventMulticaster
- 2.2、AbstractApplicationEventMulticaster
- 2.3、SimpleApplicationEventMulticaster
- 四、启动方法
- 1、广播事件到应用监听器
- 2、根据事件类型匹配监听器
- 2.1、实现ApplicationListener<指定事件类型>
- 2.2、实现GenericApplicationListener
- 3、匹配到的监听器
- 总结
前言
前文深入解析了引导上下文DefaultBootstrapContext
作为组件存储容器的角色,接下来将进入启动开始阶段
的内容。
SpringBoot版本2.7.18
SpringApplication的run方法的执行逻辑如下,本文将详细介绍第二小节:获取启动监听器,调用启动开始方法
// SpringApplication类方法
public ConfigurableApplicationContext run(String... args) {// 记录应用启动的开始时间long startTime = System.nanoTime();// 1.创建引导上下文,用于管理应用启动时的依赖和资源DefaultBootstrapContext bootstrapContext = createBootstrapContext();ConfigurableApplicationContext context = null;// 配置无头模式属性,以支持在无图形环境下运行// 将系统属性 java.awt.headless 设置为 trueconfigureHeadlessProperty();// 2.获取Spring应用启动监听器,用于在应用启动的各个阶段执行自定义逻辑SpringApplicationRunListeners listeners = getRunListeners(args);// 启动开始方法(发布开始事件、通知应用监听器ApplicationListener)listeners.starting(bootstrapContext, this.mainApplicationClass);try {// 4.解析应用参数ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);// 5.准备应用环境,包括读取配置文件和设置环境变量ConfigurableEnvironment environment = prepareEnvironment(listeners, bootstrapContext, applicationArguments);// 配置是否忽略 BeanInfo,以加快启动速度configureIgnoreBeanInfo(environment);// 6.打印启动BannerBanner printedBanner = printBanner(environment);// 7.创建应用程序上下文context = createApplicationContext();// 设置应用启动的上下文,用于监控和管理启动过程context.setApplicationStartup(this.applicationStartup);// 8.准备应用上下文,包括加载配置、添加 Bean 等prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);// 9.刷新上下文,完成 Bean 的加载和依赖注入refreshContext(context);// 10.刷新后的一些操作,如事件发布等afterRefresh(context, applicationArguments);// 计算启动应用程序的时间,并记录日志Duration timeTakenToStartup = Duration.ofNanos(System.nanoTime() - startTime);if (this.logStartupInfo) {new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), timeTakenToStartup);}// 11.通知监听器应用启动完成listeners.started(context, timeTakenToStartup);// 12.调用应用程序中的 `CommandLineRunner` 或 `ApplicationRunner`,以便执行自定义的启动逻辑callRunners(context, applicationArguments);}catch (Throwable ex) {// 13.处理启动过程中发生的异常,并通知监听器handleRunFailure(context, ex, listeners);throw new IllegalStateException(ex);}try {// 14.计算应用启动完成至准备就绪的时间,并通知监听器Duration timeTakenToReady = Duration.ofNanos(System.nanoTime() - startTime);listeners.ready(context, timeTakenToReady);}catch (Throwable ex) {// 处理准备就绪过程中发生的异常handleRunFailure(context, ex, null);throw new IllegalStateException(ex);}// 返回已启动并准备就绪的应用上下文return context;
}
一、入口
- 主要分为两个步骤,先获取Spring应用启动监听器,再调用启动方法
// 2.获取Spring应用启动监听器,用于在应用启动的各个阶段执行自定义逻辑
SpringApplicationRunListeners listeners = getRunListeners(args);
// 启动方法(发布开始事件、通知应用监听器ApplicationListener)
listeners.starting(bootstrapContext, this.mainApplicationClass);
- 获取启动监听器步骤就是从
spring.factories
文件获取SpringApplicationRunListener
实现类(SpringBoot源码解析(一):启动流程之SpringApplication构造方法有详细介绍)- 之前实例化上下文初始化、应用监听器都通过调用
无参构造函数
来创建类的实例 - 但是应用启动监听器通过
SpringApplication.class, String[].class
这两参数的构造来创建实例
- 之前实例化上下文初始化、应用监听器都通过调用
ApplicationStartup
作用提供启动性能的监控和分析工具,只有导入固定依赖才会生效,暂不研究- 启动方法核心内容就是遍历调用
SpringApplicationRunListener
实现类的starting
方法
// SpringApplication类方法
private SpringApplicationRunListeners getRunListeners(String[] args) {// 这两个参数就是获取SpringApplicationRunListener实现类构造函数的参数Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };return new SpringApplicationRunListeners(logger,getSpringFactoriesInstances(SpringApplicationRunListener.class, types, this, args),this.applicationStartup);
}// SpringApplicationRunListeners类属性
class SpringApplicationRunListeners {private final Log log;// 存储所有SpringApplicationRunListener应用启动监听器的集合private final List<SpringApplicationRunListener> listeners;private final ApplicationStartup applicationStartup;...// 启动方法void starting(ConfigurableBootstrapContext bootstrapContext, Class<?> mainApplicationClass) {doWithListeners("spring.boot.application.starting", // 遍历每个监听器并执行starting方法(listener) -> listener.starting(bootstrapContext),// 为启动步骤打标签,包含mainApplicationClass信息(若不为空)(step) -> {if (mainApplicationClass != null) {step.tag("mainApplicationClass", mainApplicationClass.getName());}});}...// 使用给定的监听器操作和步骤操作,遍历所有监听器并执行相应操作private void doWithListeners(String stepName, Consumer<SpringApplicationRunListener> listenerAction,Consumer<StartupStep> stepAction) {// 启动一个新的启动步骤,用于性能分析StartupStep step = this.applicationStartup.start(stepName);// 对每个监听器执行指定的动作this.listeners.forEach(listenerAction);// 如果存在步骤操作,则执行该操作if (stepAction != null) {stepAction.accept(step);}// 结束启动步骤step.end();}
}
- 在spring-boot-2.7.18.jar下的spring.factories文件下只找到
EventPublishingRunListener
这一个应用启动监听器
二、SpringApplicationRunListener
1、作用及触发时机
SpringApplicationRunListener是SpringBoot框架中的一个接口,用于监听Spring应用程序启动过程的生命周期事件。通过实现该接口,可以在应用启动的各个阶段执行自定义逻辑
。
public interface SpringApplicationRunListener {/*** 在应用程序启动开始时调用* @param bootstrapContext 提供引导上下文,可在应用程序启动期间存储和共享数据。*/default void starting(ConfigurableBootstrapContext bootstrapContext) {}/*** 当环境准备好时调用,可以在此阶段访问和修改应用程序环境。* @param bootstrapContext 提供引导上下文。* @param environment 配置的环境对象,可用于访问和自定义环境属性。*/default void environmentPrepared(ConfigurableBootstrapContext bootstrapContext,ConfigurableEnvironment environment) {}/*** 当 ApplicationContext 已创建但还未刷新时调用,可以对应用上下文进行进一步配置。* @param context Spring 应用程序上下文,提供 Bean 工厂等信息。*/default void contextPrepared(ConfigurableApplicationContext context) {}/*** 当 ApplicationContext 加载完成并已注册所有 Bean 后调用。* 此时,Bean 已加载,但未初始化。* @param context Spring 应用程序上下文。*/default void contextLoaded(ConfigurableApplicationContext context) {}/*** 应用启动完成后调用,表示应用程序已启动并处于活动状态。* @param context Spring 应用程序上下文。* @param timeTaken 应用程序启动所花费的时间。*/default void started(ConfigurableApplicationContext context, Duration timeTaken) {started(context);}/*** 这是 `started` 的过时版本,仅为了兼容性保留。* 应用启动完成后调用* @param context Spring 应用程序上下文。* @deprecated 使用 {@link #started(ConfigurableApplicationContext, Duration)} 替代*/@Deprecateddefault void started(ConfigurableApplicationContext context) {}/*** 当应用程序完全准备好可以接收请求时调用* 此方法在 ApplicationRunner 和 CommandLineRunner 执行完毕后触发* @param context Spring 应用程序上下文* @param timeTaken 应用程序启动所花费的时间*/default void ready(ConfigurableApplicationContext context, Duration timeTaken) {running(context);}/*** 这是 `ready` 的过时版本,仅为了兼容性保留。* 当应用程序完全启动时调用* @param context Spring 应用程序上下文。* @deprecated 使用 {@link #ready(ConfigurableApplicationContext, Duration)} 替代。*/@Deprecateddefault void running(ConfigurableApplicationContext context) {}/*** 在应用程序启动失败时调用,用于执行失败时的处理逻辑,比如记录错误日志或资源清理。* @param context Spring 应用程序上下文。* @param exception 导致启动失败的异常。*/default void failed(ConfigurableApplicationContext context, Throwable exception) {}
}
在SpringBoot应用启动过程的关键阶段触发,包括starting(启动开始)
、environmentPrepared(环境准备完成)
、contextPrepared(上下文准备完成)
、contextLoaded(上下文加载完成)
、started(启动完成)
、ready(应用准备就绪)
和 failed(启动失败)
,以便在每个阶段执行自定义逻辑。
2、示例
下面是一个简单的 SpringApplicationRunListener
实现示例:
SpringBoot应用启动监听器需要SpringApplication和String[]参数,以便访问应用上下文和传递启动时的命令行参数,从而实现对启动事件的定制和响应。所以自定义的启动监听器也需要一个标准的构造函数,才能统一的创建SpringApplicationRunListener实例。
public class MyApplicationRunListener implements SpringApplicationRunListener {public MyApplicationRunListener(SpringApplication application, String[] args) {// 构造函数必须包含 SpringApplication 和 String[] 参数}@Overridepublic void starting() {System.out.println("应用启动开始...");}@Overridepublic void environmentPrepared(ConfigurableEnvironment environment) {System.out.println("环境已准备好...");}@Overridepublic void contextPrepared(ConfigurableApplicationContext context) {System.out.println("ApplicationContext 已准备完成...");}@Overridepublic void contextLoaded(ConfigurableApplicationContext context) {System.out.println("ApplicationContext 已加载...");}@Overridepublic void started(ConfigurableApplicationContext context, Duration timeTaken) {System.out.println("应用已启动...");}@Overridepublic void ready(ConfigurableApplicationContext context, Duration timeTaken) {System.out.println("应用正在运行...");}@Overridepublic void failed(ConfigurableApplicationContext context, Throwable exception) {System.out.println("应用启动失败:" + exception.getMessage());}
}
需要在META-INF/spring.factories
文件中进行注册:
org.springframework.boot.SpringApplicationRunListener=com.example.MyApplicationRunListener
启动服务
可以看到除了异常启动失败的触发,一共有6个触发的地方。本文就只介绍启动开始阶段
触发的操作。
三、事件和广播器
在进入启动方法之前,需要先了解下事件和广播器。
1、事件SpringApplicationEvent
1.1、介绍
SpringApplicationEvent
是SpringBoot框架中的一个重要概念,属于事件发布/订阅
机制的一部分。它允许应用程序在特定事件发生时发布事件
,其他组件可以订阅这些事件并做出相应的处理。这种机制提高了系统的解耦性和可扩展性。
类图如下:
1.1.1、EventObject
EventObject
是Java标准库中的类,是所有事件的通用基类
source
属性表示事件的来源对象
- 帮助监听器识别引发事件的对象
- 支持事件的上下文传递,使事件监听器可以基于来源执行不同逻辑
- source使EventObject成为一个通用的事件基类,支持多种事件类型的实现和处理
// 所有事件状态对象的根类。所有的事件对象都应从此类派生
public class EventObject implements Serializable {private static final long serialVersionUID = 5516075349620653480L;// 事件最初发生的对象。使用 transient 修饰符表明该字段不会被序列化。protected transient Object source;// 构造一个原型事件public EventObject(Object source) {// 检查 source 是否为 null,避免不合法的事件源if (source == null)throw new IllegalArgumentException("null source");// 设置事件的源对象this.source = source;}// 获取事件最初发生的对象public Object getSource() {return source;}// 返回该EventObject的字符串表示形式(包括类的名称和事件源信息)public String toString() {return getClass().getName() + "[source=" + source + "]";}
}
1.1.2、ApplicationEvent
ApplicationEvent
是所有Spring应用事件的基类,用于定义基础属性和行为timestamp
表示事件发生的时间
// 抽象类,应用事件的基类。所有应用事件都应扩展此类
public abstract class ApplicationEvent extends EventObject {private static final long serialVersionUID = 7099057708183571937L;// 事件发生的系统时间(时间戳)private final long timestamp;// 构造public ApplicationEvent(Object source) {// 调用父类 EventObject 的构造函数,传递事件源super(source);// 设置事件的时间戳,记录事件创建时的系统时间this.timestamp = System.currentTimeMillis();}// 此构造函数通常用于测试场景public ApplicationEvent(Object source, Clock clock) {// 调用父类 EventObject 的构造函数,传递事件源super(source);// 设置时间戳为由指定 Clock 提供的时间this.timestamp = clock.millis();}// 返回事件发生的时间public final long getTimestamp() {return this.timestamp;}
}
1.1.3、SpringApplicationEvent
- Spring应用事件的抽象基类,用于封装Spring应用程序启动时的事件信息
- 此类继承自ApplicationEvent,并增加了
命令行参数
信息
public abstract class SpringApplicationEvent extends ApplicationEvent {// 启动应用时传递的命令行参数private final String[] args;// 构造一个新的 SpringApplicationEventpublic SpringApplicationEvent(SpringApplication application, String[] args) {// 调用父类 ApplicationEvent 的构造方法,设置事件源为 SpringApplication 实例super(application);this.args = args;}// 获取触发此事件的 SpringApplication 实例public SpringApplication getSpringApplication() {// 将源对象强制转换为 SpringApplication 类型并返回return (SpringApplication) getSource();}// 获取启动应用时传递的命令行参数public final String[] getArgs() {return this.args;}
}
1.2、常见的子事件
- ApplicationStartingEvent
- 作用:这是SpringBoot事件机制的
第一个事件
,通常用于在应用启动时
初始化资源或配置项 - 触发时机:在SpringBoot应用开始启动时发布
- 作用:这是SpringBoot事件机制的
- ApplicationEnvironmentPreparedEvent
- 作用:此事件表明应用的环境已准备就绪,但上下文还没有创建。它常被用来处理与环境相关的配置和属性
- 触发时机:在
Environment准备完成
之后,ApplicationContext创建之前
发布
- ApplicationContextInitializedEvent
- 作用:该事件允许在ApplicationContext初始化后进行一些处理操作,比如为上下文设置额外的初始化参数
- 触发时机:在
ApplicationContext初始化
完成后发布
- ApplicationPreparedEvent
- 作用:此时应用的上下文已完全加载,可以在此事件中添加Bean或进行一些自定义配置
- 触发时机:在
ApplicationContext创建并加载完成
后,但还未刷新前发布
- ApplicationStartedEvent
- 作用:这是应用启动完成的标志,可以在此事件中处理启动后需要执行的任务
- 触发时机:在应用完全启动且
ApplicationContext已刷新
之后发布
- ApplicationReadyEvent
- 作用:用于表明应用已完全准备好,可以接受请求。通常用于启动后执行一次的任务,比如预加载某些资源
- 触发时机:在
应用启动并初始化完成
,准备处理请求时发布
- ApplicationFailedEvent
- 作用:用于处理启动失败的情况,可以在此事件中进行异常处理、资源清理或记录日志等
- 触发时机:在启动过程中遇到异常导致
启动失败
时发布
2、广播器ApplicationEventMulticaster
ApplicationEventMulticaster
的核心功能是管理监听器(ApplicationListener
)的注册和注销,以及将事件广播给合适的监听器
。
类图如下:默认唯一的抽象子类和实现类
2.1、ApplicationEventMulticaster
- 此接口用于管理多个应用监听器
ApplicationListener
,并将事件发布给它们 - 此接口定义了
添加
、移除
和广播事件给注册的监听器
的方法 - 监听器可以通过实例或Bean名称进行注册,并可以基于自定义的条件来移除
public interface ApplicationEventMulticaster {// 添加一个监听器实例,以接收所有事件通知void addApplicationListener(ApplicationListener<?> listener);// 通过指定Bean名称添加一个监听器Bean,以接收所有事件通知void addApplicationListenerBean(String listenerBeanName);// 从通知列表中移除一个监听器void removeApplicationListener(ApplicationListener<?> listener);// 通过指定 Bean 名称,从通知列表中移除一个监听器 Beanvoid removeApplicationListenerBean(String listenerBeanName);// 从已注册的实例集合中移除所有匹配的监听器(predicate是一个条件过滤器)void removeApplicationListeners(Predicate<ApplicationListener<?>> predicate);// 从已注册的监听器Bean名称集合中移除所有匹配的监听器 Bean(predicate是一个条件过滤器)void removeApplicationListenerBeans(Predicate<String> predicate);// 移除此广播器注册的所有监听器void removeAllListeners();// 将给定的应用事件广播到合适的监听器void multicastEvent(ApplicationEvent event);// 将给定的应用事件广播到合适的监听器,eventType为事件的类型void multicastEvent(ApplicationEvent event, @Nullable ResolvableType eventType);
}
2.2、AbstractApplicationEventMulticaster
- ApplicationEventMulticaster接口的抽象实现,提供基础的监听器注册功能
defaultRetriever
:用于直接管理监听器列表,支持实时更新,保证监听器信息的准确性retrieverCache
:提供缓存机制,通过事件类型和源类型匹配缓存的监听器列表,提高性能;每当监听器更新时被清空
,以确保缓存数据的一致性
public abstract class AbstractApplicationEventMulticasterimplements ApplicationEventMulticaster, BeanClassLoaderAware, BeanFactoryAware {// 默认监听器检索器private final DefaultListenerRetriever defaultRetriever = new DefaultListenerRetriever();// 用于缓存监听器检索的缓存Mapfinal Map<ListenerCacheKey, CachedListenerRetriever> retrieverCache = new ConcurrentHashMap<>(64);...// 添加监听器@Overridepublic void addApplicationListener(ApplicationListener<?> listener) {synchronized (this.defaultRetriever) {Object singletonTarget = AopProxyUtils.getSingletonTarget(listener);if (singletonTarget instanceof ApplicationListener) {this.defaultRetriever.applicationListeners.remove(singletonTarget);}this.defaultRetriever.applicationListeners.add(listener);this.retrieverCache.clear();}}// 添加监听器Bean@Overridepublic void addApplicationListenerBean(String listenerBeanName) {synchronized (this.defaultRetriever) {this.defaultRetriever.applicationListenerBeans.add(listenerBeanName);this.retrieverCache.clear();}}// 省略类似添加和移除方法...// defaultRetriever持有所有注册的监听器集合private class DefaultListenerRetriever {// 应用程序监听器的集合,存储直接注册的监听器实例public final Set<ApplicationListener<?>> applicationListeners = new LinkedHashSet<>();// 应用程序监听器的名称集合,存储监听器bean的名称,用于延迟加载public final Set<String> applicationListenerBeans = new LinkedHashSet<>();...}// retrieverCache持有所有注册的监听器集合private class CachedListenerRetriever {// 应用程序监听器的集合@Nullablepublic volatile Set<ApplicationListener<?>> applicationListeners;// 应用程序监听器的名称集合@Nullablepublic volatile Set<String> applicationListenerBeans;...}
}
2.3、SimpleApplicationEventMulticaster
- 将所有事件广播到所有已注册的监听器,由
监听器
来决定是否忽略它们不感兴趣的事件 - 默认情况下,所有监听器都在调用线程中
同步执行
,可以设置执行器使用线程池来处理
public class SimpleApplicationEventMulticaster extends AbstractApplicationEventMulticaster {// 任务执行器,用于异步执行监听器,默认为空(同步执行)@Nullableprivate Executor taskExecutor;// 错误处理器,用于处理监听器抛出的异常,默认为空@Nullableprivate ErrorHandler errorHandler;// 懒加载的日志记录器,用于在需要时记录日志@Nullableprivate volatile Log lazyLogger;// 创建一个新的 SimpleApplicationEventMulticaster 实例public SimpleApplicationEventMulticaster() {}// 创建SimpleApplicationEventMulticaster时候// 设置一个异步任务执行器,就可以实现多线程执行了public void setTaskExecutor(@Nullable Executor taskExecutor) {this.taskExecutor = taskExecutor;}...// 将给定的应用事件广播到合适的监听器(核心方法)@Overridepublic void multicastEvent(ApplicationEvent event) {multicastEvent(event, resolveDefaultEventType(event));}@Overridepublic void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));Executor executor = getTaskExecutor();// 获取符合条件的所有监听器并进行事件广播(包括匹配合适的监听器)for (ApplicationListener<?> listener : getApplicationListeners(event, type)) {if (executor != null) {// 如果有任务执行器,则使用执行器异步执行监听器executor.execute(() -> invokeListener(listener, event));} else {// 否则直接同步调用监听器invokeListener(listener, event);}}}// 调用给定的监听器并传递给它给定的事件protected void invokeListener(ApplicationListener<?> listener, ApplicationEvent event) {ErrorHandler errorHandler = getErrorHandler();if (errorHandler != null) {try {doInvokeListener(listener, event);} catch (Throwable err) {// 使用错误处理器处理异常errorHandler.handleError(err);}} else {doInvokeListener(listener, event);}}@SuppressWarnings({"rawtypes", "unchecked"})private void doInvokeListener(ApplicationListener listener, ApplicationEvent event) {try {// 调用监听器的核心方法listener.onApplicationEvent(event);} catch (ClassCastException ex) {...}}
}
四、启动方法
启动方法实际就是遍历调用应用启动监听器SpringApplicationRunListener实现类(只有一个EventPublishingRunListener
)的starting
方法。
1、广播事件到应用监听器
public class EventPublishingRunListener implements SpringApplicationRunListener, Ordered {// SpringApplication 对象,用于访问应用的配置信息和监听器private final SpringApplication application;// 启动参数private final String[] args;// 初始事件广播器,用于在启动阶段广播事件private final SimpleApplicationEventMulticaster initialMulticaster;/*** 初始化一个事件广播器,并将所有应用监听器添加到广播器中。*/public EventPublishingRunListener(SpringApplication application, String[] args) {this.application = application;this.args = args;// 初始化一个事件广播器this.initialMulticaster = new SimpleApplicationEventMulticaster();// 将 SpringApplication 中的所有监听器添加到初始广播器中for (ApplicationListener<?> listener : application.getListeners()) {// 实际调用AbstractApplicationEventMulticaster的添加方法this.initialMulticaster.addApplicationListener(listener);}}// 返回该监听器的执行顺序。数字越小,优先级越高@Overridepublic int getOrder() {return 0; // 优先级最高}// 在应用启动初期调用@Overridepublic void starting(ConfigurableBootstrapContext bootstrapContext) {// 将应用开始事件广播到合适的监听器this.initialMulticaster.multicastEvent(new ApplicationStartingEvent(bootstrapContext, this.application, this.args));}// 省略其他阶段的代码,后面走到对应流程在看具体操作...
}
- 接下来看下事件广播器
SimpleApplicationEventMulticaster
的广播方法multicastEvent
- 对于
事件匹配监听器
的方法在每个监听器中有定义
// 一个处理应用事件的监听器接口。
@FunctionalInterface
public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {// 响应应用事件的方法。当发布指定类型的事件时,该方法会被调用,// 以便执行相应的业务逻辑。void onApplicationEvent(E event);
}
2、根据事件类型匹配监听器
- 匹配监听器方法
getApplicationListeners
,会遍历匹配每个监听器,直接定位核心方法 - 检查监听器是否支持指定的
事件类型
和来源类型
smartListener.supportsEventType(eventType)
: 验证监听器是否支持指定的事件类型smartListener.supportsSourceType(sourceType)
: 验证监听器是否支持指定的事件来源类型
// AbstractApplicationEventMulticaster类方法
protected boolean supportsEvent(ApplicationListener<?> listener, ResolvableType eventType, @Nullable Class<?> sourceType) {// 检查监听器是否为 GenericApplicationListener 类型// 如果是,则直接使用;如果不是,则将其包装为 GenericApplicationListenerAdapterGenericApplicationListener smartListener = (listener instanceof GenericApplicationListener ?(GenericApplicationListener) listener : new GenericApplicationListenerAdapter(listener));// 检查监听器是否支持指定的事件类型和来源类型// smartListener.supportsEventType(eventType): 验证监听器是否支持指定的事件类型// smartListener.supportsSourceType(sourceType): 验证监听器是否支持指定的事件来源类型return (smartListener.supportsEventType(eventType) && smartListener.supportsSourceType(sourceType));
}
监听器分为两种形式,实现ApplicationListener<指定事件类型>
或实现GenericApplicationListener
(通过supportsEventType方法-支持事件类型和supportsSourceType方法-支持事件来源)。
2.1、实现ApplicationListener<指定事件类型>
如果监听器是普通方式实现ApplicationListener<指定事件类型>,那么会将监听器包装为GenericApplicationListenerAdapter,核心内容就是解析出指定事件类型的实际类型
。
验证监听器是否支持指定的事件类型
GenericApplicationListenerAdapter
实现了GenericApplicationListener
的支持事件类型方法supportsEventType
isAssignableFrom
方表示当前类是否可以表示为指定类的超类或接口
验证监听器是否支持指定的事件来源类型
- 如果是常规ApplicationListener<指定事件类型>方式,所有事件来源都支持
- 只有实际类型为SmartApplicationListener,才会去匹配事件来源
2.2、实现GenericApplicationListener
如果监听器是实现GenericApplicationListener方法,那么匹配事件类型和来源都在监听器内部实现
,如下以LoggingApplicationListener例如下:
3、匹配到的监听器
LoggingApplicationListener
用于初始化日志系统,根据application.properties
或环境配置设置日志级别和格式(Spring Boot 的日志系统初始化通常是由该监听器负责)。具体内容后续文章单独讲。
至于BackgroundPreinitializer和DelegatingApplicationListener虽然匹配上了,但是这个启动开始阶段什么都没有做,后续其他阶段有操作时候再说。
总结
- 入口分析:
- 介绍了
SpringApplication
类中的run
方法,其中应用启动监听器
的获取
和启动
是运行过程中的第一个重要步骤 - 获取的应用启动监听器为
SpringApplicationRunListener
,该接口可以在应用启动的各个阶段执行自定义逻辑
- 介绍了
- SpringApplicationRunListener详细分析:
SpringApplicationRunListener
接口允许监听启动的多个阶段,包括starting
、environmentPrepared
、contextPrepared
等- 举例说明了如何实现一个自定义的
SpringApplicationRunListener
,并在META-INF/spring.factories
中进行注册以加入启动流程
- 事件和广播器分析:
- 分析了Spring事件机制中
SpringApplicationEvent
系列事件类型及其触发时机,分别对应应用的不同启动阶段 - 介绍了
ApplicationEventMulticaster
广播器的结构和工作原理。它通过SimpleApplicationEventMulticaster
将事件广播给符合条件的监听器,支持同步和异步广播
- 分析了Spring事件机制中
- 启动方法解析:
- 通过
EventPublishingRunListener
来广播事件,其中SimpleApplicationEventMulticaster
实现了事件的广播 - 详细介绍了事件与监听器的匹配规则,监听器可通过实现
ApplicationListener<指定事件类型>
或GenericApplicationListener
来适配特定事件类型,监听器匹配时会检查事件类型和来源类型的支持性 - 总结一句话:启动方法就是匹配监听器并执行
- 通过
- 匹配到的监听器:
- 对
启动开始
阶段中匹配到的监听器做了分类说明,如LoggingApplicationListener
负责初始化日志系统,其余监听器在此阶段不执行操作
- 对