快捷導(dǎo)航

SpringBoot中ApplicationEvent和ApplicationListener用法小結(jié)

更新時間：2023年03月09日 15:23:11 作者：一縷82年的清風(fēng)

這篇文章介紹SpringBoot中ApplicationEvent用法,注意ApplicationEvent和MQ隊列雖然實現(xiàn)的功能相似，但是MQ還是有其不可替代性的，最本質(zhì)的區(qū)別就是MQ可以用于不同系統(tǒng)之間的消息發(fā)布，而SpringEvent這種模式只能在一個系統(tǒng)中，需要的朋友可以參考下

我們前面的文章中講解過RabbitMQ的用法，所謂MQ就是一種發(fā)布訂閱模式的消息模型。在Spring中其實本身也為我們提供了一種發(fā)布訂閱模式的事件處理方式，就是ApplicationEvent和 ApplicationListener，這是一種基于觀察者模式實現(xiàn)事件監(jiān)聽功能。也已幫助我們完成業(yè)務(wù)邏輯的解耦，提高程序的擴展性和可維護性。

但是這里要注意ApplicationEvent和 MQ隊列雖然實現(xiàn)的功能相似，但是MQ還是有其不可替代性的，最本質(zhì)的區(qū)別就是MQ可以用于不同系統(tǒng)之間的消息發(fā)布，而SpringEvent這種模式只能在一個系統(tǒng)中，也就是要求必須是同一個Spring容器。

好了接下來我們就來演練一番。

在這個模型中，有兩個重要的類，一個是事件，一個是監(jiān)聽。事件要繼承ApplicationEvent類，監(jiān)聽要實現(xiàn)ApplicationListener接口。

一、開發(fā)ApplicationEvent事件

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

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;
 
    /**
     * 需要重寫構(gòu)造方法
     * @param source
     * @param name
     * @param age
     */
    public MyApplicationEvent(Object source, String name, Integer age) {
        super(source);
        this.name = name;
        this.age = age;
    }
}

二、開發(fā)監(jiān)聽器

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

package com.lsqingfeng.springboot.applicationEvent;
 
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
 
/**
 * @className: MyApplicationEventListener
 * @description:事件監(jiān)聽器
 * @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。這個對象在Spring容器加載的時候就已經(jīng)在容器中了。所以我們可以直接注入使用,也可以使用ApplicationContext,因為ApplicationContext本身就繼承了ApplicationEventPublisher。我們通過一個Controller來驗證一下。

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("/push2")
    public Result pushEvent2(){
        applicationContext.publishEvent("大家好");
        return Result.success();
    }
}

我們定義兩個推送的方法。一個推送我們的MyApplicationEvent類型，還有一個方法推送一個字符串。

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

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

那如果我們把泛型去掉會有什么效果呢，我們來試試。

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

四、注解方式實現(xiàn)監(jiān)聽器

除了上面的通過實現(xiàn)接口的方式開發(fā)監(jiān)聽器，我們還可以通過注解的方式來實現(xiàn)，具體代碼如下。

package com.lsqingfeng.springboot.applicationEvent;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
/**
 * @className: MyApplicationEventListener2
 * @description: 注解實現(xiàn)監(jiān)聽器
 * @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 注解代表了這是一個監(jiān)聽器。方法名隨意，方法里的參數(shù)代表監(jiān)聽的事件類型。

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