Spring Boot 实现事件监听（监听器+自定义事件）完整指南

Spring Boot 实现事件监听监听器自定义事件完整指南Spring Boot 的事件监听机制基于观察者模式核心是「自定义事件 事件发布者 事件监听器」可实现业务解耦如订单创建后触发库存扣减、日志记录、消息推送等。以下是从「基础用法→进阶场景→实战示例」的完整实操覆盖 Spring Boot 2.x/3.x 版本。一、核心概念先理解再上手组件作用事件Event承载业务数据的载体如订单创建事件包含订单ID、金额等需继承ApplicationEvent发布者Publisher发布事件的组件通过ApplicationEventPublisher或ApplicationContext发布监听器Listener监听指定事件事件发布后自动执行处理逻辑支持同步/异步二、快速实现基础事件监听同步步骤1定义自定义事件承载业务数据创建继承ApplicationEvent的事件类封装需要传递的业务数据importorg.springframework.context.ApplicationEvent;/** * 自定义订单创建事件示例订单创建后触发的事件 */publicclassOrderCreateEventextendsApplicationEvent{// 事件携带的业务数据privateLongorderId;privateStringorderNo;privateDoubleamount;// 构造方法必须调用父类构造器publicOrderCreateEvent(Objectsource,LongorderId,StringorderNo,Doubleamount){super(source);// source事件源通常是发布事件的对象this.orderIdorderId;this.orderNoorderNo;this.amountamount;}// getter/setterpublicLonggetOrderId(){returnorderId;}publicStringgetOrderNo(){returnorderNo;}publicDoublegetAmount(){returnamount;}}步骤2实现事件监听器3种方式任选其一Spring Boot 支持 3 种监听器实现方式推荐使用注解式简洁。方式1注解式监听器EventListener推荐无需实现接口直接在方法上标注EventListener指定监听的事件类型importorg.springframework.context.event.EventListener;importorg.springframework.stereotype.Component;/** * 订单事件监听器注解式 */Component// 必须交给Spring容器管理publicclassOrderEventListener{/** * 监听订单创建事件同步执行 */EventListener(OrderCreateEvent.class)// 指定监听的事件类型publicvoidhandleOrderCreateEvent(OrderCreateEventevent){// 事件处理逻辑示例打印订单信息、扣减库存、记录日志等System.out.println(【同步监听器】接收到订单创建事件);System.out.println(订单IDevent.getOrderId());System.out.println(订单编号event.getOrderNo());System.out.println(订单金额event.getAmount());// 实际业务逻辑如扣减库存、发送短信通知、记录操作日志等// stockService.deductStock(event.getOrderId());// smsService.sendNotify(event.getOrderNo());}}方式2实现接口式监听器ApplicationListener实现ApplicationListener接口泛型指定监听的事件类型importorg.springframework.context.ApplicationListener;importorg.springframework.stereotype.Component;/** * 订单事件监听器接口式 */ComponentpublicclassOrderCreateApplicationListenerimplementsApplicationListenerOrderCreateEvent{OverridepublicvoidonApplicationEvent(OrderCreateEventevent){System.out.println(【接口式监听器】接收到订单创建事件订单编号event.getOrderNo());}}方式3手动注册监听器编程式适用于动态注册在配置类中通过ApplicationEventMulticaster手动注册监听器较少用importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.springframework.context.event.ApplicationEventMulticaster;importorg.springframework.context.event.SimpleApplicationEventMulticaster;importorg.springframework.core.task.SimpleAsyncTaskExecutor;ConfigurationpublicclassListenerConfig{BeanpublicApplicationEventMulticasterapplicationEventMulticaster(){SimpleApplicationEventMulticastermulticasternewSimpleApplicationEventMulticaster();// 注册监听器可动态添加/移除multicaster.addApplicationListener(newOrderCreateApplicationListener());returnmulticaster;}}步骤3发布事件触发监听器通过ApplicationEventPublisher发布事件注入即可使用importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.context.ApplicationEventPublisher;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.PathVariable;importorg.springframework.web.bind.annotation.RestController;/** * 测试控制器发布订单创建事件 */RestControllerpublicclassOrderController{// 注入事件发布器Spring内置直接注入AutowiredprivateApplicationEventPublishereventPublisher;/** * 模拟创建订单发布事件 */GetMapping(/createOrder/{orderId})publicStringcreateOrder(PathVariableLongorderId){// 1. 模拟创建订单业务逻辑StringorderNoORDER_System.currentTimeMillis();Doubleamount99.9;System.out.println(订单创建成功orderNo);// 2. 发布订单创建事件触发监听器OrderCreateEventeventnewOrderCreateEvent(this,orderId,orderNo,amount);eventPublisher.publishEvent(event);// 发布事件return订单创建成功事件已发布orderNo;}}步骤4测试验证启动 Spring Boot 项目访问http://localhost:8080/createOrder/1001控制台输出订单创建成功ORDER_1710888888888 【同步监听器】接收到订单创建事件 订单ID1001 订单编号ORDER_1710888888888 订单金额99.9 【接口式监听器】接收到订单创建事件订单编号ORDER_1710888888888三、进阶异步事件监听避免阻塞主线程默认监听器是同步执行发布事件的线程会等待监听器执行完成若监听器处理耗时逻辑如调用第三方接口、发送邮件会阻塞主线程。可通过Async实现异步监听。步骤1开启异步支持主类加注解在 Spring Boot 主类上添加EnableAsync开启异步功能importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;importorg.springframework.scheduling.annotation.EnableAsync;SpringBootApplicationEnableAsync// 开启异步支持publicclassEventListenerDemoApplication{publicstaticvoidmain(String[]args){SpringApplication.run(EventListenerDemoApplication.class,args);}}步骤2监听器方法添加 Async 注解在监听方法上标注Async即可异步执行importorg.springframework.context.event.EventListener;importorg.springframework.scheduling.annotation.Async;importorg.springframework.stereotype.Component;ComponentpublicclassOrderAsyncEventListener{/** * 异步监听订单创建事件不阻塞主线程 */Async// 异步执行EventListener(OrderCreateEvent.class)publicvoidhandleOrderCreateEventAsync(OrderCreateEventevent){try{// 模拟耗时操作如调用第三方支付接口Thread.sleep(3000);System.out.println(【异步监听器】接收到订单创建事件订单编号event.getOrderNo());}catch(InterruptedExceptione){e.printStackTrace();}}}步骤3测试异步效果访问http://localhost:8080/createOrder/1001控制台会先输出「订单创建成功」3秒后再输出异步监听器的内容说明主线程未阻塞。四、高级用法事件过滤 多监听器执行顺序1. 事件过滤只处理符合条件的事件通过EventListener的condition属性使用 SpEL 表达式过滤事件/** * 只监听金额大于100元的订单事件 */EventListener(condition#event.amount 100)publicvoidhandleHighAmountOrder(OrderCreateEventevent){System.out.println(【金额过滤监听器】高金额订单event.getOrderNo()金额event.getAmount());}2. 指定监听器执行顺序通过Order注解指定监听器执行优先级数值越小执行越靠前// 优先级1最先执行Order(1)EventListener(OrderCreateEvent.class)publicvoidlistener1(OrderCreateEventevent){System.out.println(【监听器1】执行);}// 优先级2后执行Order(2)EventListener(OrderCreateEvent.class)publicvoidlistener2(OrderCreateEventevent){System.out.println(【监听器2】执行);}五、实战场景订单创建后的多业务处理需求订单创建后需完成 3 件事扣减库存同步、发送短信通知异步、记录操作日志同步。实现代码// 1. 库存监听器同步高优先级ComponentpublicclassStockListener{Order(1)EventListener(OrderCreateEvent.class)publicvoiddeductStock(OrderCreateEventevent){System.out.println(【库存监听器】扣减订单event.getOrderNo()的库存);// 库存扣减逻辑}}// 2. 短信监听器异步ComponentpublicclassSmsListener{AsyncEventListener(OrderCreateEvent.class)publicvoidsendSms(OrderCreateEventevent){System.out.println(【短信监听器】给订单event.getOrderNo()发送通知短信);// 短信发送逻辑}}// 3. 日志监听器同步低优先级ComponentpublicclassLogListener{Order(2)EventListener(OrderCreateEvent.class)publicvoidrecordLog(OrderCreateEventevent){System.out.println(【日志监听器】记录订单event.getOrderNo()创建日志);// 日志记录逻辑}}测试结果订单创建成功ORDER_1710888888888 【库存监听器】扣减订单ORDER_1710888888888的库存 【日志监听器】记录订单ORDER_1710888888888创建日志 3秒后 【短信监听器】给订单ORDER_1710888888888发送通知短信六、避坑要点1. 监听器未触发原因1监听器类未加Component未交给 Spring 容器管理原因2事件发布时Spring 容器尚未初始化完成如在PostConstruct中发布事件需延迟原因3事件类型匹配错误如监听器监听OrderEvent但发布的是OrderCreateEvent。2. 异步监听器不执行原因1未加EnableAsync注解原因2监听器方法抛出未捕获的异常异步线程异常不会阻塞主线程需手动日志记录原因3方法返回值/参数不符合异步要求异步方法建议返回void或Future。3. 同步监听器阻塞主线程解决耗时操作如调用第三方接口、IO 操作必须用异步监听器Async优化配置异步线程池避免默认线程池耗尽。七、进阶优化自定义异步线程池默认异步线程池为SimpleAsyncTaskExecutor每次创建新线程生产环境建议自定义线程池importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;importorg.springframework.scheduling.annotation.EnableAsync;importorg.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;importjava.util.concurrent.Executor;importjava.util.concurrent.ThreadPoolExecutor;ConfigurationEnableAsyncpublicclassAsyncConfig{/** * 自定义异步线程池 */Bean(eventExecutor)// 指定线程池名称publicExecutoreventExecutor(){ThreadPoolTaskExecutorexecutornewThreadPoolTaskExecutor();executor.setCorePoolSize(5);// 核心线程数executor.setMaxPoolSize(10);// 最大线程数executor.setQueueCapacity(20);// 队列容量executor.setKeepAliveSeconds(60);// 空闲线程存活时间executor.setThreadNamePrefix(event-);// 线程名前缀// 拒绝策略队列满后由调用线程执行避免任务丢失executor.setRejectedExecutionHandler(newThreadPoolExecutor.CallerRunsPolicy());executor.initialize();returnexecutor;}}监听器指定自定义线程池Async(eventExecutor)// 指定使用自定义线程池EventListener(OrderCreateEvent.class)publicvoidhandleOrderCreateEventAsync(OrderCreateEventevent){// 业务逻辑}总结Spring Boot 事件监听核心自定义事件ApplicationEvent 发布器ApplicationEventPublisher 监听器EventListener/ApplicationListener同步监听器默认方式阻塞主线程适合核心业务如库存扣减异步监听器需加EnableAsync Async适合耗时操作如短信、邮件进阶优化通过Order指定执行顺序、condition过滤事件、自定义异步线程池提升性能核心场景业务解耦如订单创建、用户注册后的多业务处理。