快捷導(dǎo)航

SpringBoot創(chuàng)建監(jiān)聽(tīng)器的方法示例

更新時(shí)間：2024年04月22日 09:27:58 作者：青燈文案1

在Java中,監(jiān)聽(tīng)器（Listener）是一種設(shè)計(jì)模式,它允許對(duì)象在特定事件發(fā)生時(shí) 自動(dòng)執(zhí)行某些操作,這種設(shè)計(jì)模式通常用于實(shí)現(xiàn) 發(fā)布-訂閱模型,本文給大家介紹了SpringBoot創(chuàng)建監(jiān)聽(tīng)器的方法示例,感興趣的通過(guò)可以參考一下

監(jiān)聽(tīng)器的作用

解耦：通過(guò)監(jiān)聽(tīng)器，可以將 事件發(fā)送者 和 事件處理者 解耦，使得兩者之間的依賴關(guān)系降低。
事件驅(qū)動(dòng)：監(jiān)聽(tīng)器允許程序以 事件驅(qū)動(dòng) 的方式運(yùn)行，即當(dāng)特定事件發(fā)生時(shí)，自動(dòng)觸發(fā)相應(yīng)的處理邏輯。
跨組件通信：在不同組件或模塊之間，可以通過(guò)監(jiān)聽(tīng)器實(shí)現(xiàn)通信和協(xié)作。

在Spring Boot中，可以通過(guò)實(shí)現(xiàn) Spring 提供的監(jiān)聽(tīng)器接口或注解來(lái)創(chuàng)建監(jiān)聽(tīng)器。Spring提供了多種類型的監(jiān)聽(tīng)器，包括 ApplicationListener 用于監(jiān)聽(tīng)?wèi)?yīng)用事件， @EventListener 注解用于監(jiān)聽(tīng)特定事件等。

ApplicationEvent 是Spring框架中的一個(gè)核心類，用于在應(yīng)用程序中發(fā)布和監(jiān)聽(tīng)事件。它是所有Spring事件的基類，一個(gè)抽象類，可以被繼承來(lái)創(chuàng)建自定義的事件。事件可以在應(yīng)用程序中的不同組件之間進(jìn)行傳遞和通信。

ApplicationEvent 攜帶一個(gè) Object 對(duì)象，可以被發(fā)布，事件監(jiān)聽(tīng)者監(jiān)聽(tīng)到這個(gè)事件后，會(huì)觸發(fā)自定義邏輯（操作Object對(duì)象）。是實(shí)現(xiàn)事件驅(qū)動(dòng)編程的重要機(jī)制，通過(guò)事件和監(jiān)聽(tīng)器的協(xié)作，可以實(shí)現(xiàn)不同組件之間的解耦和高效通信。

實(shí)現(xiàn) ApplicationListener 監(jiān)聽(tīng)事件

1、創(chuàng)建 CustomEvent 事件類

import org.springframework.context.ApplicationEvent;

public class CustomEvent extends ApplicationEvent { // CustomEvent需要繼承自ApplicationEvent

    private String message;

    public CustomEvent(Object source, String message) {
        super(source);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

2、自定義監(jiān)聽(tīng)器，監(jiān)聽(tīng)事件類

import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class CustomEventListener implements ApplicationListener<CustomEvent> {

    @Override
    public void onApplicationEvent(CustomEvent event) {
        // 當(dāng)CustomEvent事件被發(fā)布時(shí)，這個(gè)方法會(huì)被調(diào)用
        System.out.println("監(jiān)聽(tīng)事件成功 - " + event.getMessage());
        // 在這里編寫(xiě)處理事件的邏輯
        // 比如對(duì)消息進(jìn)行合規(guī)處理
    }
}

3、觸發(fā)監(jiān)聽(tīng)事件

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;

@Component
public class EventPublisher {

    private final ApplicationContext applicationContext;

    @Autowired
    public EventPublisher(ApplicationContext applicationContext) {
        this.applicationContext = applicationContext;
    }

    public void publishCustomEvent(String message) {
    	// 發(fā)布CustomEvent
        CustomEvent customEvent = new CustomEvent(this, message);
        applicationContext.publishEvent(customEvent);
    }
}

當(dāng) publishCustomEvent 方法被調(diào)用并發(fā)布 CustomEvent 時(shí)，所有實(shí)現(xiàn)了 ApplicationListener<CustomEvent> 的監(jiān)聽(tīng)器都會(huì)收到通知，并執(zhí)行onApplicationEvent方法。

使用 @EventListener 注解監(jiān)聽(tīng)事件

如果你想要使用注解來(lái)創(chuàng)建監(jiān)聽(tīng)器，可以使用@EventListener注解：

import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class AnnotationBasedEventListener {

    @EventListener
    public void handleCustomEvent(CustomEvent event) {
        // 當(dāng)CustomEvent事件被發(fā)布時(shí)，這個(gè)方法會(huì)被調(diào)用
        System.out.println("監(jiān)聽(tīng)事件成功 - " + event.getMessage());
        // 在這里編寫(xiě)處理事件的邏輯
        // 比如對(duì)消息進(jìn)行合規(guī)處理
    }
}

使用 @EventListener 注解可以簡(jiǎn)化監(jiān)聽(tīng)器的創(chuàng)建過(guò)程，并且可以在 方法級(jí)別上 指定需要監(jiān)聽(tīng)的事件類型。

無(wú)論是通過(guò)實(shí)現(xiàn)接口還是使用注解，Spring Boot都提供了以實(shí)現(xiàn)事件驅(qū)動(dòng)的應(yīng)用程序邏輯。

到此這篇關(guān)于SpringBoot創(chuàng)建監(jiān)聽(tīng)器的方法示例的文章就介紹到這了,更多相關(guān)SpringBoot創(chuàng)建監(jiān)聽(tīng)器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: