SpringBoot的事件监听:为bean之间的消息通信提供支持。当一个bean做完一件事以后,通知另一个bean知晓并做出相应处理。这时,我们需要另一个bean,监听当前bean所发生的事件。

实现SpringBoot自定义事件监控实现步骤

  1. 自定义事件,一般是继承ApplicationEvent抽象类
  2. 定义事件监听器,一般是实现ApplicationListener接口
  3. 把监听器加入到SpringApplication中
  • ApplicationListener.addListener();然后发布事件
  • 把监听器纳入到spring容器中管理:@Conponent
  • 在application.properties配置文件中配置context.listener.classes=监听器全类名
  • 编写一个类,纳入spring容器中,编写一个带参的方法,参数为事件的父类或需要监听的事件,加上@EventListener
  1. 发布事件

步骤共计四步,第三步有四种实现方式。

执行以上四步,必须先创建一个Maven项目,并且添加SpringBoot Jar包(spring-boot-starter-web)



方式一



    第一步自定义事件:

package org.lvgang;

import org.springframework.context.ApplicationEvent;

/**
 * 自定义SpringBoot事件
 */
public class MyApplicationEvent extends ApplicationEvent {

    private static final long serialVersionUID = 1L;

    public MyApplicationEvent(Object source) {
        super(source);
    }
}



    第二步定义事件监听器

package org.lvgang;

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

/**
 * 事件监听
 */
public class MyApplicationListener implements ApplicationListener<MyApplicationEvent> {

    public void onApplicationEvent(MyApplicationEvent event) {
        System.out.println("接收到事件:"+event.getClass());
    }

}



    第三步把监听器加入到SpringApplication中,并发布

package org.lvgang;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

/**
 * SpringBoot Main
 */
@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(App.class);
        //配置事件监听器(第三步)
        application.addListeners(new MyApplicationListener());
        ConfigurableApplicationContext context = application.run(args);
        //发布事件(第四步)
        context.publishEvent(new MyApplicationEvent(new Object()));
        context.close();
    }
}



    结果

通过启动App查看控制台,是否输出了以一下信息,输入以下信息表示成功



方式二



    第一步自定义事件,与方式一一致



    第二步定义事件监听器,把监听器加入到SpringApplication中

package org.lvgang;

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

/**
 * 事件监听
 */

@Component
public class MyApplicationListener implements ApplicationListener<MyApplicationEvent> {

    public void onApplicationEvent(MyApplicationEvent event) {
        System.out.println("接收到事件:"+event.getClass());
    }

}

    直接在MyApplicationListener类上加上@Component注解,纳入spring容器管理



    第三步发布事件

package org.lvgang;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;

/**
 * SpringBoot Main
 */
@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(App.class);
        //配置事件监听器
        //application.addListeners(new MyApplicationListener());
        ConfigurableApplicationContext context = application.run(args);
        //发布事件
        context.publishEvent(new MyApplicationEvent(new Object()));
        context.close();
    }
}



    结果

通过启动App查看控制台,是否输出了以一下信息,输入以下信息表示成功



方式三



    第一步自定义事件,与方式一一致



    第二步定义事件监听器,与方式一一致



    第三步通过配置文件,把监听器加入到SpringApplication中

    在配置文件中配置

context.listener.classes=com.zhihao.miao.MyApplicationListener



    第四步发布事件,与方式二第三步一致



    结果

    通过启动App查看控制台,是否输出了以一下信息,输入以下信息表示成功



方式四



    第一步自定义事件,与方式一一致



    第二步编写EventHandler,替代上文中的ApplicationListener

        编写一个类MyEventHandler,替代上文中的MyApplicationListener,将其纳入spring容器中,编写一个带参的方法,参数为事件的父类或需要监听的事件,加上@EventListener。(参数的范围越广泛,监听到的事件越多)

package org.lvgang;

import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class MyEventHandle {


    /**
     * 参数任意(为Object)的时候所有事件都会监听到
     * 所有,该参数事件,或者其子事件(子类)都可以接收到
     */
    @EventListener
    public void event(Object event){
        System.out.println("MyEventHandle 接收到事件:" + event.getClass());
    }

}



    第三步,与方式二第三步一致



    结果

    通过启动App查看控制台,是否输出了以一下信息,输入以下信息表示成功

springboot自定义重连数据源 springboot自定义listener_事件监听器

    至此,springboot的四种事件监听方式就介绍完!