快捷導(dǎo)航

Spring中ApplicationEventPublisher發(fā)布訂閱模式的實(shí)現(xiàn)

更新時(shí)間：2023年07月25日 11:49:41 作者：小白的救贖

本文主要介紹了Spring中ApplicationEventPublisher發(fā)布訂閱模式的實(shí)現(xiàn)，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

概念

關(guān)于發(fā)布訂閱這個(gè)詞，其實(shí)不僅僅出現(xiàn)在Spring框架當(dāng)中，其實(shí)在Redis中也有存在（其對(duì)應(yīng)的是convertAndSend()方法），還有在MQ消息隊(duì)列里也是有的，但這里就主要介紹的是關(guān)于Spring框架的ApplicationEventPublisher如何做到消息的發(fā)布與訂閱。隨著現(xiàn)在的業(yè)務(wù)量和需求量越來越大，其實(shí)基本都是分布式微服務(wù)集群的使用了，所以基本都是用到Redis與MQ。但是對(duì)于單體Spring Boot應(yīng)用時(shí)，用Spring自帶的發(fā)布訂閱就已經(jīng)綽綽有余了。

需要知道的是發(fā)布訂閱需要有三個(gè)對(duì)象：事件、事件發(fā)布源、事件接收源（監(jiān)聽器）。

事件

對(duì)于事件來說，需要去繼承ApplicationEvent。至于為什么需要繼承ApplicationEvent就需要研究源碼，等我后續(xù)看完再回來更新筆記。

public class LogEvent extends ApplicationEvent {
    public LogEvent(Object message) {
        super(message);
    }
}

事件發(fā)布源

這個(gè)基本上都是業(yè)務(wù)層的代碼，但是作為學(xué)習(xí)階段，我將其直接放在控制層。關(guān)于如何去發(fā)布，就需要用到Spring中的ApplicationEventPublisher。

@Slf4j
@RestController
@RequestMapping("/log")
public class LogController {
    @Autowired
    private ApplicationEventPublisher publisher;
    @GetMapping("/publisher")
    public void log() {
        log.info("進(jìn)入到log方法,開始發(fā)送事件");
        publisher.publishEvent(new LogEvent("log方法生成事件信息"));
        log.info("log方法發(fā)送事件完畢");
    }
}

監(jiān)聽器

/**
 * 管理員日志監(jiān)聽器
 */
@Slf4j
@Component
public class AdminListener {
    @EventListener(LogEvent.class)
    public void adminListen(LogEvent logEvent) {
        try {
            log.info("管理員監(jiān)聽到的日志信息為,{}", logEvent);
            Thread.sleep(5000); // 睡眠5s
            log.info("管理員監(jiān)聽完畢");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

/**
 * 用戶日志事件監(jiān)聽器
 */
@Slf4j
@Component
public class UserListener {
    @EventListener(LogEvent.class)
    public void userListen(LogEvent logEvent) {
        try {
            log.info("用戶監(jiān)聽到的日志信息為,{}", logEvent);
            Thread.sleep(10000); // 睡眠10s
            log.info("用戶監(jiān)聽完畢");
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

執(zhí)行結(jié)果

從執(zhí)行結(jié)果可以發(fā)現(xiàn)管理員線程睡眠了5s后執(zhí)行完畢才會(huì)執(zhí)行用戶的代碼塊。所以表明是同步執(zhí)行的。

于是為了將同步執(zhí)行變?yōu)楫惒綀?zhí)行，又在兩個(gè)監(jiān)聽器的方法上添加了@Async注解，并且一定要在啟動(dòng)類上添加@EnableAsync注解。再次執(zhí)行會(huì)發(fā)現(xiàn)兩次的執(zhí)行結(jié)果并不一致。兩個(gè)監(jiān)聽器是異步執(zhí)行的。甚至在監(jiān)聽器上放置@Order注解可以實(shí)現(xiàn)先后順序，但這里就不演示了。

源碼追蹤

這里只進(jìn)行粗略的源碼查看，因?yàn)樽髡吖ατ邢逕o法解釋得完全仔細(xì)，以后看懂了再回來更新筆記?？梢园l(fā)現(xiàn)其已經(jīng)使用了JDK8新特性了。從ApplicationEventPublisher的publisher(Application event)方法就會(huì)進(jìn)入到其子類AbstartApplicationContext中。

protected void publishEvent(Object event, @Nullable ResolvableType eventType) {
        Assert.notNull(event, "Event must not be null");
        Object applicationEvent;
        if (event instanceof ApplicationEvent) {
            applicationEvent = (ApplicationEvent)event;
        } else {
            applicationEvent = new PayloadApplicationEvent(this, event);
            if (eventType == null) {
                eventType = ((PayloadApplicationEvent)applicationEvent).getResolvableType();
            }
        }
        if (this.earlyApplicationEvents != null) {
            this.earlyApplicationEvents.add(applicationEvent);
        } else {
            // 在這步完成真正的發(fā)布訂閱 只有監(jiān)聽完才會(huì)向下繼續(xù)執(zhí)行
            this.getApplicationEventMulticaster().multicastEvent((ApplicationEvent)applicationEvent, eventType);
        }
        if (this.parent != null) {
            if (this.parent instanceof AbstractApplicationContext) {
                ((AbstractApplicationContext)this.parent).publishEvent(event, eventType);
            } else {
                this.parent.publishEvent(event);
            }
        }

到此這篇關(guān)于Spring中ApplicationEventPublisher發(fā)布訂閱模式的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Spring ApplicationEventPublisher發(fā)布訂閱模式內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: