笔记大全

SpringBoot中ApplicationEvent和ApplicationListener怎么使用

更新时间：2023-12-13

SpringBoot中ApplicationEvent和ApplicationListener

Spring框架非常注重模块化设计，整个框架分为多个相对独立的模块，每个模块都提供了相应的接口和类，方便开发者进行程序开发。在SpringBoot中，Spring框架提供了ApplicationEvent和ApplicationListener接口，用于处理应用程序中的事件和监听器。

ApplicationEvent接口

ApplicationEvent是Spring框架提供的事件接口，用于代表应用程序中发生的事件。开发者可以自己定义自己的事件，并通过ApplicationEvent来传递事件信息。为了创建自己的事件类，如果想让Spring框架监听到此事件，则需要继承ApplicationEvent类，并且提供无参的构造函数。

public class MyEvent extends ApplicationEvent {
    private String message;

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

    public String getMessage() {
        return message;
    }
}

上述代码定义了一个MyEvent事件，继承自ApplicationEvent，用来传递一个String类型的消息。其中构造函数需要传递源对象source和消息message。

ApplicationListener接口

ApplicationListener是Spring框架提供的监听器接口，用于监听事件发生并进行相应的操作。ApplicationListener需要实现onApplicationEvent方法，用于处理事件。该方法的参数为ApplicationEvent。

public class MyListener implements ApplicationListener {
    @Override
    public void onApplicationEvent(MyEvent event) {
        System.out.println("MyListener received event:" + event.getMessage());
    }
}

上述代码定义了一个MyListener监听器，实现ApplicationListener接口，用来监听MyEvent事件并输出消息。其中onApplicationEvent方法需要根据事件类型进行相应处理。

使用ApplicationEvent和ApplicationListener

使用ApplicationEvent和ApplicationListener非常简单，只需要创建自己的事件类和监听器类，然后将监听器注册到Spring容器中即可。Spring容器会自动调用相应的监听器处理事件。

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Bean
    public MyListener myListener() {
        return new MyListener();
    }
}

上述代码在SpringBoot应用程序中注册了一个MyListener监听器。在应用程序中，可以使用ApplicationContext对象来发布事件：

@Autowired
private ApplicationContext applicationContext;

public void testPublish() {
    MyEvent event = new MyEvent(this, "test event");
    applicationContext.publishEvent(event);
}

上述代码使用applicationContext发布了一个MyEvent事件，并传递了一个消息。Spring容器会自动将事件发送给注册的监听器进行处理。

总结

SpringBoot中ApplicationEvent和ApplicationListener提供了非常方便的事件和监听器处理功能，可以让应用程序模块化设计、松耦合，方便快捷。通过继承ApplicationEvent和实现ApplicationListener接口，可以对应用程序中的各类事件进行监听。通过发布事件和注册监听器，可以让框架在事件发生时自动调用相应的监听器进行处理。

c语言编程笔录