Springboot事件监听

原创已于 2023-08-25 15:59:42 修改 · 3.2k 阅读

9 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

于 2023-06-03 17:07:50 首次发布

Java进阶自学笔记专栏收录该内容

33 篇文章

订阅专栏

文章介绍了Springboot中事件监听的机制，包括事件对象、事件、监听器和事件发布者的角色。通过一个WorkEvent的例子展示了如何创建自定义事件和监听器。监听器使用@Async注解实现异步处理，避免主线程阻塞。文章强调了异步处理的必要性，防止监听业务异常导致流程中断或耗时过长影响主业务。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Springboot事件监听中主要有以下对象：

1、事件（event）可以封装和传递监听器中要处理的参数，如对象或字符串，并作为监听器中监听的目标。
2、监听器（listener）具体根据事件发生的业务处理模块，这里可以接收处理事件中封装的对象或字符串。
3、事件发布者（publisher）事件发生的触发者

1、事件对象

@Data
public class WorkEvent{


    /**
     * ID
     */
    public Long idNo;
    /**
     * 当前流程状态
     */
    public Integer state;
    /**
     * 申请理由
     */
    public String contents;

}

2、事件

public class WorkApplicationEvent extends ApplicationEvent {
    public WorkApplicationEvent(WorkEvent workEvent) {
        super(workEvent);
    }
}

3、监听器

@Component
public class MsgListener {

    @SneakyThrows // 该注解可以省略代码中一些抛异常或者try catch操作（建议少用，此处写个简单的小demo偷懒）
    @Async // 开启异步监听
    @EventListener(WorkApplicationEvent.class)
    public void sendMsg(WorkApplicationEvent workApplicationEvent) {
        // 具体监听的业务逻辑
        WorkEvent workEvent = (WorkEvent)workApplicationEvent.getSource();
        if (workEvent.getState() == 1) {
            Thread.sleep(1000);
            System.out.println(workEvent.getContents());
        } else {
            throw new RuntimeException("抛出异常，观察后续执行情况");
        }
    }
}

4、事件发布者

@Service
public class TestServiceImpl implements TestService {

    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    @Override
    public String testEvent(Integer id) {
        WorkEvent workEvent = new WorkEvent();
        workEvent.setState(id);
        workEvent.setContents("监听事件为：WorkEvent");
        WorkApplicationEvent event = new WorkApplicationEvent(workEvent);
        System.out.println("推送监听事件");
        // 发布事件
        applicationEventPublisher.publishEvent(event); 
        System.out.println("已推送成功");
        return "推送成功";
    }
}

5、Controller

@RestController
public class TestController {

    @Autowired
    private TestService testService;

    @GetMapping("/test/{id}")
    public String getTest(@PathVariable("id") Integer id) {
        return testService.testEvent(id);
    }

}

6、整体项目结构

请添加图片描述

注意，主启动类上需要添加注解：@EnableAsync开启异步

运行效果

执行：http://localhost:8080/test/1

请添加图片描述

执行：http://localhost:8080/test/2

请添加图片描述

不使用异步访问：http://localhost:8080/test/2

请添加图片描述

接下来想聊聊为什么用异步操作

原因有二：

1、因为Springboot的事件监听默认是会在主线程执行的，如果监听业务出现Exception，则会导致整个流程报错阻塞，无法往下继续执行。就好比我本来是想告诉你我今天买彩票赚了10块钱，告诉你这个消息的目的是为了想你听到我的消息之后采取一些措施，比如让你远离博彩（让你也去买一张）。但是我只负责把消息传递给你，而你收到我的消息后做了什么事情我并不关心，这就是异步。但是比如说你收到我的消息后，你也去买了一张彩票结果发现没中奖，于是你把我中来的十块钱抢走了，这就可以理解为非异步。这种设计可能会违背我们这段代码的逻辑导致业务处理出错。

2、监听耗时问题，如果监听业务处理事件非常久，不采用异步处理会阻塞主业务流程。

如果不想用异步操作的话，可以去掉@Async注解和启动类的@EnableAsync就可以了。