SpringBoot監(jiān)聽器的實(shí)現(xiàn)示例

更新時(shí)間：2023年12月18日 08:41:12 作者：林諾辭

在SpringBoot中，你可以使用監(jiān)聽器來(lái)響應(yīng)特定的事件，本文主要介紹了SpringBoot監(jiān)聽器的實(shí)現(xiàn)示例，具有一定的參考價(jià)值，感興趣的可以了解一下

1. 創(chuàng)建一個(gè)監(jiān)聽器

創(chuàng)建一個(gè)監(jiān)聽器有兩種方法：實(shí)現(xiàn)ApplicationListener接口或使用@EventListener注解。

實(shí)現(xiàn)ApplicationListener接口

創(chuàng)建一個(gè)新的類并實(shí)現(xiàn)ApplicationListener接口，傳入你想要監(jiān)聽的事件類型作為泛型參數(shù)。

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

@Component
public class MyApplicationListener implements ApplicationListener<ApplicationReadyEvent> {

    @Override
    public void onApplicationEvent(ApplicationReadyEvent event) {
        System.out.println("Application is ready!");
    }
}

在這個(gè)例子中，我們創(chuàng)建了一個(gè)名為MyApplicationListener的監(jiān)聽器，它會(huì)在Spring Boot應(yīng)用準(zhǔn)備好之后執(zhí)行一些操作（打印一條消息）。

使用@EventListener注解

你也可以通過(guò)在方法上添加@EventListener注解來(lái)創(chuàng)建一個(gè)監(jiān)聽器：

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

@Component
public class MyEventListener {

    @EventListener
    public void handleApplicationReadyEvent(ApplicationReadyEvent event) {
        System.out.println("Application is ready!");
    }
}

2. 自定義事件

在 Spring Boot 中，自定義監(jiān)聽事件的步驟如下：

創(chuàng)建一個(gè)自定義事件類。這個(gè)類需要繼承 ApplicationEvent 類。

import org.springframework.context.ApplicationEvent;

public class CustomEvent extends ApplicationEvent {
    private String message;

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

    public String getMessage() {
        return message;
    }
}

在這個(gè)例子中，我們創(chuàng)建了一個(gè)名為 CustomEvent 的自定義事件類，它包含了一個(gè)字符串類型的 message 屬性，用于存儲(chǔ)事件的相關(guān)信息。

創(chuàng)建一個(gè)監(jiān)聽器類，實(shí)現(xiàn) ApplicationListener 接口，并指定要監(jiān)聽的事件類型（這里是 CustomEvent）：

import org.springframework.context.ApplicationListener;

public class CustomEventListener implements ApplicationListener<CustomEvent> {

    @Override
    public void onApplicationEvent(CustomEvent event) {
        System.out.println("Received custom event: " + event.getMessage());
    }
}

注冊(cè)監(jiān)聽器到 Spring 容器。你可以使用自動(dòng)掃描、手動(dòng)注冊(cè) Bean 或使用 @EventListener 注解來(lái)完成這一任務(wù)。
發(fā)布自定義事件：現(xiàn)在你已經(jīng)創(chuàng)建了自定義事件和監(jiān)聽器，可以使用 ApplicationContext 來(lái)發(fā)布你的自定義事件：

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

@Component
public class EventPublisher {
 @Autowired
    private final ApplicationContext context;

   
    public EventPublisher(ApplicationContext context) {
        this.context = context;
    }

    public void publishCustomEvent(String message) {
        context.publishEvent(new CustomEvent(this, message));
    }
}

在這個(gè)示例中，我們創(chuàng)建了一個(gè) EventPublisher 類，它有一個(gè)注入的 ApplicationContext。當(dāng)調(diào)用 publishCustomEvent() 方法時(shí)，會(huì)發(fā)布一個(gè)新的 CustomEvent，并將消息傳遞給監(jiān)聽器。

最后，在需要的地方調(diào)用 EventPublisher 類的 publishCustomEvent() 方法來(lái)觸發(fā)事件：

@Autowired
private EventPublisher eventPublisher;

// ...

eventPublisher.publishCustomEvent("Hello from a custom event!");

這樣，每當(dāng) publishCustomEvent() 被調(diào)用時(shí)，你的自定義監(jiān)聽器就會(huì)接收到事件并執(zhí)行相應(yīng)的操作。

3.springboot使用定時(shí)任務(wù)

這種方式很簡(jiǎn)單，主要就是先@EnableScheduling開啟定時(shí)任務(wù)功能，然后在相應(yīng)的方法上添加@Scheduled()中間寫上相應(yīng)的cron表達(dá)式即可。示例如下：

import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
 
import java.time.LocalDateTime;
 
@Configuration      //1.主要用于標(biāo)記配置類，兼?zhèn)銫omponent的效果。
@EnableScheduling   // 2.開啟定時(shí)任務(wù)
public class ScheduleTask {
    @Scheduled(cron = "0/5 * * * * ?") //定時(shí)任務(wù)注解+cron表達(dá)式
    public void testScheduleTask() {
        System.out.println("執(zhí)行定時(shí)任務(wù)" + LocalDateTime.now());
    }
}

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

您可能感興趣的文章: