Spring Boot 项目中使用事件发布和监听来实现消息推送和处理

devtools/2024/9/23 19:26:43/

对于在 Spring Boot 项目内部不同函数间或不同线程间的消息推送和处理机制，您可以使用 Spring 内置的事件发布/订阅机制。这种机制允许不同组件之间异步通信，而不需要它们彼此直接依赖。

以下是一个示例，展示了如何在 Spring Boot 项目中使用事件发布和监听来实现消息推送和处理。

1. 定义事件类

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

java">package com.example.demo.events;import org.springframework.context.ApplicationEvent;public class CustomEvent extends ApplicationEvent {private final String message;public CustomEvent(Object source, String message) {super(source);this.message = message;}public String getMessage() {return message;}
}

2. 创建事件发布者

接下来，创建一个事件发布者类，使用 ApplicationEventPublisher 发布事件：

java">package com.example.demo.publishers;import com.example.demo.events.CustomEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Component;@Component
public class EventPublisher {private final ApplicationEventPublisher publisher;public EventPublisher(ApplicationEventPublisher publisher) {this.publisher = publisher;}public void publishEvent(String message) {CustomEvent customEvent = new CustomEvent(this, message);publisher.publishEvent(customEvent);}
}

3. 创建事件监听器

然后，创建一个事件监听器类，使用 @EventListener 注解来监听事件：

java">package com.example.demo.listeners;import com.example.demo.events.CustomEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;@Component
public class EventListenerExample {@EventListenerpublic void handleCustomEvent(CustomEvent event) {System.out.println("Received event - " + event.getMessage());}
}

4. 使用事件发布者

最后，在任何需要的地方使用事件发布者来发布事件：

java">package com.example.demo;import com.example.demo.publishers.EventPublisher;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.Bean;@SpringBootApplication
public class DemoApplication {public static void main(String[] args) {SpringApplication.run(DemoApplication.class, args);}@Beanpublic CommandLineRunner commandLineRunner(ApplicationContext ctx) {return args -> {EventPublisher publisher = ctx.getBean(EventPublisher.class);publisher.publishEvent("Hello, Event Driven World!");};}
}