SpringBoot核心原理之事件和监听器(生命周期监听、事件触发、监听器、自定义事件发布和订阅)和配置类和Bean加载的时机

最新推荐文章于 2024-05-10 07:26:04 发布
最新推荐文章于 2024-05-10 07:26:04 发布
阅读量1.9k 收藏 26
点赞数 15
分类专栏： # SpringBoot 文章标签： spring boot 事件和监听器 生命周期监听 自定义事件发布和订阅 配置类和Bean加载的时机
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/yy8623977/article/details/131899892
版权

目录

1. 生命周期监听

场景：监听应用从创建到销毁的整个生命周期。这样可以在应用启动之前，或启动之后做一些操作

1.1 监听器-SpringApplicationRunListener

  • springboot在spring-boot.jar中配置了默认的Listener，如下所示：
org.springframework.boot.SpringApplicationRunListener=\
org.springframework.boot.context.event.EventPublishingRunListener

用于事件发布。在生命周期的各个重要环节，都会将事件进行广播，如果我们对那个事件比较关系，可以继续监听

  • 自定义SpringApplicationRunListener来监听事件
    1. 编写SpringApplicationRunListener实现类。可以自己实现一个有参构造器，接受两个参数(SpringApplication application, String[] args)
    2. 在META-INF/spring.factories中配置org.springframework.boot.SpringApplicationRunListener=自己的Listener全类名

自定义示例如下：
MyAppListener.java

package com.hh.springboot3test.listener;

import org.springframework.boot.ConfigurableBootstrapContext;
import org.springframework.boot.SpringApplicationRunListener;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.ConfigurableEnvironment;

import java.time.Duration;

public class MyAppListener implements SpringApplicationRunListener {
    @Override
    public void starting(ConfigurableBootstrapContext bootstrapContext) {
        System.out.println("=====starting=====正在启动======");
    }

    @Override
    public void environmentPrepared(ConfigurableBootstrapContext bootstrapContext, ConfigurableEnvironment environment) {
        System.out.println("=====environmentPrepared=====环境准备完成======");
    }

    @Override
    public void contextPrepared(ConfigurableApplicationContext context) {
        System.out.println("=====contextPrepared=====ioc容器准备完成======");
    }

    @Override
    public void contextLoaded(ConfigurableApplicationContext context) {
        System.out.println("=====contextLoaded=====ioc容器加载完成======");
    }

    @Override
    public void started(ConfigurableApplicationContext context, Duration timeTaken) {
        System.out.println("=====started=====启动完成======");
    }

    @Override
    public void ready(ConfigurableApplicationContext context, Duration timeTaken) {
        System.out.println("=====ready=====准备就绪======");
    }

    @Override
    public void failed(ConfigurableApplicationContext context, Throwable exception) {
        System.out.println("=====failed=====应用启动失败======");
    }
}

src\main\resources\META-INF\spring.factories

org.springframework.boot.SpringApplicationRunListener=com.hh.springboot3test.listener.MyAppListener

启动springBoot应用，打印如下：

