Spring注解驱动之ApplicationListener用法

概述

ApplicationListener概述

ApplicationListener按照字面意思，它应该是Spring里面的应用监听器，也就是Spring为我们提供的基于事件驱动开发的功能。

也就是说我们只要写一个监听器来实现ApplicationListener接口，该接口中泛型就是我们要监听的事件，那么如果我们发布对应的事件，就能在实现的监听器里面处理。

ApplicationListener作用

主要作用就是来监听IOC容器中发布的一些事件，只有事件发送便会来触发该监听器的回调，从而来完成事件驱动模型的开发。

ApplicationListener用法

首先，编写一个类来实现ApplicationListener接口，例如MyApplicationListener，这实际上就是写了一个监听器。

package com.meimeixia.ext;

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

// 当然了，监听器这东西要工作，我们还得把它添加在容器中
@Component
public class MyApplicationListener implements ApplicationListener<ApplicationEvent> {

	// 当容器中发布此事件以后，下面这个方法就会被触发
	@Override
	public void onApplicationEvent(ApplicationEvent event) {
		// TODO Auto-generated method stub
		System.out.println("收到事件：" + event);
	}
}

测试功能

package com.meimeixia.test;

import org.junit.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

import com.meimeixia.ext.ExtConfig;

public class IOCTest_Ext {
	
	@Test
	public void test01() {
		AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(ExtConfig.class);
		
		// 关闭容器
		applicationContext.close();
	}
}

可以看到我们收到了两个事件，这两个事件分别是org.springframework.context.event.ContextRefreshedEvent和org.springframework.context.event.ContextClosedEvent，其中第一个是容器已经刷新完成事件，第二个是容器关闭事件。而且，从下图中可以看到，这两个事件都是ApplicationEvent下面的事件。

只不过现在暂时还没用到容器开始和容器停止这两个事件而已。其实，想必你也已经猜到了，IOC容器在刷新完成之后便会发布ContextRefreshedEvent事件，一旦容器关闭了便会发布ContextClosedEvent事件。

我们自己来发布一个事件

    public static void main(String[] args) {
        final AnnotationConfigApplicationContext applicationContext
                = new AnnotationConfigApplicationContext(ExtConfig.class);
        applicationContext.publishEvent("发送事件");
        applicationContext.close();
    }

@Component
public class MyApplicationListener implements ApplicationListener<PayloadApplicationEvent> {

    public void onApplicationEvent(PayloadApplicationEvent applicationEvent) {
        System.out.println("收到事件：" + applicationEvent);
        System.out.println(applicationEvent.getPayload());
    }
}

参考

Spring注解驱动开发第38讲——你知道ApplicationListener的用法吗？