Java 创建事件(Event)、事件监听器(EventListener)、事件发布(publishEvent)详解和相关demo

在Java中，你可以使用事件（Event）、事件监听器（EventListener）和事件发布（publishEvent）来实现事件驱动的编程模型。下面我将简要介绍一下它们的基本概念：

1. 事件（Event）：事件是在软件应用程序中发生的某种事情，可以是用户交互、系统状态变化等。事件通常用一个类来表示，这个类包含了描述事件的相关信息。例如，如果你正在构建一个图形用户界面（GUI）应用程序，那么鼠标点击、键盘输入等就可以作为事件。

2. 事件发布（publishEvent）：事件发布指的是在事件发生时通知所有注册的监听器，并调用相应的处理方法。事件发布者负责管理监听器的注册和通知。

3. 事件监听器（EventListener）：事件监听器是一个接口，包含了处理特定类型事件的方法。当事件发生时，监听器会被通知并调用相应的处理方法。在Java中，通常需要自定义事件监听器来处理自定义的事件类型。

实现步骤 ：

ApplicationEventPublisher 是 Spring Framework 中用于发布事件的接口。publishEvent 方法是其主要方法之一，用于发布事件给注册的监听器。当你调用 publishEvent 方法时，Spring 会将事件传递给所有注册的监听器，这些监听器可以在事件发生时执行特定的逻辑。

通常，你可以通过以下步骤来使用 ApplicationEventPublisher 的 publishEvent 方法：

1. 实现一个事件类，通常是继承自 Spring 的 ApplicationEvent 类。
2. 在你的应用程序中注册一个或多个监听器，这些监听器会监听特定类型的事件。
3. 当某个条件被满足时，创建该事件的实例，并通过 ApplicationEventPublisher 的 publishEvent 方法发布该事件。

这样，所有注册的监听器都将收到该事件，并且可以执行相应的逻辑。

 1、事件对象（Event）

事件对象是包含了事件相关信息的类，用于在事件源和事件监听器之间传递数据。必须继承ApplicationEvent。

package com.yan.project.event;

import org.springframework.context.ApplicationEvent;

/**
 * @description: 事件对象（Event）
 *
 * @create: 2024-05-16 15:27
 **/
public class MyEvent extends ApplicationEvent {


    private EventVo eventVo;

    public MyEvent(Object source, EventVo eventVo) {
        super(source);
        this.eventVo = eventVo;
    }

    public EventVo getEventVo() {
        return eventVo;
    }
}

小技巧：

idea中可以点击如图小按钮，自动跳转至监听事件中。

2、事件发布（publishEvent）

事件发布是指事件源对象发出事件的过程。使用ApplicationEventPublisher的publishEvent()方法。

package com.xxx.project.event;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @create: 2024-03-21 23:36
 **/

@RestController
@RequestMapping("/testEvent")
public class testController {

    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;


    @GetMapping("/test")
    public String testEvent() {
        EventVo eventVo = new EventVo();
        eventVo.setId("001");

        applicationEventPublisher.publishEvent(new MyEvent(null, eventVo));
        return null;

    }


}

3、事件监听器（EventListener）

当相应的事件被发布时，这些方法会被触发执行，处理事件相关的逻辑。使用 @EventListener 注解或者 @TransactionalEventListener

package com.xxx.project.event;

import org.springframework.stereotype.Component;
import org.springframework.transaction.event.TransactionPhase;
import org.springframework.transaction.event.TransactionalEventListener;

/**
 * @create: 2024-05-16 16:47
 **/

@Component
public class EventListener {

    // 在Spring框架中，@TransactionalEventListener 注解允许你定义在事务的不同阶段处理事件。
    // phase = TransactionPhase.AFTER_COMMIT 指定了事件监听器应该在事务提交后执行。
    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
    public void processEvent(MyEvent myEvent){
        EventVo eventVo = myEvent.getEventVo();

        String id = eventVo.getId();

        //  处理其他业务
        // TODO:
    }
}

在Spring框架中，@TransactionalEventListener 注解允许你定义在事务的不同阶段处理事件。phase = TransactionPhase.AFTER_COMMIT 指定了事件监听器应该在事务提交后执行。

一般的，事件发布或事件监听后处理逻辑应该都是异步不阻塞线程。可以在发布时间或者事件监听方法上面加上@Async注解

总结

监听器的作用在于允许你对应用程序中发生的事件做出响应，并执行相应的逻辑。使用 Spring 的事件机制，你可以将应用程序分解成更小、更易于管理的部分，并允许这些部分之间以解耦的方式进行通信。

具体来说，对于上述示例中的监听器，其作用包括：

1. 解耦：通过将事件发布和处理逻辑分离，使得应用程序的不同部分之间解耦。事件发布者不需要知道谁在监听事件，而监听器也不需要直接调用事件发布者的方法。这种解耦可以使得代码更加模块化和可维护。

2. 扩展性：当你需要在应用程序的不同部分之间引入新的交互或逻辑时，可以轻松地添加新的事件和监听器，而不会影响现有的代码。这种扩展性使得你可以更容易地修改和扩展应用程序。

3. 异步处理：Spring 的事件机制支持异步处理事件，这意味着你可以在事件发生时选择立即执行监听器中的逻辑，或者将其放入队列中以便稍后执行。这在需要处理大量事件或执行长时间运行操作时特别有用，因为它可以提高应用程序的响应性能。

4. 通用性：通过定义自己的事件类型和监听器，你可以实现各种自定义的业务逻辑。这使得你可以根据应用程序的需求定义特定的事件，并编写特定的监听器来处理这些事件，从而实现更精细的控制和功能。

总的来说，整个调用过程是一个松耦合的事件驱动模型。业务部分和事件监听器之间没有直接的依赖关系，监听器则通过事件类型感知并响应事件，实现了对象之间的解耦。这种模式使得系统更加灵活、可扩展，并能更容易地实现事件驱动的业务逻辑。使得代码更具可维护性、可扩展性和可重用性。