事件驱动
前情提要
上文中分别使用了依赖注入和观察者模式实现需求：用户注册成功，初始化用户信息。
观察者模式.png
依赖注入.png
上述两种实现存在同一个问题，当注册完成需要好友服务初始化好友列表，两者都需要修改自身代码，使用依赖注入的方法需要注入新的依赖，且需要修改调用代码(register)，观察者模式实现需要修改代码获取新的观察者，并让新观察者注册进入主题中，耦合程度高，且两者都违背了开闭原则进行编码，那么是否可以在不修改代码的前提下进行上述需求开发(不使用MQ)。
观察者模式实现的不足
1.在调用前显式的获取观察者实例
2.在调用前显式的注册进入主题
出现这个问题的原因是主题调用通知接口前必须要明确知道该通知哪些对象，获取实例和注册的目的是为了让主题和观察者进行绑定（主题组合了观察者的集合）。
public void register(){
RegisteSub concurrentSubject = new RegisteSub();
// ObserverInterface pointsObserver = new PointsObserver();
// UserObserver userObserver = new UserObserver();
// concurrentSubject.addListener(pointsObserver);
// concurrentSubject.addListener(userObserver);
RegisterService registerService = new RegisterService();
boolean success = registerService.registerByTel();
if(success){
concurrentSubject.notifyObserver();
}
}
此时的模型
订阅发布模型1.png
concurrentSubject.notifyObserver();
事件驱动是如何做到解耦的
事件驱动的逻辑.png
1.事件发布器不执行通知监听器逻辑，只聚合事件广播器，和对外提供一个发布事件方法。(可复用)
2.事件广播器负责向监听器广播事件，事件广播器需要获取对应事件的监听器。（可复用）
3.事件，解耦的关键，监听器和事件进行绑定，不是和事件发布器，事件广播器进行绑定。
4.监听器，类似观察者，监听器和事件进行绑定。
理清了上述概念，就会有以下疑问：
核中核：监听器是如何与事件绑定的？事件广播器是如何获取到xx事件的监听器？
A：在监听器上使用注解，指定监听器监听的事件，完成事件和监听器的绑定，广播器根据事件获得事件的监听器完成广播行为。
事件驱动的实现逻辑2.png
事件驱动代码实现指南.png
具体代码
以下代码都可以在我的git仓库找到 https://gitee.com/hxh953/copy-spring-event-driven
public interface ApplicationEvent {
}
public interface ApplicationListener {
void onApplicationEvent(ApplicationEvent event);
}
public interface ApplicationEventPublisher {
void publishEvent(ApplicationEvent event);
}
public class registeFailEvent implements ApplicationEvent{
}
public class registeSuccessEvent implements ApplicationEvent{
public registeSuccessEvent(){
System.out.println("注册成功");
}
}
@Target({ ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
public @interface WhichToListen {
Class[] value();
}
@WhichToListen(value = {registeSuccessEvent.class,registeFailEvent.class})
public class UserListener implements ApplicationListener{
@Override
public void onApplicationEvent(ApplicationEvent event) {
if(event instanceof registeSuccessEvent){
System.out.println("用户系统:初始化用户信息");
}
if(event instanceof registeFailEvent){
System.out.println("啥也不做，测试是不是可以监听两个事件");
}
}
}
@WhichToListen(value = registeSuccessEvent.class)
public class PointsListener implements ApplicationListener{
@Override
public void onApplicationEvent(ApplicationEvent event) {
if(event instanceof registeSuccessEvent){
System.out.println("积分系统:初始化积分");
}
}
}
public class ApplicationMulticaster {
List<ApplicationListener> listeners ;
boolean addListener(ApplicationListener listener){
if(listeners == null){
listeners = new ArrayList<>();
}
return listeners.add(listener);
}
boolean removeListener(ApplicationListener listener){
if(listeners == null){
return false;
}
return listeners.remove(listener);
}
/**
* 向所有监听本事件的监听器器广播
* @param event
*/
public void multicastEvent(ApplicationEvent event){
List<ApplicationListener> listeners = getApplicationListeners(event);
listeners.forEach(item -> item.onApplicationEvent(event));
}
//获取监听了该事件的监听器集合
List<ApplicationListener> getApplicationListeners(ApplicationEvent event){
if (listeners == null){
this.listeners = ClassUtil.getListenersByEvent(event);
}
return listeners;
}
}
public class ClassUtil {
/**
* 获得实现ApplicationListener接口，且被WitchToListen注解，注解value值包含xx的所有监听类
*/
public static List<ApplicationListener> getListenersByEvent(ApplicationEvent e) {
List<ApplicationListener> listeners = null;
Class c = ApplicationListener.class;
if (c.isInterface()) {
// 获取当前的包名
String packageName = c.getPackage().getName();
// 获取当前包下以及子包下所以的类
List<Class<?>> allClass = getClasses(packageName);
if (allClass != null) {
listeners = new ArrayList<ApplicationListener>();
for (Class classes : allClass) {
// 判断是否是同一个接口
if (c.isAssignableFrom(classes)) {
// 本身不加入进去
if (!c.equals(classes)) {
//classes.getDeclaredAnnotation(WhichToListen.class)
WhichToListen an = (WhichToListen) classes.getAnnotation(WhichToListen.class);
// Annotation a = classes.getAnnotation(WhichToListen.class);
Class[] listenClasses = an.value();
for (Class ac : listenClasses) {
if(ac.getName().equals(e.getClass().getName())){
try {
Object o = classes.getDeclaredConstructor().newInstance();
listeners.add((ApplicationListener) o);
} catch (Exception ex) {
ex.printStackTrace();
}
}
}
}
}
}
}
}
return listeners;
}
/*
* 取得某一类所在包的所有类名 不含迭代
*/
public static String[] getPackageAllClassName(String classLocation, String packageName) {
// 将packageName分解
String[] packagePathSplit = packageName.split("[.]");
String realClassLocation = classLocation;
int packageLength = packagePathSplit.length;
for (int i = 0; i < packageLength; i++) {
realClassLocation = realClassLocation + File.separator + packagePathSplit[i];
}
File packeageDir = new File(realClassLocation);
if (packeageDir.isDirectory()) {
String[] allClassName = packeageDir.list();
return allClassName;
}
return null;
}
/**
* 从包package中获取所有的Class
*
* @param
* @return
*/
public static List<Class<?>> getClasses(String packageName) {
// 第一个class类的集合
List<Class<?>> classes = new ArrayList<Class<?>>();
// 是否循环迭代
boolean recursive = true;
// 获取包的名字 并进行替换
String packageDirName = packageName.replace('.', '/');
// 定义一个枚举的集合 并进行循环来处理这个目录下的things
Enumeration<URL> dirs;
try {
dirs = Thread.currentThread().getContextClassLoader().getResources(packageDirName);
// 循环迭代下去
while (dirs.hasMoreElements()) {
// 获取下一个元素
URL url = dirs.nextElement();
// 得到协议的名称
String protocol = url.getProtocol();
// 如果是以文件的形式保存在服务器上
if ("file".equals(protocol)) {
// 获取包的物理路径
String filePath = URLDecoder.decode(url.getFile(), "UTF-8");
// 以文件的方式扫描整个包下的文件 并添加到集合中
findAndAddClassesInPackageByFile(packageName, filePath, recursive, classes);
} else if ("jar".equals(protocol)) {
// 如果是jar包文件
// 定义一个JarFile
JarFile jar;
try {
// 获取jar
jar = ((JarURLConnection) url.openConnection()).getJarFile();
// 从此jar包 得到一个枚举类
Enumeration<JarEntry> entries = jar.entries();
// 同样的进行循环迭代
while (entries.hasMoreElements()) {
// 获取jar里的一个实体 可以是目录 和一些jar包里的其他文件 如META-INF等文件
JarEntry entry = entries.nextElement();
String name = entry.getName();
// 如果是以/开头的
if (name.charAt(0) == '/') {
// 获取后面的字符串
name = name.substring(1);
}
// 如果前半部分和定义的包名相同
if (name.startsWith(packageDirName)) {
int idx = name.lastIndexOf('/');
// 如果以"/"结尾 是一个包
if (idx != -1) {
// 获取包名 把"/"替换成"."
packageName = name.substring(0, idx).replace('/', '.');
}
// 如果可以迭代下去 并且是一个包
if ((idx != -1) || recursive) {
// 如果是一个.class文件 而且不是目录
if (name.endsWith(".class") && !entry.isDirectory()) {
// 去掉后面的".class" 获取真正的类名
String className = name.substring(packageName.length() + 1, name.length() - 6);
try {
// 添加到classes
classes.add(Class.forName(packageName + '.' + className));
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
}
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
} catch (IOException e) {
e.printStackTrace();
}
return classes;
}
/**
* 以文件的形式来获取包下的所有Class
*
* @param packageName
* @param packagePath
* @param recursive
* @param classes
*/
public static void findAndAddClassesInPackageByFile(String packageName, String packagePath, final boolean recursive,
List<Class<?>> classes) {
// 获取此包的目录 建立一个File
File dir = new File(packagePath);
// 如果不存在或者 也不是目录就直接返回
if (!dir.exists() || !dir.isDirectory()) {
return;
}
// 如果存在 就获取包下的所有文件 包括目录
File[] dirfiles = dir.listFiles(new FileFilter() {
// 自定义过滤规则 如果可以循环(包含子目录) 或则是以.class结尾的文件(编译好的java类文件)
public boolean accept(File file) {
return (recursive && file.isDirectory()) || (file.getName().endsWith(".class"));
}
});
// 循环所有文件
for (File file : dirfiles) {
// 如果是目录 则继续扫描
if (file.isDirectory()) {
findAndAddClassesInPackageByFile(packageName + "." + file.getName(), file.getAbsolutePath(), recursive,
classes);
} else {
// 如果是java类文件 去掉后面的.class 只留下类名
String className = file.getName().substring(0, file.getName().length() - 6);
try {
// 添加到集合中去
classes.add(Class.forName(packageName + '.' + className));
} catch (ClassNotFoundException e) {
e.printStackTrace();
}
}
}
}
}
public class Test {
public static void main(String[] args) {
ApplicationEvent successEvent = new registeSuccessEvent();
ApplicationEventPublisher applicationPublisher = new ApplicationPublisher();
applicationPublisher.publishEvent(successEvent);
}
}
上面是我的事件驱动实现，无须修改代码，增加代码就可以实现开头的需求。
spring中提供了事件驱动的实现，且可以指定广播器向监听器广播的顺序，建议阅读源码，毕竟比我的丰富很多。