E:\install_software\java\zulu17.42.19-ca-jdk17.0.7-win_x64\bin\java.exe -XX:TieredStopAtLevel=1 -Dspring.output.ansi.enabled=always -Dcom.sun.management.jmxremote -Dspring.jmx.enabled=true -Dspring.liveBeansView.mbeanDomain -Dspring.application.admin.enabled=true -javaagent:E:\install_software\IDEA\lib\idea_rt.jar=58974:E:\install_software\IDEA\bin -Dfile.encoding=UTF-8 -classpath D:\20230205备份\正使用文件\springBoot3Test\target\classes;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-starter-web\3.1.1\spring-boot-starter-web-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-starter-json\3.1.1\spring-boot-starter-json-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\datatype\jackson-datatype-jdk8\2.15.2\jackson-datatype-jdk8-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\datatype\jackson-datatype-jsr310\2.15.2\jackson-datatype-jsr310-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\module\jackson-module-parameter-names\2.15.2\jackson-module-parameter-names-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-starter-tomcat\3.1.1\spring-boot-starter-tomcat-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\tomcat\embed\tomcat-embed-core\10.1.10\tomcat-embed-core-10.1.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\tomcat\embed\tomcat-embed-el\10.1.10\tomcat-embed-el-10.1.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\tomcat\embed\tomcat-embed-websocket\10.1.10\tomcat-embed-websocket-10.1.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-web\6.0.10\spring-web-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-beans\6.0.10\spring-beans-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\io\micrometer\micrometer-observation\1.11.1\micrometer-observation-1.11.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\io\micrometer\micrometer-commons\1.11.1\micrometer-commons-1.11.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-webmvc\6.0.10\spring-webmvc-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-aop\6.0.10\spring-aop-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-context\6.0.10\spring-context-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-expression\6.0.10\spring-expression-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\projectlombok\lombok\1.18.28\lombok-1.18.28.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\slf4j\slf4j-api\2.0.7\slf4j-api-2.0.7.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-core\6.0.10\spring-core-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\spring-jcl\6.0.10\spring-jcl-6.0.10.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-starter\3.1.1\spring-boot-starter-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot\3.1.1\spring-boot-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-autoconfigure\3.1.1\spring-boot-autoconfigure-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\jakarta\annotation\jakarta.annotation-api\2.1.1\jakarta.annotation-api-2.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\yaml\snakeyaml\1.33\snakeyaml-1.33.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-starter-log4j2\3.1.1\spring-boot-starter-log4j2-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\logging\log4j\log4j-slf4j2-impl\2.20.0\log4j-slf4j2-impl-2.20.0.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\logging\log4j\log4j-api\2.20.0\log4j-api-2.20.0.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\logging\log4j\log4j-core\2.20.0\log4j-core-2.20.0.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\apache\logging\log4j\log4j-jul\2.20.0\log4j-jul-2.20.0.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\webjars\jquery\3.6.4\jquery-3.6.4.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\dataformat\jackson-dataformat-xml\2.15.2\jackson-dataformat-xml-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\core\jackson-core\2.15.2\jackson-core-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\core\jackson-annotations\2.15.2\jackson-annotations-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\jackson\core\jackson-databind\2.15.2\jackson-databind-2.15.2.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\codehaus\woodstox\stax2-api\4.2.1\stax2-api-4.2.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\com\fasterxml\woodstox\woodstox-core\6.5.1\woodstox-core-6.5.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\springframework\boot\spring-boot-starter-thymeleaf\3.1.1\spring-boot-starter-thymeleaf-3.1.1.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\thymeleaf\thymeleaf-spring6\3.1.1.RELEASE\thymeleaf-spring6-3.1.1.RELEASE.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\thymeleaf\thymeleaf\3.1.1.RELEASE\thymeleaf-3.1.1.RELEASE.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\attoparser\attoparser\2.0.6.RELEASE\attoparser-2.0.6.RELEASE.jar;E:\install_software\maven\apache-maven-3.8.6\repository\org\unbescape\unbescape\1.1.6.RELEASE\unbescape-1.1.6.RELEASE.jar com.hh.springboot3test.SpringBoot3TestApplication
=====starting=====正在启动======
=====environmentPrepared=====环境准备完成======

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v3.1.1)

=====contextPrepared=====ioc容器准备完成======
2023-07-24T18:19:05.215+08:00  INFO 22832 --- [           main] c.h.s.SpringBoot3TestApplication         : Starting SpringBoot3TestApplication using Java 17.0.7 with PID 22832 (D:\20230205备份\正使用文件\springBoot3Test\target\classes started by hehuan48495 in D:\20230205备份\正使用文件\springBoot3Test)
2023-07-24T18:19:05.220+08:00  INFO 22832 --- [           main] c.h.s.SpringBoot3TestApplication         : No active profile set, falling back to 1 default profile: "default"
=====contextLoaded=====ioc容器加载完成======
2023-07-24T18:19:05.805+08:00  INFO 22832 --- [           main] o.s.b.w.e.t.TomcatWebServer              : Tomcat initialized with port(s): 8080 (http)
2023-07-24T18:19:05.813+08:00  INFO 22832 --- [           main] o.a.c.c.StandardService                  : Starting service [Tomcat]
2023-07-24T18:19:05.813+08:00  INFO 22832 --- [           main] o.a.c.c.StandardEngine                   : Starting Servlet engine: [Apache Tomcat/10.1.10]
2023-07-24T18:19:05.876+08:00  INFO 22832 --- [           main] o.a.c.c.C.[.[.[/]                        : Initializing Spring embedded WebApplicationContext
2023-07-24T18:19:05.876+08:00  INFO 22832 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 631 ms
2023-07-24T18:19:06.141+08:00  INFO 22832 --- [           main] o.s.b.w.e.t.TomcatWebServer              : Tomcat started on port(s): 8080 (http) with context path ''
2023-07-24T18:19:06.147+08:00  INFO 22832 --- [           main] c.h.s.SpringBoot3TestApplication         : Started SpringBoot3TestApplication in 1.243 seconds (process running for 1.723)
=====started=====启动完成======
=====ready=====准备就绪======

1.2 生命周期全流程

生命周期

源码分析如下：

public class SpringApplication {
......省略部分......
	public ConfigurableApplicationContext run(String... args) {
		long startTime = System.nanoTime();
		// =====================================listeners.starting==============================
		// 1. 创建bootstrapContext
		DefaultBootstrapContext bootstrapContext = createBootstrapContext();
		ConfigurableApplicationContext context = null;
		configureHeadlessProperty();
		// 2. 获取run listeners。从spring.factories加载SpringApplicationRunListener类的所有监听器
		SpringApplicationRunListeners listeners = getRunListeners(args);
		// 3. 遍历调用所有listener的starting方法
		listeners.starting(bootstrapContext, this.mainApplicationClass);
		try {
			ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
			// =====================================listeners.environmentPrepared==============================
			// 准备环境。先将应用的各种参数绑定到环境变量，再在方法内部会【执行一次】listeners.environmentPrepared方法
			ConfigurableEnvironment environment = prepareEnvironment(listeners, bootstrapContext, applicationArguments);
			Banner printedBanner = printBanner(environment);
			// =====================================listeners.contextPrepared==============================
			// 1. 创建IOC容器
			context = createApplicationContext();
			context.setApplicationStartup(this.applicationStartup);
			// 2. 准备IOC容器。准备好后会【执行一次】listeners.contextPrepared，然后会执行bootstrapContext.close关闭引导上下文
			// =====================================listeners.contextLoaded==============================
			// 在prepareContext执行完前面的步骤后，先将核心的组件添加到IOC容器，然后再执行listeners.contextLoaded
			// 此时sources（主配置类）已加载，但是配置类中的Bean还未创建
			prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
			// =====================================listeners.started==============================
			// 1. 进行IOC容器经典的刷新十二大步。所有Bean进行创造
			refreshContext(context);
			afterRefresh(context, applicationArguments);
			Duration timeTakenToStartup = Duration.ofNanos(System.nanoTime() - startTime);
			if (this.logStartupInfo) {
				new StartupInfoLogger(this.mainApplicationClass).logStarted(getApplicationLog(), timeTakenToStartup);
			}
			// 2. 【执行一次】listeners.started
			listeners.started(context, timeTakenToStartup);
			// =====================================listeners.ready==============================
			// 1. 调用runner调用
			callRunners(context, applicationArguments);
		}
		catch (Throwable ex) {
			if (ex instanceof AbandonedRunException) {
				throw ex;
			}
			// =====================================listeners.failed==============================
			// 如果失败，在方法内部【第一次】调用listeners.failed
			handleRunFailure(context, ex, listeners);
			throw new IllegalStateException(ex);
		}
		try {
			if (context.isRunning()) {
				Duration timeTakenToReady = Duration.ofNanos(System.nanoTime() - startTime);
				// 2. 在run方法完毕前，执行listeners.ready
				listeners.ready(context, timeTakenToReady);
			}
		}
		catch (Throwable ex) {
			if (ex instanceof AbandonedRunException) {
				throw ex;
			}
			// =====================================listeners.failed==============================
			// 如果失败，在方法内部【第二次】调用listeners.failed
			handleRunFailure(context, ex, null);
			throw new IllegalStateException(ex);
		}
		return context;
	}
......省略部分......
}

2. 事件触发时机

2.1 各种回调监听器

  • BootstrapRegistryInitializer： 感知引导初始化特定阶段
    • 从META-INF/spring.factories加载
    • 也可以使用SpringApplication.addBootstrapRegistryInitializer();添加自定义的类
    • 创建引导上下文bootstrapContext的时候触发
    • 场景：项目启动的时候，进行密钥校对授权
	public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
		this.resourceLoader = resourceLoader;
		Assert.notNull(primarySources, "PrimarySources must not be null");
		this.primarySources = new LinkedHashSet<>(Arrays.asList(primarySources));
		this.webApplicationType = WebApplicationType.deduceFromClasspath();
		// 从spring.factories加载BootstrapRegistryInitializer
		this.bootstrapRegistryInitializers = new ArrayList<>(
				getSpringFactoriesInstances(BootstrapRegistryInitializer.class));
		// 从spring.factories加载ApplicationContextInitializer
		setInitializers((Collection) getSpringFactoriesInstances(ApplicationContextInitializer.class));
		// 从spring.factories加载ApplicationListener
		setListeners((Collection) getSpringFactoriesInstances(ApplicationListener.class));
		this.mainApplicationClass = deduceMainApplicationClass();
	}
  • ApplicationContextInitializer： 感知ioc容器初始化特定阶段。加载方式如下：
    1. 从META-INF/spring.factories加载
    2. 使用SpringApplication.addInitializers();添加自定义的类
  • ApplicationListener： 感知全阶段生命周期 + 基于事件机制，感知事件。 一旦到了哪个阶段可以做别的事。类似于AOP的基本通知(前置、后置、返回、异常)。9大事件后面会讲。加载方式如下：
    1. @Bean或@EventListener(事件驱动)
    2. 使用SpringApplication.addListeners(…)或SpringApplicationBuilder.listeners(…)添加自定义的类
    3. 从META-INF/spring.factories加载
  • SpringApplicationRunListener： 感知全阶段生命周期 + 各种阶段都能自定义操作，功能更完善。类似于AOP的环绕通知
    • 从META-INF/spring.factories加载
  • ApplicationRunner: 感知应用就绪Ready特定阶段。应用卡死，就不会就绪。后面具体会讲
    • 通过@Bean加载
  • CommandLineRunner： 感知应用就绪Ready特定阶段。应用卡死，就不会就绪ApplicationListener
    • 通过@Bean加载

2.2 九大事件触发流程

  1. 先自定义ApplicationListener感知各个事件

MyListener.java

package com.hh.springboot3test.listener;

import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;


public class MyListener implements ApplicationListener<ApplicationEvent> {
    @Override
    public void onApplicationEvent(ApplicationEvent event) {
        System.out.println("=====事件====到达====" + event + "=====");
    }
}

src\main\resources\META-INF\spring.factories添加

org.springframework.context.ApplicationListener=com.hh.springboot3test.listener.MyListener
  1. 自定义ApplicationRunner和CommandLineRunner

RunnerConfig.java

package com.hh.springboot3test.config;

import org.springframework.boot.ApplicationRunner;
import org.springframework.boot.CommandLineRunner;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


@Configuration
public class RunnerConfig {

    @Bean
    public ApplicationRunner applicationRunner(){

        return args -> {
            System.out.println("===ApplicationRunner=====运行了=====");
        };
    }

    @Bean
    public CommandLineRunner commandLineRunner(){
        return args -> {
            System.out.println("===CommandLineRunner=====运行了=====");
        };
    }
}

启动springboot应用，打印如下：

=====事件====到达====org.springframework.boot.context.event.ApplicationStartingEvent[source=org.springframework.boot.SpringApplication@1787f2a0]=====
=====starting=====正在启动======
=====事件====到达====org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent[source=org.springframework.boot.SpringApplication@1787f2a0]=====
=====environmentPrepared=====环境准备完成======

  .   ____          _            __ _ _
 /\\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/  ___)| |_)| | | | | || (_| |  ) ) ) )
  '  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::                (v3.1.1)

=====事件====到达====org.springframework.boot.context.event.ApplicationContextInitializedEvent[source=org.springframework.boot.SpringApplication@1787f2a0]=====
=====contextPrepared=====ioc容器准备完成======
2023-07-25T10:41:41.064+08:00  INFO 13056 --- [           main] c.h.s.SpringBoot3TestApplication         : Starting SpringBoot3TestApplication using Java 17.0.7 with PID 13056 (D:\20230205备份\正使用文件\springBoot3Test\target\classes started by hehuan48495 in D:\20230205备份\正使用文件\springBoot3Test)
2023-07-25T10:41:41.069+08:00  INFO 13056 --- [           main] c.h.s.SpringBoot3TestApplication         : No active profile set, falling back to 1 default profile: "default"
=====事件====到达====org.springframework.boot.context.event.ApplicationPreparedEvent[source=org.springframework.boot.SpringApplication@1787f2a0]=====
=====contextLoaded=====ioc容器加载完成======
2023-07-25T10:41:41.622+08:00  INFO 13056 --- [           main] o.s.b.w.e.t.TomcatWebServer              : Tomcat initialized with port(s): 8080 (http)
2023-07-25T10:41:41.631+08:00  INFO 13056 --- [           main] o.a.c.c.StandardService                  : Starting service [Tomcat]
2023-07-25T10:41:41.631+08:00  INFO 13056 --- [           main] o.a.c.c.StandardEngine                   : Starting Servlet engine: [Apache Tomcat/10.1.10]
2023-07-25T10:41:41.691+08:00  INFO 13056 --- [           main] o.a.c.c.C.[.[.[/]                        : Initializing Spring embedded WebApplicationContext
2023-07-25T10:41:41.691+08:00  INFO 13056 --- [           main] w.s.c.ServletWebServerApplicationContext : Root WebApplicationContext: initialization completed in 597 ms
2023-07-25T10:41:41.936+08:00  INFO 13056 --- [           main] o.s.b.w.e.t.TomcatWebServer              : Tomcat started on port(s): 8080 (http) with context path ''
=====事件====到达====org.springframework.boot.web.servlet.context.ServletWebServerInitializedEvent[source=org.springframework.boot.web.embedded.tomcat.TomcatWebServer@661d6bb6]=====
=====事件====到达====org.springframework.context.event.ContextRefreshedEvent[source=org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@43ed0ff3, started on Tue Jul 25 10:41:41 CST 2023]=====
2023-07-25T10:41:41.942+08:00  INFO 13056 --- [           main] c.h.s.SpringBoot3TestApplication         : Started SpringBoot3TestApplication in 1.168 seconds (process running for 1.631)
=====事件====到达====org.springframework.boot.context.event.ApplicationStartedEvent[source=org.springframework.boot.SpringApplication@1787f2a0]=====
=====事件====到达====org.springframework.boot.availability.AvailabilityChangeEvent[source=org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@43ed0ff3, started on Tue Jul 25 10:41:41 CST 2023]=====
=====started=====启动完成======
===ApplicationRunner=====运行了=====
===CommandLineRunner=====运行了=====
=====事件====到达====org.springframework.boot.context.event.ApplicationReadyEvent[source=org.springframework.boot.SpringApplication@1787f2a0]=====
=====事件====到达====org.springframework.boot.availability.AvailabilityChangeEvent[source=org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@43ed0ff3, started on Tue Jul 25 10:41:41 CST 2023]=====
=====ready=====准备就绪======

整体的流程如下图所示：

启动时机

9大事件触发顺序总结：

  1. ApplicationStartingEvent：应用启动但未做任何事情, 除了注册listeners和initializers
  2. ApplicationEnvironmentPreparedEvent： Environment准备好，但context未创建.
  3. ApplicationContextInitializedEvent: ApplicationContext准备好，ApplicationContextInitializers调用，但是任何bean未加载
  4. ApplicationPreparedEvent： 容器刷新之前，bean定义信息加载
  5. ApplicationStartedEvent： 容器刷新完成， runner未调用
  6. AvailabilityChangeEvent： LivenessState.CORRECT应用存活探针，但还不能接收请求。用于K8S
  7. ApplicationReadyEvent: 所有runner被调用
  8. AvailabilityChangeEvent：ReadinessState.ACCEPTING_TRAFFIC应用就绪探针，可以接请求。用于K8S
  9. ApplicationFailedEvent ：如果启动出错

2.3 最佳实战

  • 如果项目启动前做事： BootstrapRegistryInitializer和ApplicationContextInitializer
  • 如果想要在项目启动完成后做事：ApplicationRunner和CommandLineRunner
  • 如果要干涉生命周期做事：SpringApplicationRunListener
  • 如果想要用事件机制：ApplicationListener

2.4 SpringBoot应用运行的事件发布和订阅开发

应用运行中的事件发布和订阅，可以实现无数种。形成事件驱动模型

核心原理如下。符合设计模式的开闭原则：对新增开放，对修改关闭

  • 事件发布者：实现ApplicationEventPublisherAware或ApplicationEventMulticaster，然后注入到IOC容器中
  • 事件监听者：通过在组件中再添加@EventListener注解，或实现ApplicationListener，监听指定类型的ApplicationEvent

核心原理

实战如下：

UserEntity.java：定义用户的信息

package com.hh.springboot3test.entity;


import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@AllArgsConstructor
@NoArgsConstructor
@Data
public class UserEntity {

    private String uname;
    private String passwd;
}

LoginSuccessEvent.java：实现ApplicationEvent抽象类，定义一个事件类型

package com.hh.springboot3test.event;

import com.hh.springboot3test.entity.UserEntity;
import org.springframework.context.ApplicationEvent;


public class LoginSuccessEvent extends ApplicationEvent {

    /**
     * @param source: 登录成功的人
     */
    public LoginSuccessEvent(UserEntity source) {
        super(source);
    }
}

EventPublisher.java：实现了ApplicationEventPublisherAware，会自动完成两件事情。从而具有事件发布功能

  1. 方法setApplicationEventPublisher会被自动调用
  2. 会自动把底层发布事件的组件ApplicationEventPublisher注入进入参
package com.hh.springboot3test.event;

import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Service;


@Service
public class EventPublisher implements ApplicationEventPublisherAware {

    ApplicationEventPublisher applicationEventPublisher;

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
        this.applicationEventPublisher = applicationEventPublisher;
    }

    /**
     * 将事件广播出去。所有监听这个事件的监听器都可以收到
     */
    public void sendEvent(ApplicationEvent event) {
        applicationEventPublisher.publishEvent(event);
    }


}

LoginController.java：模拟用户登录，创建事件信息，再发送事件

package com.hh.springboot3test.controller;

import com.hh.springboot3test.entity.UserEntity;
import com.hh.springboot3test.event.EventPublisher;
import com.hh.springboot3test.event.LoginSuccessEvent;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class LoginController {

    @Autowired
    EventPublisher eventPublisher;

    @GetMapping("/login")
    public String login(@RequestParam("uname") String uname,
                        @RequestParam("passwd") String passwd) {
        // 业务处理登录
        System.out.println("=====业务处理登录完成======");

        // 如果是分布式服务，可以发布分布式事件
        LoginSuccessEvent event = new LoginSuccessEvent(new UserEntity(uname, passwd));
        eventPublisher.sendEvent(event);

        return uname + "登录成功";
    }
}

AccountService.java：订阅事件方式一：实现ApplicationListener接口，泛型为监听的事件类型。onApplicationEvent方法监听到新事件时自动调用

@Order注解用于方法和类上都可以，数字越小优先级越高。默认按类称排序

package com.hh.springboot3test.service;


import com.hh.springboot3test.entity.UserEntity;
import com.hh.springboot3test.event.LoginSuccessEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Service;


@Order(1)
@Service
public class AccountService implements ApplicationListener<LoginSuccessEvent> {

    // 模拟积分功能
    public void addAccountScore(String uname) {
        System.out.println(uname + "加了1分");
    }

    @Override
    public void onApplicationEvent(LoginSuccessEvent event) {
        System.out.println("=====AccountService======收到事件=====");

        UserEntity source = (UserEntity) event.getSource();
        addAccountScore(source.getUname());
    }
}

CouponService.java：订阅事件方式二：在自定义方法上使用@EventListener注解，参数为监听的事件类型。监听到新事件时方法自动调用

package com.hh.springboot3test.service;

import com.hh.springboot3test.entity.UserEntity;
import com.hh.springboot3test.event.LoginSuccessEvent;
import org.springframework.context.event.EventListener;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Service;

@Service
public class CouponService {

    public void sendCoupon(String uname) {
        System.out.println(uname + "随机得到了一张优惠券");
    }

    @Async  // 需要在主程序上使用@EnableAsync开启异步功能
    @Order(2)
    @EventListener
    public void myEventMethod(LoginSuccessEvent event) {
        System.out.println("=====CouponService======收到事件=====");

        UserEntity source = (UserEntity) event.getSource();
        sendCoupon(source.getUname());
    }


}

访问http://localhost:8080/login?uname=jim&passwd=abc。页面显示如下：
登录页面

控制台打印如下：

=====业务处理登录完成======
=====事件====到达====com.hh.springboot3test.event.LoginSuccessEvent[source=UserEntity(uname=jim, passwd=abc)]=====
=====AccountService======收到事件=====
jim加了1分
=====CouponService======收到事件=====
jim随机得到了一张优惠券
=====事件====到达====ServletRequestHandledEvent: url=[/login]; client=[0:0:0:0:0:0:0:1]; method=[GET]; servlet=[dispatcherServlet]; session=[null]; user=[null]; time=[32ms]; status=[OK]=====

可以看到，LoginController能发布事件，AccountService和CouponService能监听到事件

我们前面实现的MyListener，也能监听到LoginController发布的事件。同时能监听到ServletRequestHandledEvent

3. 配置类和Bean加载的时机

自动配置类、配置类、Bean加载的时机，可以看下图

配置类和Bean加载的时机

Bulut0907
关注
  • 15
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot Application事件监听的实现方案
08-26
SpringBoot Application事件监听是指在SpringBoot应用程序的生命周期中，监听和处理各种事件的机制。这种机制可以帮助开发者在应用程序的不同阶段执行特定的操作，例如在应用程序启动时执行某些初始化操作，或者在...
Tomcat和Spring中的事件机制深入讲解
08-26
事件机制的核心思想是观察者模式，其中包含三个基本元素：事件源(EventSource)、事件(EventObject)和事件监听器(EventListener)。 【JDK中的事件机制】 Java标准库提供了内置的事件机制支持，主要由以下三个接口...
SpringBoot的生命周期 SpringBoot监听器在生命周期中的作用时间和顺序 SpringBoot 监听机制 SpringApplicationRunListener
GHZ2443063059的博客
02-24 510
SpringBoot的生命周期 SpringBoot监听器在生命周期中的作用时间和顺序 SpringBoot 监听机制 SpringApplicationRunListener
Spring监听器用法与原理详解(带ApplicationListener模型图)
战斧的博客
05-25 1万+
相信大家都或多或少知道Spring中的监听器，有些人还能说出它采用了观察者模式，但其实它还用到了适配器模式工厂模式等。当然，仍有不少人是完全不了解Spring的监听及其机制的，本次我们就来深入学习一下Spring监听器观察者模式（Observer Pattern）是一种行为设计模式，它用于在对象之间建立一对多的依赖关系。在该模式中，当一个对象的状态发生变化时，它会自动通知其依赖对象（称为观察者），使它们能够自动更新主题对象维护一个观察者列表，并提供方法用于添加和删除观察者。当主题的状态发生变化时，它会。
SpringBoot的监听器
最新发布
qq_35643146的博客
05-10 799
要想顺利的创建监听器，并起作用，这个过程中需要这样几个角色：1、事件（event）可以封装和传递监听器中要处理的参数，如对象或字符串，并作为监听器中监听的目标。2、监听器（listener）具体根据事件发生的业务处理模块，这里可以接收处理事件中封装的对象或字符串。3、事件发布者（publisher）事件发生的触发者。定义事件首先，我们需要定义一个事件（MyTestEvent)，需要继承Spring的/***/return msg;定义监听器。
Spring 中的事件监听机制
swadian2008的博客
11-28 4540
ApplicationContext 中的事件处理是通过ApplicationEvent 类和ApplicationListener 接口实现的。如果一个 Bean（监听器实例）实现了ApplicationListener 接口，并被部署到 Spring 容器中，那么每次在容器中发布一个ApplicationEvent 事件，该 Bean （监听器实例）都会被通知到。本质上，这种机制就是一个观察者的设计模式。
Spring监听器
热门推荐
骑个小蜗牛的博客
12-13 1万+
事件监听概念 应用程序事件允许我们发送和接收特定事件，我们可以根据需要处理这些事件。事件用于在松散耦合的组件之间交换信息。由于发布者和订阅者之间没有直接耦合，因此可以在不影响发布者的情况下修改订阅者，反之亦然。 事件监听三要素 事件源：事件对象的产生者，任何一个事件都有一个来源 ApplicationEvent 事件监听器：事件框架或组件收到一个事件后，需要通知所有相关的事件监听器来进行处理。这些监听器统一存储在事件监听器注册表中。 ApplicationListener（编码式事件监听器） @Event
Spring中的事件监听
技术积累，技术分享
05-16 3878
案例分析引入事件监听 首先我们假定一个场景，我们此时有一个登录的功能，根据用户名和密码进行登录。然后此时想要添加一个新的功能，如果一个用户登录成功就给这个用户发送短信提醒该用户（正常情况是异地登录才会发送短信提醒，这里为了简化需求，只要登录就发送短信提醒用户） 我们先来看一种实现方式： // 注意这里是伪代码 public void login(String username, String password) { if(根据username查看数据库当中是否有这个用户) { 获取这个用户的数据库中的
【Spring | 事件监听详解】
爱媳妇儿爱编程
06-30 3880
Spring 事件监听详解
SpringBoot监听器
05-28
在Spring Boot应用中，监听器（Listeners）是用于监听应用程序上下文（ApplicationContext）或特定事件的组件，它们在特定的生命周期阶段执行相应的操作。Spring框架提供了丰富的监听器接口，允许开发者扩展应用程序...
spring监听器共20页.pdf.zip
10-28
在Spring应用中，监听器可以通过实现特定接口或者通过配置XML来定义，它们能够帮助开发者在应用程序的生命周期中执行特定的任务，例如初始化、销毁bean，或者监控应用状态等。以下是关于Spring监听器的详细知识点： ...
spring的Applicationcontext对事件的监听，实现类似MQ的效果
08-29
在Spring框架中，`ApplicationContext`不仅是一个容器，用于管理Bean的生命周期和依赖注入，它还提供了事件发布和监听的功能。这个特性使得Spring应用能够实现组件间的异步通信，类似于消息队列（MQ）的工作模式。...
Spring事件监听
Shawn的个人博客
07-29 1359
Spring的事件监听机制和发布订阅机制是很相似的发布了一个事件后，监听该类型事件的所有监听器会触发相应的处理逻辑。正如Spring官方文档上所说的，整个上就是一个观察者的模式。那么，我们不妨猜测下，Spring是如何来实现事件发布监听的底层使用一个集合存储了所有的监听器，当发布了一个事件后，遍历事件监听器集合，然后过滤符合事件类型的监听器，最后触发相应的事件处理逻辑。//必须继承实现publicMyEvent(Objectsource,Stringmsg){}}...
springboot(2)生命周期和监听器
zhaocuit的博客
10-31 9236
Spring boot应用,这里具体的来说，是指类SpringApplication,在其run()方法运行过程中，主要围绕所使用ApplicationContext对象的生命周期事件，应用了一个事件监听器机制提供了相应的程序扩展入口点，开发人员可以基于此机制，在相应的事件发生时执行特定的逻辑。 SpringApplication应用的该事件监听器机制主要利用如下两个类/接口 : Spring...
详解Spring事件监听
宋小黑的博客
01-14 1258
今天咱们来聊下Spring框架中的事件监听。在Java里，事件监听听起来好像很高大上，但其实它就像是我们日常生活中的快递通知：当有快递到了，你会收到一个通知。同样，在程
Spring 的事件监听机制(ApplicationEvent、ApplicationListener)
jsxztshaohaibo的博客
02-14 1771
监听模式： 要素： 1.事件(Event):继承自 org.springframework.context.ApplicationEvent 2.监听器类（Listener）: 实现 org.springframework.context.ApplicationListener 3.事件源（在spring中指的是事件发布) 是ApplicaitonContext 使用步骤： 1.定义事件： public class MySpringApplicationEventForPay exten
springboot生命周期监听
weixin_43669384的博客
07-20 127
监听器-SpringApplicationRunListener，这是一个接口。生命周期包括好几个部分。
Spring事件监听机制
程序员小潘
03-04 1145
Spring 的事件监听机制，采用了观察者的设计模式。一套完整的事件监听流程是这样的，首先定义事件类，即ApplicationEvent的子类，它包含事件发生的时间戳timestamp和产生事件的来源source，以及自定义的其它事件属性；然后实现事件监听器 ApplicationListener 并注册到容器，订阅感兴趣的事件，Spring 会在事件发生时触发监听器；最后通过事件发布器 ApplicationEventPublisher 发布自定义事件。
【Spring框架】Spring监听器的简介和基本使用
小七的博客
10-14 1870
本篇文章带你快速了解Spring事件监听器的使用方法和运作模式。
事件监听器的功能和作用是什么
07-10
事件监听器（Event Listener）是一种编程概念，用于捕获和处理特定事件的发生。它的功能是监视指定的事件，并在事件触发时执行相应的操作。 事件监听器的作用是实现程序的响应式设计，使程序能够对用户的行为或系统的状态变化做出及时的反应。它可以用于图形用户界面（GUI）应用程序中，监听用户的鼠标点击、键盘输入等操作；也可以用于Web开发中，监听浏览器的页面加载、按钮点击、表单提交等事件；还可以用于服务器端开发，监听网络请求的到达、数据库操作的完成等事件。 通过事件监听器，程序可以根据不同的事件类型执行相应的逻辑，例如更新界面显示、处理用户输入、发送网络请求、保存数据等。它提供了一种灵活且可扩展的机制，使程序能够更加交互和动态。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值