Spring Boot 3.x 特性-事件与监听

在 Spring Boot 3.x 中，事件与监听机制是一个强大的功能，可以帮助开发者在应用程序生命周期的不同阶段执行自定义操作。通过使用事件和监听器，你可以在应用启动、关闭或其他特定事件发生时执行代码。以下是如何使用 Spring Boot 的事件与监听机制的详细指南。

1. 事件与监听器简介

Spring Boot 提供了一些内置的事件，如：

• ApplicationStartingEvent: 在运行 SpringApplication 时发送，但在任何处理开始之前。
• ApplicationEnvironmentPreparedEvent: 在 Environment 已知并准备好使用时发送。
• ApplicationPreparedEvent: 在刷新上下文之前发送。
• ApplicationStartedEvent: 在上下文已刷新并且应用程序启动之前发送。
• ApplicationReadyEvent: 在上下文已刷新并且应用程序启动之后发送。
• ApplicationFailedEvent: 在运行 SpringApplication 过程中出现异常时发送。

你也可以创建自定义事件和监听器。

2. 创建自定义事件

首先，定义一个自定义事件类，该类需要继承 ApplicationEvent：

import org.springframework.context.ApplicationEvent;

public class MyCustomEvent extends ApplicationEvent {
    private String message;

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

    public String getMessage() {
        return message;
    }
}

3. 创建事件监听器

然后，创建一个监听器类，该类需要实现 ApplicationListener 接口，并指定要监听的事件类型：

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class MyCustomEventListener implements ApplicationListener<MyCustomEvent> {

    @Override
    public void onApplicationEvent(MyCustomEvent event) {
        System.out.println("Received custom event - " + event.getMessage());
    }
}

4. 发布事件

你可以通过 ApplicationEventPublisher 在应用程序中的任何地方发布事件：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Component;

@Component
public class MyEventPublisher implements CommandLineRunner {

    @Autowired
    private ApplicationEventPublisher applicationEventPublisher;

    @Override
    public void run(String... args) throws Exception {
        MyCustomEvent event = new MyCustomEvent(this, "Hello, this is a custom event!");
        applicationEventPublisher.publishEvent(event);
    }
}

5. 使用内置事件

你还可以监听 Spring Boot 提供的内置事件。创建一个监听器类，并实现 ApplicationListener 接口或使用 @EventListener 注解：

import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class ApplicationReadyEventListener {

    @EventListener
    public void onApplicationReady(ApplicationReadyEvent event) {
        System.out.println("Application is ready!");
    }
}

6. 示例项目结构

src
└── main
    ├── java
    │   └── com
    │       └── example
    │           ├── Application.java
    │           ├── MyCustomEvent.java
    │           ├── MyCustomEventListener.java
    │           ├── MyEventPublisher.java
    │           └── ApplicationReadyEventListener.java
    └── resources
        └── application.properties

7. 运行和测试

运行你的 Spring Boot 应用程序，观察控制台输出。你应该看到在应用启动后打印的自定义事件和内置事件的消息。

总结

通过使用 Spring Boot 3.x 的事件和监听器机制，你可以在应用程序的不同阶段执行自定义逻辑，从而提升应用的灵活性和可维护性。自定义事件和监听器的使用非常简单，但功能强大，适用于各种应用场景。