快捷導(dǎo)航

SpringBoot事件發(fā)布和監(jiān)聽詳解

更新時(shí)間：2021年11月12日 11:43:27 作者：ForeverKobe

今天去官網(wǎng)查看spring boot資料時(shí)，在特性中看見了系統(tǒng)的事件及監(jiān)聽章節(jié),所以下面這篇文章主要給大家介紹了關(guān)于SpringBoot事件發(fā)布和監(jiān)聽的相關(guān)資料,文中通過實(shí)例代碼介紹的非常詳細(xì),需要的朋友可以參考下

概述

ApplicationEvent以及Listener是Spring為我們提供的一個(gè)事件監(jiān)聽、訂閱的實(shí)現(xiàn)，內(nèi)部實(shí)現(xiàn)原理是觀察者設(shè)計(jì)模式，設(shè)計(jì)初衷也是為了系統(tǒng)業(yè)務(wù)邏輯之間的解耦，提高可擴(kuò)展性以及可維護(hù)性。事件發(fā)布者并不需要考慮誰去監(jiān)聽，監(jiān)聽具體的實(shí)現(xiàn)內(nèi)容是什么，發(fā)布者的工作只是為了發(fā)布事件而已。事件監(jiān)聽的作用與消息隊(duì)列有一點(diǎn)類似。

事件監(jiān)聽的結(jié)構(gòu)

主要有三個(gè)部分組成:

發(fā)布者Publisher
事件Event
監(jiān)聽者Listener

Publisher,Event和Listener的關(guān)系

事件

我們自定義事件MyTestEvent繼承了ApplicationEvent，繼承后必須重載構(gòu)造函數(shù)，構(gòu)造函數(shù)的參數(shù)可以任意指定，其中source參數(shù)指的是發(fā)生事件的對(duì)象，一般我們?cè)诎l(fā)布事件時(shí)使用的是this關(guān)鍵字代替本類對(duì)象，而user參數(shù)是我們自定義的注冊(cè)用戶對(duì)象，該對(duì)象可以在監(jiān)聽內(nèi)被獲取。

@Getter
public class MyTestEvent extends ApplicationEvent {
    private static final long serialVersionUID = 1L;
    private User user;

    public MyTestEvent(Object source, User user) {
        super(source);
        this.user = user;
    }
}

發(fā)布者

事件發(fā)布是由ApplicationContext對(duì)象管控的，我們發(fā)布事件前需要注入ApplicationContext對(duì)象調(diào)用publishEvent方法完成事件發(fā)布。

ApplicationEventPublisher applicationEventPublisher 雖然聲明的是ApplicationEventPublisher，但是實(shí)際注入的是applicationContext

@RestController
@RequestMapping("/test")
public class TestController {
    @Autowired
    ApplicationContext applicationContext;
    @Autowired
    ApplicationEventPublisher applicationEventPublisher;

    @GetMapping("testEvent")
    public void test() {
        applicationEventPublisher.publishEvent(new MyTestEvent("dzf-casfd-111", new User("dzf-625096527-111", "xiaoming", 19)));
        applicationEventPublisher.publishEvent(new MyTestEvent("dzf-49687489-111", new User("dzf-625096527-111", "xiaowang", 20)));
    }


}

監(jiān)聽者

面向接口編程，實(shí)現(xiàn)ApplicationListener接口

@Component
public class MyTestListener implements ApplicationListener<MyTestEvent> {

    @Override
    public void onApplicationEvent(MyTestEvent myTestEvent) {
        System.out.println("MyTestListener : " + myTestEvent.getUser());
    }
}

使用@EventListener注解配置

@Component
public class MyTestListener2{

    @EventListener(MyTestEvent.class)
    public void onApplicationEvent(MyTestEvent myTestEvent) {
        System.out.println("MyTestListener2:" + myTestEvent.getUser());
    }
}