SpringBoot中ApplicationEvent和ApplicationListener怎么使用

本篇內(nèi)容主要講解“SpringBoot中ApplicationEvent和ApplicationListener怎么使用”，感興趣的朋友不妨來(lái)看看。本文介紹的方法操作簡(jiǎn)單快捷，實(shí)用性強(qiáng)。下面就讓小編來(lái)帶大家學(xué)習(xí)“SpringBoot中ApplicationEvent和ApplicationListener怎么使用”吧!

在這個(gè)模型中，有兩個(gè)重要的類(lèi)，一個(gè)是事件，一個(gè)是監(jiān)聽(tīng)。事件要繼承ApplicationEvent類(lèi)，監(jiān)聽(tīng)要實(shí)現(xiàn)ApplicationListener接口。

一、開(kāi)發(fā)ApplicationEvent事件

事件其實(shí)就是我們要發(fā)送的消息體，這個(gè)一般要根據(jù)我們的實(shí)際業(yè)務(wù)進(jìn)行封裝，需要什么類(lèi)型的數(shù)據(jù)，就是用什么類(lèi)型，需要哪些字段就添加哪些字段。我們來(lái)給一個(gè)案例。

package com.lsqingfeng.springboot.applicationEvent;
 
import lombok.Getter;
import lombok.Setter;
import org.springframework.context.ApplicationEvent;
 
/**
 * @className: MyApplicationEvent
 * @description: 事件封裝
 * @author: sh.Liu
 * @date: 2022-03-23 14:41
 */
@Getter
@Setter
@ToString
public class MyApplicationEvent extends ApplicationEvent {
 
    private Integer age;
 
    private String name;
 
    /**
     * 需要重寫(xiě)構(gòu)造方法
     * @param source
     * @param name
     * @param age
     */
    public MyApplicationEvent(Object source, String name, Integer age) {
        super(source);
        this.name = name;
        this.age = age;
    }
}

二、 開(kāi)發(fā)監(jiān)聽(tīng)器

監(jiān)聽(tīng)器就相當(dāng)于我們的MQ的消費(fèi)者，當(dāng)有時(shí)間推送過(guò)來(lái)的時(shí)候，監(jiān)聽(tīng)器的代碼就可以執(zhí)行。這里通過(guò)泛型來(lái)設(shè)置好我們的事件類(lèi)型。

package com.lsqingfeng.springboot.applicationEvent;
 
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
 
/**
 * @className: MyApplicationEventListener
 * @description:事件監(jiān)聽(tīng)器
 * @author: sh.Liu
 * @date: 2022-03-23 14:50
 */
@Component
public class MyApplicationEventListener implements ApplicationListener<MyApplicationEvent> {
 
    @Override
    public void onApplicationEvent(MyApplicationEvent event) {
        System.out.println("收到消息：" + event);
    }
}

三、推送事件

推送事件需要使用ApplicationEventPublisher。這個(gè)對(duì)象在Spring容器加載的時(shí)候就已經(jīng)在容器中了。所以我們可以直接注入使用,也可以使用ApplicationContext,因?yàn)锳pplicationContext本身就繼承了ApplicationEventPublisher。 我們通過(guò)一個(gè)Controller來(lái)驗(yàn)證一下。

package com.lsqingfeng.springboot.controller;
 
import com.lsqingfeng.springboot.applicationEvent.MyApplicationEvent;
import com.lsqingfeng.springboot.base.Result;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @className: ApplicationEventController
 * @description:
 * @author: sh.Liu
 * @date: 2022-03-23 15:21
 */
@RestController
@RequestMapping("event")
public class ApplicationEventController {
 
    @Autowired
    private ApplicationContext applicationContext;
 
    @RequestMapping("/push")
    public Result pushEvent(){
        MyApplicationEvent myApplicationEvent = new MyApplicationEvent(this,"zhangsan", 10);
        applicationContext.publishEvent(myApplicationEvent);
        return Result.success();
    }
 
    @RequestMapping("/push3")
    public Result pushEvent2(){
        applicationContext.publishEvent("大家好");
        return Result.success();
    }
}

我們定義兩個(gè)推送的方法。一個(gè)推送我們的MyApplicationEvent類(lèi)型，還有一個(gè)方法推送一個(gè)字符串。

當(dāng)我們調(diào)用第一個(gè)方法的時(shí)候，控制臺(tái)可以打印出我們推送的數(shù)據(jù)信息。

調(diào)用推送字符串的時(shí)候，我們的監(jiān)聽(tīng)器不會(huì)執(zhí)行，原因是我們的攔截器里已經(jīng)加了泛型MyApplicationEvent，也就是只會(huì)監(jiān)聽(tīng)MyApplicationEvent類(lèi)型的消息。其他類(lèi)型的消息不會(huì)被監(jiān)聽(tīng)到。

那如果我們把泛型去掉會(huì)有什么效果呢，我們來(lái)試試。

每次推送都會(huì)發(fā)送兩條（可能有什么內(nèi)部機(jī)制，不管了），但是兩個(gè)都打印了，說(shuō)明如果不加泛型，不管誰(shuí)推，這邊都能收到消息。

四、注解方式實(shí)現(xiàn)監(jiān)聽(tīng)器

除了上面的通過(guò)實(shí)現(xiàn)接口的方式開(kāi)發(fā)監(jiān)聽(tīng)器，我們還可以通過(guò)注解的方式來(lái)實(shí)現(xiàn)，具體代碼如下。

package com.lsqingfeng.springboot.applicationEvent;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
/**
 * @className: MyApplicationEventListener2
 * @description: 注解實(shí)現(xiàn)監(jiān)聽(tīng)器
 * @author: sh.Liu
 * @date: 2022-03-23 15:56
 */
@Component
public class MyApplicationEventListener2 {
 
    @EventListener
    public void onEvent(MyApplicationEvent event){
        System.out.println("收到消息2：" + event);
    }
}

這里加入了@EventListener 注解代表了這是一個(gè)監(jiān)聽(tīng)器。方法名隨意，方法里的參數(shù)代表監(jiān)聽(tīng)的事件類(lèi)型。

再次調(diào)用push方法：

發(fā)現(xiàn)兩個(gè)監(jiān)聽(tīng)器的數(shù)據(jù)都會(huì)打印。這一特點(diǎn)大家要注意一下。

到此，相信大家對(duì)“SpringBoot中ApplicationEvent和ApplicationListener怎么使用”有了更深的了解，不妨來(lái)實(shí)際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進(jìn)入相關(guān)頻道進(jìn)行查詢，關(guān)注我們，繼續(xù)學(xué)習(xí)！