企业级spring-boot案例-Spring事件发布与监听

Spring 相关事件

Spring 内置事件

Spring 提供了内置事件。Spring 的核心是 ApplicationContext， 当加载 Bean 的时候，ApplicationContext 会发布某些类型的事件，然后通过 ApplicationEvent 和 ApplicationListener进行处理。

| 序号 | 事件 | 描述 |

| — | — | — |

| 1 | ContextStartedEvent | 容器启动的时候触发 |

| 2 | ContextRefreshedEvent | 容器初始化或刷新 ApplicationContext 时，将发布此事件 |

| 3 | ContextStoppedEvent | 容器停止的时候触发 |

| 4 | ContextClosedEvent | 容器关闭的时候触发 |

Spring Boot 内置事件

在Spring Boot的1.5.x中，提供了几种事件，供我们在开发过程中进行更加便捷的扩展及差异化操作。

| 序号 | 事件 | 描述 |

| — | — | — |

| 1 | ApplicationStartingEvent | springboot启动开始的时候执行的事件 |

| 2 | ApplicationEnvironmentPreparedEvent | spring boot对应Enviroment已经准备完毕，但此时上下文context还没有创建。在该监听中获取到ConfigurableEnvironment后可以对配置信息做操作，例如：修改默认的配置信息，增加额外的配置信息等等 |

| 3 | ApplicationPreparedEvent | spring boot上下文context创建完成，但此时spring中的bean是没有完全加载完成的。在获取完上下文后，可以将上下文传递出去做一些额外的操作。值得注意的是：在该监听器中是无法获取自定义bean并进行操作的 |

| 4 | ApplicationReadyEvent | springboot加载完成时候执行的事件 |

| 5 | ApplicationFailedEvent | spring boot启动异常时执行事件 |

从官网文档中，我们可以知道，由于一些事件是在上下文为加载完触发的，所以无法使用注册bean的方式来声明，文档中可以看出，可以通过SpringApplication.addListeners(…)或者SpringApplicationBuilder.listeners(…)来添加，或者添加META-INF/spring.factories文件中添加监听类也是可以的，这样会自动加载。

自定义事件

---

创建/监听事件应该以下准则

• 事件类应该继承 ApplicationEvent

• 事件的发布者应该注入ApplicationEventPublisher

• 事件监听者应该实现ApplicationListener

1. 创建事件类 继承 ApplicationEvent

public class CustomApplicationEvent extends ApplicationEvent {

private String message;

public CustomApplicationEvent(Object source, String message) {

super(source);

this.message = message;

}

public String getMessage() {

return message;

}

}

2. 创建事件的发布者 注入ApplicationEventPublisher

@Slf4j

@Component

public class CustomApplicationEventPublisher {

@Resource

ApplicationEventPublisher applicationEventPublisher;

public void publishEvent(String message) {

log.info(“开始发布自定义事件”);

CustomApplicationEvent customApplicationEvent = new CustomApplicationEvent(this, message);

// 发布事件

applicationEventPublisher.publishEvent(customApplicationEvent);

log.info(“发布自定义事件结束”);

}

}

3. 创建事件的监听者 实现ApplicationListener接口

@Slf4j

@Component

public class CustomApplicationListener implements ApplicationListener {

@Override

public void onApplicationEvent(CustomApplicationEvent event) {

log.info(“onApplicationEvent方法接收到的消息:{}”, event.getMessage());

}

}

注解驱动

Spring 4.1后提供了 @EventLister ，不需要手动实现 ApplicationListener接口实现事件的监听，同时也可以配置@Async 使用

public @interface EventListener {

@AliasFor(“classes”)

Class<?>[] value() default {};

@AliasFor(“value”)

Class<?>[] classes() default {};

String condition() default “”;

}

• value: classes别名

• classes： 可以指定监听的消息对象类型

• condition：指定条件下触发事件监听, 当表达式计算结果为true时才触发

事件监听

@Slf4j

@Component

public class AnnotationCustomApplicationListener {

@EventListener(CustomApplicationEvent.class)

public void listener(CustomApplicationEvent customApplicationEvent) {

log.info(“EventListener注解方式接收到的消息为:{}”, customApplicationEvent.getMessage());

}

}

