詳解SpringBoot實(shí)現(xiàn)事件同步與異步監(jiān)聽(tīng)

更新時(shí)間：2022年06月22日 09:25:35 作者：IT利刃出鞘

這篇文章主要通過(guò)示例為大家詳細(xì)介紹了SpringBoot中的事件的用法和原理以及如何實(shí)現(xiàn)事件同步與異步監(jiān)聽(tīng)，快跟隨小編一起學(xué)習(xí)學(xué)習(xí)吧

簡(jiǎn)介

說(shuō)明

本文用示例介紹SpringBoot中的事件的用法及原理。

事件監(jiān)聽(tīng)簡(jiǎn)述

事件的發(fā)布與監(jiān)聽(tīng)從屬于觀察者模式；和MQ相比，事件的發(fā)布與監(jiān)聽(tīng)偏向于處理服務(wù)內(nèi)的某些邏輯。

多個(gè)監(jiān)聽(tīng)器可以監(jiān)聽(tīng)同一個(gè)事件。例如：發(fā)布了事件A，監(jiān)聽(tīng)器A和監(jiān)聽(tīng)器B都監(jiān)聽(tīng)了事件A，則監(jiān)聽(tīng)器A和B都會(huì)進(jìn)行處理。

同步與異步監(jiān)聽(tīng)

監(jiān)聽(tīng)方式	特點(diǎn)	使用時(shí)機(jī)
同步監(jiān)聽(tīng)	發(fā)布器線程與監(jiān)聽(tīng)器線程處于同一線程	1.監(jiān)聽(tīng)邏輯處理較快 2.需要緊接著根據(jù)監(jiān)聽(tīng)器追蹤業(yè)務(wù)線程
異步監(jiān)聽(tīng)	發(fā)布器線程與監(jiān)聽(tīng)器線程處于不同線程	1.監(jiān)聽(tīng)邏輯處理比較耗時(shí) 2.追求響應(yīng)性能

事件的順序

可使用實(shí)現(xiàn)Ordered接口的方式，調(diào)整監(jiān)聽(tīng)器順序。

注意：必須是同時(shí)實(shí)現(xiàn) ApplicationListener<MyEvent>,Ordered這樣的方法才能控制順序。

下邊幾種都是無(wú)法控制順序的：

@Component+@EventListerner+實(shí)現(xiàn)Ordered
實(shí)現(xiàn) ApplicationListener<MyEvent>+@Order

實(shí)例

同步監(jiān)聽(tīng)(無(wú)序)

事件

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
 
public class MyEvent extends ApplicationEvent {
 
    public MyEvent(Object source) {
        super(source);
    }
 
}

監(jiān)聽(tīng)器

監(jiān)聽(tīng)器1

package com.example.event;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener {
    @EventListener
    public void abc(MyEvent event) {
        System.out.println("監(jiān)聽(tīng)器：        " + "MyListener");
        System.out.println("監(jiān)聽(tīng)器所在線程：" + Thread.currentThread().getName());
        System.out.println("事件：          " + event);
        System.out.println("事件的數(shù)據(jù)：    " + event.getSource());
    }
}

監(jiān)聽(tīng)器2

package com.example.event;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener2 {
 
    @EventListener
    public void onApplicationEvent(MyEvent event) {
        System.out.println("監(jiān)聽(tīng)器：      " + "MyListener2");
        System.out.println("  所在線程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的數(shù)據(jù)：" + event.getSource());
    }
}

發(fā)布器

package com.example.event;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
 
@Component
public class MyPublisher {
    @Autowired
    ApplicationContext applicationContext;
 
    public void myPublish(String message) {
        System.out.println("發(fā)布器所在線程：" + Thread.currentThread().getName());
        applicationContext.publishEvent(new MyEvent(message));
    }
}

測(cè)試

寫(xiě)一個(gè)Controller

package com.example.controller;
 
import com.example.event.MyPublisher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Autowired
    MyPublisher myPublisher;
 
    @GetMapping("/test1")
    public String test1() {
        myPublisher.myPublish("Hello");
        return "test1 success";
    }
}

啟動(dòng)后，訪問(wèn)：http://localhost:8080/test1

后端輸出：

發(fā)布器所在線程：http-nio-8080-exec-1
監(jiān)聽(tīng)器： MyListener
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello
監(jiān)聽(tīng)器： MyListener2
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello

可以發(fā)現(xiàn)，所有監(jiān)聽(tīng)器和發(fā)布器都在同一個(gè)線程。

同步監(jiān)聽(tīng)(有序)

事件

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
 
public class MyEvent extends ApplicationEvent {
 
    public MyEvent(Object source) {
        super(source);
    }
 
}

