SpringBoot中ApplicationEvent和ApplicationListener用法小結

Posted on by

對不起大傢，昨天文章裡的告別說早瞭，這個系列還不能就這麼結束。

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

但是這裡要註意ApplicationEvent和 MQ隊列雖然實現的功能相似，但是MQ還是有其不可替代性的，最本質的區別就是MQ可以用於不同系統之間的消息發佈，而SpringEvent這種模式隻能在一個系統中，也就是要求必須是同一個Spring容器。

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

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

一、開發ApplicationEvent事件

事件其實就是我們要發送的消息體，這個一般要根據我們的實際業務進行封裝，需要什麼類型的數據，就是用什麼類型，需要哪些字段就添加哪些字段。我們來給一個案例。

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

二、 開發監聽器

監聽器就相當於我們的MQ的消費者，當有時間推送過來的時候，監聽器的代碼就可以執行。這裡通過泛型來設置好我們的事件類型。

package com.lsqingfeng.springboot.applicationEvent;
 
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
 
/**
 * @className: MyApplicationEventListener
 * @description:事件監聽器
 * @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容器加載的時候就已經在容器中瞭。所以我們可以直接註入使用,也可以使用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類型，還有一個方法推送一個字符串。

當我們調用第一個方法的時候，控制臺可以打印出我們推送的數據信息。

調用推送字符串的時候，我們的監聽器不會執行，原因是我們的攔截器裡已經加瞭泛型MyApplicationEvent，也就是隻會監聽MyApplicationEvent類型的消息。其他類型的消息不會被監聽到。

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

每次推送都會發送兩條（可能有什麼內部機制，不管瞭），但是兩個都打印瞭，說明如果不加泛型，不管誰推，這邊都能收到消息。

四、註解方式實現監聽器

除瞭上面的通過實現接口的方式開發監聽器，我們還可以通過註解的方式來實現，具體代碼如下。

package com.lsqingfeng.springboot.applicationEvent;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
/**
 * @className: MyApplicationEventListener2
 * @description: 註解實現監聽器
 * @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 註解代表瞭這是一個監聽器。方法名隨意，方法裡的參數代表監聽的事件類型。

再次調用push方法：

發現兩個監聽器的數據都會打印。這一特點大傢要註意一下。

好瞭，關於Spring中的ApplicationEvent和ApplicationListener我們就介紹這麼多。

到此這篇關於SpringBoot中ApplicationEvent用法的文章就介紹到這瞭,更多相關Spring Boot ApplicationEvent用法內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：