前言：

今天寫程式碼的時候遇到了監聽器，然後我就鬼使神差的翻了一下Spring框架文件,看到了自定義監聽事件，下面是我的收穫分享。

標準事件

spring中自帶有5種標準事件，ContextRefreshedEvent，ContextStartedEvent，ContextStoppedEvent，ContextClosedEvent，RequestHandledEvent。需要了解的話，可自行網上搜索或者看官方文件。

自定義事件

流程：

1. 繼承ApplicationEvent ，建立自定義事件。
2. 釋出我們的自定義事件，一般通過實現ApplicationEventPublisherAware 介面來完成。
3. 定義事件監聽器，一般是實現ApplicationListener介面或者使用@EventListener註解。

具體實現與程式碼展示

首先繼承ApplicationEvent類，建立我們的自定義事件。

public class MyApplicationEvent extends ApplicationEvent{

    private static final long serialVersionUID = -543396148689229096L;

    private final String address;

    public final String test;

    public
 
 MyApplicationEvent(Object source ,String address ,String test) {
        super(source);
        this.address = address;
        this.test = test;
    }

    @Override
    public String toString() {
        return "MyApplicationEvent [address=" + address + ", test=" + test + "]";
    }
    // accessor and other methods...
 


}

想要釋出我們的自定義事件,就需要呼叫ApplicationEventPublisher類中的publishEvent()方法 。官方文件中是叫我們建立一個實現ApplicationEventPublisherAware的類，並且註冊為spring中的bean。

@Component
public class MyApplicationEventService implements ApplicationEventPublisherAware{

    private List<String> blackList;
    private ApplicationEventPublisher publisher;

    public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
        this.publisher = publisher;
    }

    public void sendEmail(String address, String text) {
        blackList = new ArrayList<>();
        blackList.add("[email protected]");
        blackList.add("[email protected]");
        blackList.add("[email protected]");
        if (blackList.contains(address)) {
            publisher.publishEvent(new MyApplicationEvent(this, address, text));
            return;
        }
        // send email...
    }

    public void testListener(String address, String text) {
        MyApplicationEvent event = new MyApplicationEvent(this, address, text);
        publisher.publishEvent(event);
    }

}

在配置的時候，Spring容器會檢測到這個MyApplicationEventService實現 ApplicationEventPublisherAware並自動呼叫 setApplicationEventPublisher()。實際上，傳入的引數將是Spring容器本身; 您只需通過其ApplicationEventPublisher介面與應用程式上下文進行 互動。

完成釋出，就要寫事件監聽器，建立一個實現 ApplicationListener的類，並且註冊為spring中的bean。

@Component
public class MyApplicationListener implements ApplicationListener<MyApplicationEvent>{

    public void onApplicationEvent(MyApplicationEvent event) {
        System.out.println("my listener start");
        System.out.println(event.toString());
        System.out.println("my listener end");
    }

}

onApplicationEvent中編寫你的監聽邏輯。

總的實現效果就是，你一使用MyApplicationEventService類的sendEmail（）和testListener（）方法，監聽器就會觸發。寫一個controller來測試一下效果。

@RestController
@RequestMapping("/listener")
public class ListenerController {

    @Autowired
    private MyApplicationEventService myApplicationEventService;

    @GetMapping("/listener")
    public String testMyListener() {
        /*myApplicationEventService.sendEmail("[email protected]", "123123"); */
                            myApplicationEventService.testListener("[email protected]", "123");
        return "SUCCESS";
    }   
}

my listener start
MyApplicationEvent [address=john.doe@example.org, test=123]
my listener end

這說明我們的自定義事件和監聽器起作用了。

使用註解來定義監聽器

@Component
public class MyTestListener {

    @EventListener
    public void testListenr(MyApplicationEvent event) {
        System.out.println("my listener start");
        System.out.println(event.toString());
        System.out.println("my listener end");
    }

}

MyTestListener 類實現的效果和MyApplicationListener 類一樣。

使用註解還有兩好處

1 . 你可以在一個註解中監聽多種事件

@EventListener({ContextRefreshedEvent.class, MyApplicationEvent .class})
    public void testListenr() {
        System.out.println("my listener start");
        System.out.println("my listener end");
    }

2 . 還可以通過condition註釋的屬性新增額外的執行時過濾，該過濾器定義一個SpEL表示式。

@EventListener(condition="#event.test == '123'")
    public void testListenr(MyApplicationEvent event) {
        System.out.println("my listener start");
        System.out.println(event.toString());
        System.out.println("my listener end");
    }