SpringBoot事件监听机制及观察者模式/发布订阅模式
本篇要点
- 介绍观察者模式和发布订阅模式的区别。
- SpringBoot快速入门事件监听。
什么是观察者模式?
观察者模式是经典行为型设计模式之一。
在GoF的《设计模式》中,观察者模式的定义:在对象之间定义一个一对多的依赖,当一个对象状态改变的时候,所有依赖的对象都会自动收到通知。如果你觉得比较抽象,接下来这个例子应该会让你有所感觉:
就拿用户注册功能为例吧,假设用户注册成功之后,我们将会发送邮件,优惠券等等操作,很容易就能写出下面的逻辑:
@RestController
@RequestMapping("/user")
public class SimpleUserController {
@Autowired
private SimpleEmailService emailService;
@Autowired
private SimpleCouponService couponService;
@Autowired
private SimpleUserService userService;
@GetMapping("/register")
public String register(String username) {
// 注册
userService.register(username);
// 发送邮件
emailService.sendEmail(username);
// 发送优惠券
couponService.addCoupon(username);
return "注册成功!";
}
}
这样写会有什么问题呢?受王争老师启发:
方法调用时,同步阻塞导致响应变慢,需要异步非阻塞的解决方案。
注册接口此时做的事情:注册,发邮件,优惠券,违反单一职责的原则。当然,如果后续没有拓展和修改的需求,这样子倒可以接受。
如果后续注册的需求频繁变更,相应就需要频繁变更register方法,违反了开闭原则。
针对以上的问题,我们想一想解决的方案:
一、异步非阻塞的效果可以新开一个线程执行耗时的发送邮件任务,但频繁地创建和销毁线程比较耗时,并且并发线程数无法控制,创建过多的线程会导致堆栈溢出。
二、使用线程池执行任务解决上述问题。
@Service
@Slf4j
public class SimpleEmailService {
// 启动一个线程执行耗时操作
public void sendEmail(String username) {
Thread thread = new Thread(()->{
try {
// 模拟发邮件耗时操作
Thread.sleep(3000);
} catch (InterruptedException e) {
e.printStackTrace();
}
log.info("给用户 [{}] 发送邮件...", username);
});
thread.start();
}
}
@Slf4j
@Service
public class SimpleCouponService {
ExecutorService executorService = Executors.newSingleThreadExecutor();
// 线程池执行任务,减少资源消耗
public void addCoupon(String username) {
executorService.execute(() -> {
try {
Thread.sleep(3000);
} catch (InterruptedException e) {
e.printStackTrace();
}
log.info("给用户 [{}] 发放优惠券", username);
});
}
}
这里用户注册事件对【发送短信和优惠券】其实是一对多的关系,可以使用观察者模式进行解耦:
/**
* 主题接口
* @author Summerday
*/
public interface Subject {
void registerObserver(Observer observer);
void removeObserver(Observer observer);
void notifyObservers(String message);
}
/**
* 观察者接口
* @author Summerday
*/
public interface Observer {
void update(String message);
}
@Component
@Slf4j
public class EmailObserver implements Observer {
@Override
public void update(String message) {
log.info("向[{}]发送邮件", message);
}
}
@Component
@Slf4j
public class CouponObserver implements Observer {
@Override
public void update(String message) {
log.info("向[{}]发送优惠券",message);
}
}
@Component
public class UserRegisterSubject implements Subject {
@Autowired
List<Observer> observers;
@Override
public void registerObserver(Observer observer) {
observers.add(observer);
}
@Override
public void removeObserver(Observer observer) {
observers.remove(observer);
}
@Override
public void notifyObservers(String username) {
for (Observer observer : observers) {
observer.update(username);
}
}
}
@RestController
@RequestMapping("/")
public class UserController {
@Autowired
UserRegisterSubject subject;
@Autowired
private SimpleUserService userService;
@GetMapping("/reg")
public String reg(String username) {
userService.register(username);
subject.notifyObservers(username);
return "success";
}
}
发布订阅模式是什么?
观察者模式和发布订阅模式是有一点点区别的,区别有以下几点:
- 前者:观察者订阅主题,主题也维护观察者的记录,而后者:发布者和订阅者不需要彼此了解,而是在消息队列或代理的帮助下通信,实现松耦合。
- 前者主要以同步方式实现,即某个事件发生时,由Subject调用所有Observers的对应方法,后者则主要使用消息队列异步实现。
图源:https://hackernoon.com/observer-vs-pub-sub-pattern-50d3b27f838c
尽管两者存在差异,但是他们其实在概念上相似,网上说法很多,不需要过于纠结,重点在于我们需要他们为什么出现,解决了什么问题。
Spring事件监听机制概述
SpringBoot中事件监听机制则通过发布-订阅实现,主要包括以下三部分:
- 事件 ApplicationEvent,继承JDK的EventObject,可自定义事件。
- 事件发布者 ApplicationEventPublisher,负责事件发布。
- 事件监听者 ApplicationListener,继承JDK的EventListener,负责监听指定的事件。
我们通过SpringBoot的方式,能够很容易实现事件监听,接下来我们改造一下上面的案例:
SpringBoot事件监听
定义注册事件
public class UserRegisterEvent extends ApplicationEvent {
private String username;
public UserRegisterEvent(Object source) {
super(source);
}
public UserRegisterEvent(Object source, String username) {
super(source);
this.username = username;
}
public String getUsername() {
return username;
}
}
注解方式 @EventListener定义监听器
/**
* 注解方式 @EventListener
* @author Summerday
*/
@Service
@Slf4j
public class CouponService {
/**
* 监听用户注册事件,执行发放优惠券逻辑
*/
@EventListener
public void addCoupon(UserRegisterEvent event) {
log.info("给用户[{}]发放优惠券", event.getUsername());
}
}
实现ApplicationListener的方式定义监听器
/**
* 实现ApplicationListener<Event>的方式
* @author Summerday
*/
@Service
@Slf4j
public class EmailService implements ApplicationListener<UserRegisterEvent> {
/**
* 监听用户注册事件, 异步发送执行发送邮件逻辑
*/
@Override
@Async
public void onApplicationEvent(UserRegisterEvent event) {
log.info("给用户[{}]发送邮件", event.getUsername());
}
}
注册事件发布者
@Service
@Slf4j
public class UserService implements ApplicationEventPublisherAware {
// 注入事件发布者
private ApplicationEventPublisher applicationEventPublisher;
@Override
public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
this.applicationEventPublisher = applicationEventPublisher;
}
/**
* 发布事件
*/
public void register(String username) {
log.info("执行用户[{}]的注册逻辑", username);
applicationEventPublisher.publishEvent(new UserRegisterEvent(this, username));
}
}
定义接口
@RestController
@RequestMapping("/event")
public class UserEventController {
@Autowired
private UserService userService;
@GetMapping("/register")
public String register(String username){
userService.register(username);
return "恭喜注册成功!";
}
}
主程序类
@EnableAsync // 开启异步
@SpringBootApplication
public class SpringBootEventListenerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootEventListenerApplication.class, args);
}
}
测试接口
启动程序,访问接口:http://localhost:8081/event/register?username=天乔巴夏
,结果如下:
2020-12-21 00:59:46.679 INFO 12800 --- [nio-8081-exec-1] com.hyh.service.UserService : 执行用户[天乔巴夏]的注册逻辑
2020-12-21 00:59:46.681 INFO 12800 --- [nio-8081-exec-1] com.hyh.service.CouponService : 给用户[天乔巴夏]发放优惠券
2020-12-21 00:59:46.689 INFO 12800 --- [ task-1] com.hyh.service.EmailService : 给用户[天乔巴夏]发送邮件
源码下载
本文内容均为对优秀博客及官方文档总结而得,原文地址均已在文中参考阅读处标注。最后,文中的代码样例已经全部上传至Gitee:https://gitee.com/tqbx/springboot-samples-learn,另有其他SpringBoot的整合哦。
参考阅读
SpringBoot事件监听机制及观察者模式/发布订阅模式的更多相关文章
- SpringBoot事件监听机制源码分析(上) SpringBoot源码(九)
SpringBoot中文注释项目Github地址: https://github.com/yuanmabiji/spring-boot-2.1.0.RELEASE 本篇接 SpringApplicat ...
- Spring 事件监听机制及原理分析
简介 在JAVA体系中,有支持实现事件监听机制,在Spring 中也专门提供了一套事件机制的接口,方便我们实现.比如我们可以实现当用户注册后,给他发送一封邮件告诉他注册成功的一些信息,比如用户订阅的主 ...
- Spring ApplicationContext(八)事件监听机制
Spring ApplicationContext(八)事件监听机制 本节则重点关注的是 Spring 的事件监听机制,主要是第 8 步:多播器注册:第 10 步:事件注册. public void ...
- 7_3.springboot2.x启动配置原理_3.事件监听机制
事件监听机制配置在META-INF/spring.factories ApplicationContextInitializer SpringApplicationRunListenerioc容器中的 ...
- Java事件监听机制与观察者设计模式
一. Java事件监听机制 1. 事件监听三要素: 事件源,事件对象,事件监听器 2. 三要素之间的关系:事件源注册事件监听器后,当事件源上发生某个动作时,事件源就会调用事件监听的一个方法,并将事件对 ...
- Halo 开源项目学习(六):事件监听机制
基本介绍 Halo 项目中,当用户或博主执行某些操作时,服务器会发布相应的事件,例如博主登录管理员后台时发布 "日志记录" 事件,用户浏览文章时发布 "访问文章" ...
- 4.JAVA之GUI编程事件监听机制
事件监听机制的特点: 1.事件源 2.事件 3.监听器 4.事件处理 事件源:就是awt包或者swing包中的那些图形用户界面组件.(如:按钮) 事件:每一个事件源都有自己特点有的对应事件和共性事件. ...
- .NET事件监听机制的局限与扩展
.NET中把“事件”看作一个基本的编程概念,并提供了非常优美的语法支持,对比如下C#和Java代码可以看出两种语言设计思想之间的差异. // C#someButton.Click += OnSomeB ...
- 关于事件监听机制的总结(Listener和Adapter)
记得以前看过事件监听机制背后也是有一种设计模式的.(设计模式的名字记不清了,只记得背后实现的数据结构是数组.) 附上事件监听机制的分析图: 一个事件源可以承载多个事件(只要这个事件源支持这个事件就可以 ...
随机推荐
- FL Studio中的音频剪辑功能讲解
音频剪辑,是FL Studio中的一个特色功能,音频剪辑的目的是保持在播放列表中显示和触发的音频,可以根据需要对它们进行切片和排列.但需要注意的是音频剪辑这个功能在FL Studio的基础版(果味版) ...
- leetcode 1046
class Solution { public int lastStoneWeight(int[] stones) { MaxHeap s=new MaxHeap(stone ...
- Meetings S 题解
题目描述 题目链接 有两个牛棚位于一维数轴上的点 \(0\) 和 \(L\) 处.同时有 \(N\) 头奶牛位于数轴上不同的位置(将牛棚和奶牛看作点).每头奶牛 \(i\) 初始时位于某个位置 \(x ...
- 牛客练习赛71 数学考试 题解(dp)
题目链接 题目大意 要你求出有多少个长度为n的排列满足m个限制条件 第i个限制条件 p[i]表示前 p[i]个数不能是1-p[i]的排列 题目思路 这个感觉是dp但是不知道怎么dp 首先就是要明白如果 ...
- CSRF&SSRF-初探准备
了解CSRF之前的必备知识 1.同源策略 同源策略-三个相同:协议.域名.端口 举例说明: 源URL为:http://www.example.com/dir/page.html 协议为:http 域名 ...
- PADS经验总结
PADS经验总结 1. 快捷键z+数字,能够快速查看相应层:直接z,会显示所有层: 2. 快捷键l+数字,在走线时能够快速切换层: 3. setup->design Rules能设置线宽,DRC ...
- oracle set oracle_sid=xxxxxx
本地有多个实例,在cmd 输入 set oracle_sid=xxxxx 来指定要连接的实例 sqlplus xxxx/xxxx@1.1.1.1.1/sid 连接数据库
- 【VSA】One-shot video-based person re-identification with variance subsampling algorithm
目录 解决了什么问题 主要贡献和创新点 基本框架 提出的方法 01 variance confidence方差置信度 02 Variance Subsampling Algorithm 方差二次采样算 ...
- Mysql主从同步机制
1.1 主从同步介绍和优点 *在多台数据服务器中,分为主服务器和从服务器.一台主服务器对应多台从服务器. *主服务器只负责写入数据,从服务器只负责同步主服务器的数据,并让外部程序读取数据 *主服务器写 ...
- day8(使用celery异步发送短信)
1.1在celery_task/mian.py中添加发送短信函数 # celery项目中的所有导包地址, 都是以CELERY_BASE_DIR为基准设定. # 执行celery命令时, 也需要进入CE ...