Springboot自定义事件

### 创建和使用 Spring Boot 自定义事件 在 Spring Boot 中，自定义事件的实现基于 Spring Framework 提供的事件发布-订阅机制。通过该机制可以轻松地创建、发布并监听自定义事件。 #### 1. 定义自定义事件类 为了创建自定义事件，需要继承 `ApplicationEvent` 类，并在其构造函数中传递事件源对象。通常情况下，事件源是一个简单的 Java 对象，表示触发事件的对象实例[^1]。 ```java import org.springframework.context.ApplicationEvent; public class CustomEvent extends ApplicationEvent { private String message; public CustomEvent(Object source, String message) { super(source); this.message = message; } public String getMessage() { return message; } } ``` #### 2. 实现事件监听器 要监听自定义事件，需创建一个带有 `@Component` 注解的类，并在其中声明一个方法来处理事件。此方法应标注为 `@EventListener` 并接收自定义事件作为参数。 ```java import org.springframework.context.event.EventListener; import org.springframework.stereotype.Component; @Component public class CustomEventListener { @EventListener public void handleCustomEvent(CustomEvent event) { System.out.println("Received custom event - Message: " + event.getMessage()); } } ``` #### 3. 发布自定义事件 可以通过注入 `ApplicationEventPublisher` 接口并将事件对象传递给其 `publishEvent()` 方法来发布事件。 ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationEventPublisher; import org.springframework.stereotype.Service; @Service public class CustomEventService { private final ApplicationEventPublisher publisher; @Autowired public CustomEventService(ApplicationEventPublisher publisher) { this.publisher = publisher; } public void publish(String message) { CustomEvent event = new CustomEvent(this, message); publisher.publishEvent(event); } } ``` #### 4. 配置与测试 确保项目中的组件扫描能够发现上述类（即它们被正确注册到 Spring 应用上下文中），然后可以在任何地方调用服务类的方法来触发事件发布过程。 ```java import org.springframework.boot.CommandLineRunner; import org.springframework.stereotype.Component; @Component public class TestRunner implements CommandLineRunner { private final CustomEventService customEventService; public TestRunner(CustomEventService customEventService) { this.customEventService = customEventService; } @Override public void run(String... args) throws Exception { customEventService.publish("This is a test message."); } } ``` 以上代码展示了完整的流程：从定义事件到最终完成事件的发布与监听。 ---