Spring framework Day 23:容器事件

前言

容器事件是 Spring Framework 中的一个重要概念，它提供了一种机制，使我们能够更好地了解和响应 Spring 容器中发生的各种事件。通过容器事件，我们可以在特定的时间点监听和处理容器中的各种状态变化、操作和事件触发，以实现更加灵活和可扩展的应用程序开发。

在本篇博客中，我们将深入探讨容器事件的概念及其使用方式。我们将介绍容器事件的作用和好处，以及如何定义和监听容器事件。同时，我们还将讨论一些常见的容器事件类型，并提供相应的示例代码和使用场景。

无论你是初次接触容器事件还是已经有一定经验的开发者，本篇博客都将帮助你更好地理解和利用容器事件来优化你的应用程序开发过程。

让我们开始探索容器事件的奇妙世界吧！

一、开始学习

1、新建项目，结构如下

2、添加 spring 依赖

 
    
    <dependencies>
        
        <dependency>
            <groupId>org.springframeworkgroupId>
            <artifactId>spring-contextartifactId>
            <version>5.3.23version>
        dependency>
 
        <dependency>
            <groupId>ch.qos.logbackgroupId>
            <artifactId>logback-classicartifactId>
            <version>1.4.5version>
        dependency>
 
 
    dependencies>

 3、在 event 包下新建 MyEvent 事件类、MyEventListen 监听类

MyEvent 事件类

/**
 * @Date 2023-10-13
 * @Author qiu
 * 自定义事件对象，这个对象用于发布给 spring 容器，
 * 容器就会自动处理这个事件
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class MyEvent {
 
    /**
     * 事件消息
     */
    private String message;
 
 
 
}

• @Data：这是一个Lombok注解，会自动生成getter、setter、toString、equals和hashCode等常用方法。
• @AllArgsConstructor：这是一个Lombok注解，会生成一个包含所有参数的构造函数。
• @NoArgsConstructor：这是一个Lombok注解，会生成一个无参的构造函数。

该类有一个字段message，用来存储事件消息。通过使用Lombok注解，可以简化类的编写过程，减少样板代码的书写。Lombok会在编译时自动为字段生成getter和setter方法，并为类生成toString、equals和hashCode等方法。

MyEventListen 监听类

/**
 * @Date 2023-10-13
 * @Author qiu
 * 自定义事件监听器，用于监听用户发布的事件并进行处理，
 * 监听器需要纳入容器管理
 */
@Slf4j
@Component
public class MyEventListener {
 
    /**
     * 自定义事件监听方法，容器会将用户发布的
     * 事件对象传入这个方法中进行事件处理
     *
     * @EventListener 用于标识当前方法为监听方法
     *
     * @param event
     */
    @EventListener
    public void handlerEvent(MyEvent event) {
        log.info("处理事件：" + event.getMessage());
    }
 
}

• @Slf4j：这是一个Lombok注解，用于自动生成日志记录器（Logger）。
• @Component：这是一个Spring注解，用于将该类标识为一个组件，让Spring容器能够扫描并管理该类的实例化和依赖注入。

该类中定义了一个名为handlerEvent的方法，并使用了@EventListener注解。这个注解表示该方法是一个事件监听器，用来处理特定类型的事件。在示例中，它处理类型为MyEvent的事件。

当应用程序触发一个MyEvent事件时，Spring框架会自动调用handlerEvent方法，并将触发的事件作为参数传递给该方法。方法内部通过日志记录器打印了处理事件的消息。

通过使用Spring的事件机制，可以实现模块之间的松耦合，让不同部分的代码能够响应和处理特定类型的事件。在其他地方触发MyEvent事件时，MyEventListener中的handlerEvent方法会被自动调用，从而实现事件的处理逻辑。

4、在 config 包下新建一个 Appconfig 配置类

@Configuration
@ComponentScan(basePackages = "edu.nf.ch23")
public class AppConfig {
}

• @Configuration：这是一个Spring注解，表示该类是一个配置类。配置类通常用来配置Spring应用程序上下文中的Bean。
• @ComponentScan：这个注解告诉Spring容器去哪些包下面扫描组件类（被@Component或其他组件注解标记的类），并将它们注册到Spring容器中。

在示例中，basePackages参数指定了要扫描的基础包路径为edu.nf.ch23，Spring会自动扫描该包下的所有组件类并将它们注册到应用程序上下文中。

5、测试

public class Main {
 
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        // 创建事件对象
        MyEvent hello = new MyEvent("hello");
        // 向容器发布事件
        context.publishEvent(hello);
    }
 
}

运行结果

在main方法中，首先创建了一个AnnotationConfigApplicationContext对象，并传入了AppConfig.class参数。这个对象表示了一个Spring应用程序上下文，它通过加载AppConfig配置类来初始化应用程序上下文。

接着，创建了一个MyEvent对象，并传入一个字符串参数"hello"。这个对象是一个自定义的事件类型，它的构造函数接受一个字符串参数，用来存储事件消息。

最后，通过调用context的publishEvent方法来向应用程序上下文发布事件。这个方法接受一个事件对象作为参数，在示例中传入了之前创建的hello对象。

当事件被发布后，Spring容器会自动查找所有对该事件类型感兴趣的事件监听器，并调用它们的处理方法。在示例中，MyEventListener中的handlerEvent方法就是一个MyEvent事件的监听器，当事件被发布后，这个方法会被自动调用，并输出事件的消息。

二、使用容器事件有什么好处

 使用容器事件（Application Events）机制有以下好处：

1. 松耦合：容器事件机制可以实现模块之间的松耦合，不同模块之间通过事件通信，各模块之间不直接依赖。

2. 可维护性：容器事件机制可以帮助开发者将应用程序中的各个功能逻辑分离出来，使代码更加清晰、易于维护。

3. 可扩展性：容器事件机制可以让开发者很方便地在代码中添加或删除事件监听，从而使应用程序具有更高的可扩展性和灵活性。

4. 可测试性：容器事件机制可以将代码的各个部分独立测试，从而简化测试过程并提高代码质量。

总的来说，容器事件是一种非常强大的机制，它能够让应用程序具有更高的可扩展性、可维护性和可测试性，从而提高代码的质量和开发效率。

三、总结

在实际开发中，我们可以在Spring应用程序上下文中注册一个或多个事件监听器，这些监听器会异步地处理在应用程序上下文中发布的事件。通过这种方式，我们可以将不同模块之间的逻辑分离，提高代码的清晰度和可读性。

因此，掌握容器事件机制对于一个Java开发人员来说是非常重要的，它可以帮助我们写出更加优秀、高效、可靠的代码。

四、gitee 案例

案例完整地址：https://gitee.com/qiu-feng1/spring-framework.git