在 Spring Boot 中，监听和处理事件是一种常用的模式，用于在应用程序的不同部分之间传递信息。Spring 的事件发布/订阅模型允许我们创建自定义事件，并在这些事件发生时由注册的监听器进行处理。这里，我将提供一个简单的 Spring Boot 应用程序示例，其中将包括事件的定义、事件的发布以及事件的监听。
1. Spring Boot 应用程序示例
1.1 步骤 1: 创建 Spring Boot 项目
首先，我们可以使用 Spring Initializr（https://start.spring.io/）来快速生成一个新的Spring Boot 项目。在项目中添加Spring Web依赖，因为我们将使用一个简单的 REST API 来触发事件发布。
1.2 步骤 2: 定义事件
首先，我们定义一个简单的事件类。这个类将作为事件对象在应用程序中传递。
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; } }
复制代码
1.3 步骤 3: 创建事件监听器
然后，我们定义一个监听器来监听上面定义的事件。
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 - " + event.getMessage()); // 在这里可以执行更多操作，比如发送邮件、更新数据库等 } }
复制代码
1.4 步骤 4: 发布事件
现在，我们需要一个方式来发布事件。通常，这会在业务逻辑代码中完成，但为了简单起见，我们将通过 REST API 来触发事件的发布。
首先，在我们的 Spring Boot 应用中添加一个控制器。
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationEventPublisher; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController public class EventController { @Autowired private ApplicationEventPublisher eventPublisher; @PostMapping("/publish") public String publishEvent(@RequestParam String message) { CustomEvent customEvent = new CustomEvent(this, message); eventPublisher.publishEvent(customEvent); return "Event published with message: " + message; } }
复制代码
1.5 步骤 5: 运行我们的 Spring Boot 应用
现在，我们可以运行我们的 Spring Boot 应用。一旦应用启动，我们可以使用 Postman 或 curl 命令来触发事件发布。
bash复制代码
curl -X POST http://localhost:8080/publish?message=Hello%20Spring%20Events
复制代码
我们将在控制台看到输出，表明CustomEventListener已经接收并处理了事件。
1.6 总结
以上就是在 Spring Boot 中监听和处理自定义事件的一个完整示例。通过定义事件、创建监听器并发布事件，我们可以在不同的组件或服务之间轻松地传递信息。这种模式在微服务架构中尤其有用，因为它支持松耦合的通信方式。
2. 更详细的 Spring Boot 代码示例
当然，我会给出一个更详细的 Spring Boot 代码示例，该示例包含了完整的项目结构、配置以及必要的类来展示如何定义事件、监听事件以及通过 REST API 发布事件。
2.1 项目结构
假设我们的项目结构如下：
src/ |-- main/ | |-- java/ | | |-- com/ | | | |-- example/ | | | |-- demo/ | | | |-- DemoApplication.java | | | |-- CustomEvent.java | | | |-- CustomEventListener.java | | | |-- EventController.java | |-- resources/ | |-- application.properties | |-- pom.xml
复制代码
2.2 pom.xml
首先，确保我们的pom.xml文件中包含了 Spring Boot 的起步依赖（starter）和 Spring Web 依赖：
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!-- Optional, but recommended --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <properties> <java.version>11</java.version> <spring-boot.version>2.5.4</spring-boot.version> </properties> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>${spring-boot.version}</version> </parent>
复制代码
2.3 DemoApplication.java
这是 Spring Boot 的主应用类：
package com.example.demo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class DemoApplication { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } }
复制代码
2.4 CustomEvent.java
这是自定义事件类：
package com.example.demo; 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.5 CustomEventListener.java
这是事件监听器类：
package com.example.demo; 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 - " + event.getMessage()); // 在这里可以执行更多操作，比如发送邮件、更新数据库等 } }
复制代码
2.6 EventController.java
这是 REST 控制器类，用于发布事件：
package com.example.demo; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.ApplicationEventPublisher; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController public class EventController { @Autowired private ApplicationEventPublisher eventPublisher; @PostMapping("/publish") public String publishEvent(@RequestParam String message) { CustomEvent customEvent = new CustomEvent(this, message); eventPublisher.publishEvent(customEvent); return "Event published with message: " + message; } }
复制代码
2.7 application.properties
这是一个空的application.properties文件，但我们可以在这里添加任何 Spring Boot 配置。
2.8 运行和测试
（1）运行DemoApplication.java来启动 Spring Boot 应用。
（2）使用 Postman 或 curl 命令向http://localhost:8080/publish?message=Hello%20Spring%20Events发送 POST 请求。
（3）查看控制台输出，当我们向/publish端点发送 POST 请求时，Spring Boot 应用会捕获到这个请求，并通过EventController中的publishEvent方法发布一个CustomEvent。这个事件随后被CustomEventListener捕获并处理，我们会在控制台上看到类似这样的输出：
复制代码
Received custom event - Hello Spring Events
复制代码
这表明我们的事件监听器成功接收到了事件，并执行了相应的逻辑（在这个例子中是打印了一条消息）。
2.9 完整测试
为了完整地测试这个功能，我们可以使用 Postman 或者 curl 命令行工具来发送 HTTP POST 请求。以下是使用 curl 命令的示例：
bash复制代码
curl -X POST http://localhost:8080/publish?message=Hello%20Spring%20Events
复制代码
我们应该会收到一个响应，内容是：
复制代码
Event published with message: Hello Spring Events
复制代码
同时，我们的 Spring Boot 应用的控制台上也会显示事件被接收的消息。
2.10 总结
这个示例展示了如何在 Spring Boot 应用中定义自定义事件、发布事件以及监听事件。这是 Spring 事件驱动编程模型的一个简单应用，它允许我们以解耦的方式在应用的不同部分之间传递信息。在这个例子中，我们创建了一个简单的 REST API 来触发事件的发布，但这只是事件发布方式的一种。在更复杂的应用中，事件可能由多种不同的源触发，包括其他 REST API 调用、数据库更新、定时任务等。
通过利用 Spring 的事件监听和发布机制，我们可以轻松地构建出更加模块化和可维护的应用，因为我们可以在不修改监听器代码的情况下添加新的事件源，或者在不修改事件源代码的情况下添加新的监听器。这种解耦的方式使得应用更加灵活和可扩展。
文章转载自：TechSynapse
原文链接：https://www.cnblogs.com/TS86/p/18290024
体验地址：http://www.jnpfsoft.com/?from=infoq
评论