测试

@SpringBootTest

public class SpringBootApplicationeventApplicationTests {

@Resource

private CustomApplicationEventPublisher eventPublisher;

@Test

public void publishTest() {

eventPublisher.publishEvent(“发布消息”);

}

}

输出结果

2021-12-08 01:08:12.036 INFO 10624 — [ main] .j.s.b.p.CustomApplicationEventPublisher : 开始发布自定义事件

2021-12-08 01:08:12.036 INFO 10624 — [ main] c.j.s.b.l.CustomApplicationListener : onApplicationEvent方法接收到的消息:发布消息

2021-12-08 01:08:12.036 INFO 10624 — [ main] .b.l.AnnotationCustomApplicationListener : EventListener注解方式接收到的消息为:发布消息

2021-12-08 01:08:12.036 INFO 10624 — [ main] .j.s.b.p.CustomApplicationEventPublisher : 发布自定义事件结束

异步事件

Spring 中的事件默认情况下是同步的，发布者线程会进入阻塞状态，直到所有的监听器处理完事件。如果想让事件监听异步执行，需要在监听器上添加@Async, 同时主启动类上添加@EnableAsync注解

@Slf4j

@Component

public class AsynCustomApplicationListener {

@Async

@EventListener(CustomApplicationEvent.class)

public void asyncListener(CustomApplicationEvent customApplicationEvent) {

log.info(“异步事件监听,当前线程:{},消息为:{}”, Thread.currentThread().getName(), customApplicationEvent.getMessage());

}

}

同时支持线程池配置

@EnableAsync

@Configuration

public class AsyncTaskExecutorConfig {

@Bean

public AsyncTaskExecutor taskExecutor() {

ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();

// 核心线程数10：线程池创建时候初始化的线程数

executor.setCorePoolSize(10);

// 最大线程数20：线程池最大的线程数，只有在缓冲队列满了之后才会申请超过核心线程数的线程

executor.setMaxPoolSize(20);

// 缓冲队列200：用来缓冲执行任务的队列

executor.setQueueCapacity(200);

// 允许线程的空闲时间60秒：当超过了核心线程出之外的线程在空闲时间到达之后会被销毁

executor.setKeepAliveSeconds(60);

// 线程池名的前缀：设置好了之后可以方便我们定位处理任务所在的线程池

executor.setThreadNamePrefix(“taskExecutor-”);

// 线程池对拒绝任务的处理策略：这里采用了CallerRunsPolicy策略，当线程池没有处理能力的时候，该策略会直接在 execute 方法的调用线程中运行被拒绝的任务；如果执行程序已关闭，则会丢弃该任务

executor.setRejectedExecutionHandler(new ThreadPoolExecutor.CallerRunsPolicy());

// 线程池关闭的时候等待所有任务都完成

executor.setWaitForTasksToCompleteOnShutdown(true);

// 设置线程池中任务的等待时间，如果超过这个时间还没有销毁就强制销毁，以确保应用最后能够被关闭，而不是阻塞住。

executor.setAwaitTerminationSeconds(60);

// 如果不初始化，会出现找不到执行器

executor.initialize();

return executor;

}

}

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

一线互联网大厂Java核心面试题库

正逢面试跳槽季，给大家整理了大厂问到的一些面试真题，由于文章长度限制，只给大家展示了部分题目，更多Java基础、异常、集合、并发编程、JVM、Spring全家桶、MyBatis、Redis、数据库、中间件MQ、Dubbo、Linux、Tomcat、ZooKeeper、Netty等等已整理上传，感兴趣的朋友可以看看支持一波！
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！
）**

一线互联网大厂Java核心面试题库

[外链图片转存中…(img-YTzaOACp-1711883566162)]

正逢面试跳槽季，给大家整理了大厂问到的一些面试真题，由于文章长度限制，只给大家展示了部分题目，更多Java基础、异常、集合、并发编程、JVM、Spring全家桶、MyBatis、Redis、数据库、中间件MQ、Dubbo、Linux、Tomcat、ZooKeeper、Netty等等已整理上传，感兴趣的朋友可以看看支持一波！
《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》，点击传送门即可获取！