監(jiān)聽(tīng)器

監(jiān)聽(tīng)器1

package com.example.event;
 
import org.springframework.context.ApplicationListener;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener implements ApplicationListener<MyEvent>,  Ordered {
    @Override
    public void onApplicationEvent(MyEvent event) {
        System.out.println("監(jiān)聽(tīng)器：      " + "MyListener");
        System.out.println("  所在線程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的數(shù)據(jù)：" + event.getSource());
    }
 
    @Override
    public int getOrder() {
        return 2;
    }
}

監(jiān)聽(tīng)器2

package com.example.event;
 
import org.springframework.context.ApplicationListener;
import org.springframework.core.Ordered;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener2 implements ApplicationListener<MyEvent>, Ordered {
 
    public void onApplicationEvent(MyEvent event) {
        System.out.println("監(jiān)聽(tīng)器：      " + "MyListener2");
        System.out.println("  所在線程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的數(shù)據(jù)：" + event.getSource());
    }
 
    @Override
    public int getOrder() {
        return 1;
    }
}

發(fā)布器

package com.example.event;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
 
@Component
public class MyPublisher {
    @Autowired
    ApplicationContext applicationContext;
 
    public void myPublish(String message) {
        System.out.println("發(fā)布器所在線程：" + Thread.currentThread().getName());
        applicationContext.publishEvent(new MyEvent(message));
    }
}

測(cè)試

寫(xiě)一個(gè)Controller

package com.example.controller;
 
import com.example.event.MyPublisher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Autowired
    MyPublisher myPublisher;
 
    @GetMapping("/test1")
    public String test1() {
        myPublisher.myPublish("Hello");
        return "test1 success";
    }
}

啟動(dòng)后，訪問(wèn)：http://localhost:8080/test1

后端輸出：

發(fā)布器所在線程：http-nio-8080-exec-1
監(jiān)聽(tīng)器： MyListener2
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello
監(jiān)聽(tīng)器： MyListener
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello

如果將監(jiān)聽(tīng)器的實(shí)現(xiàn)的Ordered順序顛倒，則輸出結(jié)果如下：

發(fā)布器所在線程：http-nio-8080-exec-1
監(jiān)聽(tīng)器： MyListener
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello
監(jiān)聽(tīng)器： MyListener2
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello

異步監(jiān)聽(tīng)(無(wú)序)

方法：

開(kāi)啟異步監(jiān)聽(tīng)
在監(jiān)聽(tīng)器上加@Async（此監(jiān)聽(tīng)器必須是@Component方法注冊(cè)的）

事件

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
 
public class MyEvent extends ApplicationEvent {
 
    public MyEvent(Object source) {
        super(source);
    }
 
}

同步監(jiān)聽(tīng)器

package com.example.event;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener {
    @EventListener
    public void abc(MyEvent event) {
        System.out.println("監(jiān)聽(tīng)器：      " + "MyListener");
        System.out.println("  所在線程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的數(shù)據(jù)：" + event.getSource());
    }
}

異步監(jiān)聽(tīng)器

package com.example.event;
 
import org.springframework.context.event.EventListener;
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Component;
 
@Component
@Async
public class MyListener2 {
 
    @EventListener
    public void onApplicationEvent(MyEvent event) {
        System.out.println("監(jiān)聽(tīng)器：      " + "MyListener2");
        System.out.println("  所在線程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的數(shù)據(jù)：" + event.getSource());
    }
}

發(fā)布器

package com.example.event;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
 
@Component
public class MyPublisher {
    @Autowired
    ApplicationContext applicationContext;
 
    public void myPublish(String message) {
        System.out.println("發(fā)布器所在線程：" + Thread.currentThread().getName());
        applicationContext.publishEvent(new MyEvent(message));
    }
}

啟動(dòng)類

package com.example;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableAsync;
 
@SpringBootApplication
@EnableAsync
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

測(cè)試

寫(xiě)一個(gè)Controller

package com.example.controller;
 
import com.example.event.MyPublisher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Autowired
    MyPublisher myPublisher;
 
    @GetMapping("/test1")
    public String test1() {
        myPublisher.myPublish("Hello");
        return "test1 success";
    }
}

啟動(dòng)后，訪問(wèn)：http://localhost:8080/test1

后端輸出：

發(fā)布器所在線程：http-nio-8080-exec-1
監(jiān)聽(tīng)器： MyListener
所在線程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello
監(jiān)聽(tīng)器： MyListener2
所在線程： task-1
事件： com.example.event.MyEvent[source=Hello]
事件的數(shù)據(jù)：Hello

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

您可能感興趣的文章: