Spring的事件通知

从类注释中了解到，大概看了下它是在Spring4.2引入的注解（小于4.2版本的的小伙伴不用找啦），注解具体的处理逻辑在这里EventListenerMethodProcessor，注解可以用于方法上，参数可以是classs数组，可以写多个事件，等等；本节的主要目的是了解加使用这里就不再赘述了。

3.1Spring事件使用（继承ApplicationListener）

为了快速上手我们来用ContextRefreshedEvent（它代表Spring容器刷新完毕）来编写一个事件监听器：代码如下：

@Component
public class ContextRefreshedEventApplicationListener implements ApplicationListener{
	
	/**
	 * @Title: onApplicationEvent   
	 * @Description: 这是一个事件监听
	 * @param: event 要监听的事件       
	 * @throws
	 */
	@Override
	public void onApplicationEvent(ContextRefreshedEvent event) {
		System.out.println("ContextRefreshedEventApplicationListener监听到ContextRefreshedEvent刷新事件！");
	}
 
}

写一个启动类：

package com.example.demo.listener;
 
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
public class ContextRefreshedEventListenerTest {
 
	public static void main(String[] args) {
		System.out.println("初始化容器");
		AnnotationConfigApplicationContext ctx=new AnnotationConfigApplicationContext("com.example.demo");
		System.out.println("初始化容器完成");
		ctx.close();
		System.out.println("IOC容器被关闭了");
	}
}

最终输出结果

ContextRefreshedEventApplicationListener监听到ContextRefreshedEvent刷新事件！
初始化容器完成
18:32:54.135 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@12c8a2c0, started on Sat Aug 27 18:32:53 CST 2022
IOC容器被关闭了

3.2Spring事件使用（使用EventListener注解）

编写一个注解形式的事件监听

package com.example.demo.listener;
 
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
 
@Component
public class AnnotationContextRefreshedEventApplicationListener{
	
	/**
	 * @Title: onApplicationEvent   
	 * @Description: 这是一个事件监听
	 * @param: event 要监听的事件       
	 * @throws
	 */
	@EventListener
	public void onApplicationEvent(ContextRefreshedEvent event) {
		System.out.println("ContextRefreshedEventApplicationListener注解形式监听到ContextRefreshedEvent刷新事件！");
	}
 
}

还是调用上方的ContextRefreshedEventListenerTest执行结果如下：

ContextRefreshedEventApplicationListener监听到ContextRefreshedEvent刷新事件！
ContextRefreshedEventApplicationListener注解形式监听到ContextRefreshedEvent刷新事件！
初始化容器完成
19:07:15.491 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@12c8a2c0, started on Sat Aug 27 19:07:14 CST 2022
IOC容器被关闭了

四、渐入佳境（实际场景使用）

        在很多网站用户注册完成后会有短信通知或者邮件通知用户等事件发布，如果用硬编码的形式大家肯定会在注册完成后写如下方法，这样一直堆积的后果就是（我和上帝的秘密+祖传代码勿动）。

4.1注册成功事件

是不是觉得很简单？对只是继承下就完了。

package com.example.demo.listener;
 
import org.springframework.context.ApplicationEvent;
 
/**
 * @ClassName:  RegisterEvent   
 * @Description:注册成果的事件
 * @date:   2022年8月27日 下午7:17:48   
 *
 */
public class RegisterEvent extends ApplicationEvent {
 
	public RegisterEvent(Object source) {
		super(source);
	}
 
}

4.2监听事件发送短信（使用实现ApplicationListener）

package com.example.demo.listener;
 
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
 
@Component
public class ShortMsgListener implements ApplicationListener {
 
	@Override
	public void onApplicationEvent(RegisterEvent event) {
		System.out.println("监听到用户注册成功，发送短信");
	}
 
}

4.3监听事件发送邮件（使用方法注解@EventListener）

package com.example.demo.listener;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class EmailListener{
 
	@EventListener
	public void onApplicationEvent(RegisterEvent event) {
		System.out.println("监听到用户注册成功，发送邮件");
	}
 
}

发现这些做完了但是我怎样发布这个事件呢？

4.4发布事件

package com.example.demo.service;
 
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Service;
 
import com.example.demo.listener.RegisterEvent;
 
@Service
public class RegisterService implements ApplicationEventPublisherAware {
	
	ApplicationEventPublisher publisher;
	public void register(String id) {
		//注册逻辑
		System.out.println("用户id："+id+"注册成功！");
		//发布事件
		publisher.publishEvent(new RegisterEvent(id));
	}
	
	//这里采用了回调注入的方式，也可以用set方式直接传入
	@Override
	public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
		this.publisher=publisher;
	}
 
}

执行测试类

package com.example.demo.listener;
 
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
 
import com.example.demo.service.RegisterService;
 
public class RegisterEventListenerTest {
 
	public static void main(String[] args) {
		AnnotationConfigApplicationContext ctx=new AnnotationConfigApplicationContext("com.example.demo");
		RegisterService registerService = ctx.getBean(RegisterService.class);
		registerService.register("00001");
	}
}

执行结果，发现执行成功了，但是并没有解耦啊，上面只是简单列举了下，可以使用aop切面在方法中编写发布事件哦。相比堆积方法是不是清晰了很多了呢？

用户id：00001注册成功！
监听到用户id:00001注册成功，发送短信
监听到用户id:00001注册成功，发送邮件

五、蓦然回首（写在最后）

        代码不是炫技，以上列举的只是简单的场景实现，实际场景相信会有比上述场景较复杂的业务还有很多，引入特性和设计模式的初衷不是用来表现的很高级，最终的目的还是优雅的实现业务，保证项目的稳定运行才是王道。最后也希望大家可以看完这个文章对自己有真的帮助。