springboot publish event 事件机制demo分享

标题：SpringBoot事件机制的示例分享

简介

Spring框架是一个非常流行的Java框架，其提供了事件机制来处理应用程序中的各种操作，SpringBoot是Spring的一个子框架，继承了Spring框架的事件机制，使得事件的处理更加简单和高效。

SpringBoot事件机制简介

SpringBoot事件机制允许应用程序中的不同组件之间进行通信。核心思想是：一个组件触发一个事件，然后其他组件可以听取这个事件并执行相应的操作。在SpringBoot 中，事件是基于ApplicationEvent 类的子类实现的。每个事件类可以有自己的附加信息，并且可以向其他组件传递这些信息。

以下是SpringBoot提供的事件类型：

• ContextStartedEvent: 当使用ApplicationContext启动时触发此事件
• ContextStoppedEvent: 当使用ApplicationContext停止时触发此事件
• ContextRefreshedEvent: 当使用ApplicationContext刷新时触发此事件
• ContextClosedEvent: 当使用ApplicationContext关闭时触发此事件
• ApplicationStartedEvent: 当应用程序启动时触发此事件
• ApplicationFailedEvent: 当启动应用程序失败时触发此事件
• ApplicationReadyEvent: 当应用程序已准备好时触发此事件
• ApplicationStoppedEvent: 当应用程序停止时触发此事件

SpringBoot发布事件

在SpringBoot中，可以通过EventPublisher 类来发布自定义事件。开发人员需要实现ApplicationEventPublisherAware 接口，该接口可以将EventPublisher 注入到自己的类中。实现类代码如下：

@Component
public class MyEventPublisher implements ApplicationEventPublisherAware {
    private ApplicationEventPublisher publisher;

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

    public void publish(String message) {
        MyEvent event = new MyEvent(this, message);
        publisher.publishEvent(event);
    }
}

SpringBoot监听事件

在SpringBoot中，可以通过@EventListener 注解来监听自定义事件。需要在监听器类上添加@EventListener注解，该注解需要指定要监听的事件类型。当应用程序触发指定类型的事件时，监听器中的@EventListener方法将被调用。

下面是一个示例：

@Component
public class MyEventListener {
    @EventListener
    public void handleMyEvent(MyEvent event) {
        String message = event.getMessage();
        System.out.println("监听到自定义事件，消息内容为：" + message);
    }
}

示例说明

示例1：

首先定义一个自定义事件MyEvent，代码如下：

public class MyEvent extends ApplicationEvent {
    private String message;

    public MyEvent(Object source, String message) {
        super(source);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

然后定义一个发布事件的类MyEventPublisher，通过该类发布自定义事件，代码如下：

@Component
public class MyEventPublisher implements ApplicationEventPublisherAware {
    private ApplicationEventPublisher publisher;

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

    public void publish(String message) {
        MyEvent event = new MyEvent(this, message);
        publisher.publishEvent(event);
    }
}

最后定义一个事件监听器MyEventListener，通过@EventListener注解来监听发布的事件，代码如下：

@Component
public class MyEventListener {
    @EventListener
    public void handleMyEvent(MyEvent event) {
        String message = event.getMessage();
        System.out.println("监听到自定义事件，消息内容为：" + message);
    }
}

测试代码：

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
    @Autowired
    private MyEventPublisher publisher;

    @Test
    public void testPublishEvent() throws Exception {
        publisher.publish("Hello, World!");
    }
}

运行测试代码，输出结果为：监听到自定义事件，消息内容为：Hello, World!

示例2

在SpringBoot中，也可以使用@Order注解来指定事件监听器的执行顺序。下面的示例中，我们演示了如何使用@Order注解来控制两个监听器对同一事件的处理顺序。

首先定义两个自定义事件监听器，代码如下：

@Component
public class MyEventListener1 {
    @EventListener
    @Order(1)
    public void handleMyEvent(MyEvent event) {
        System.out.println("MyEventListener1 处理事件，优先级为1");
    }
}

@Component
public class MyEventListener2 {
    @EventListener
    @Order(2)
    public void handleMyEvent(MyEvent event) {
        System.out.println("MyEventListener2 处理事件，优先级为2");
    }
}

测试代码：

@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
    @Autowired
    private MyEventPublisher publisher;

    @Test
    public void testPublishEvent() throws Exception {
        publisher.publish("Hello, World!");
    }
}

运行测试代码，输出结果为：

MyEventListener1 处理事件，优先级为1

MyEventListener2 处理事件，优先级为2

说明使用了@Order注解后，MyEventListener1 优先于 MyEventListener2 执行。