From 076cc3d5f364178259e5afd6783aee0464f2031e Mon Sep 17 00:00:00 2001 From: godotg Date: Fri, 2 Dec 2022 18:31:19 +0800 Subject: [PATCH] doc[zfoo]: update document --- event/README.md | 40 +++++++++++++++++++++------------------- event/README_CN.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 19 deletions(-) create mode 100644 event/README_CN.md diff --git a/event/README.md b/event/README.md index e3ba26bd..ce6ef44d 100644 --- a/event/README.md +++ b/event/README.md @@ -1,44 +1,46 @@ -### Ⅰ. 简介 +English | [简体中文](./README_CN.md) -- [event](https://github.com/zfoo-project/zfoo/blob/main/event/README.md) 事件总线用来解耦不同模块，提高代码的质量，核心思想是观察者设计模式 +### Ⅰ. Introduction -### Ⅱ. 硬件层面的事件总线 +- [event](https://github.com/zfoo-project/zfoo/blob/main/event/README.md) The event bus is used to decouple different + modules and improve the quality of the code. The core idea is the observer design pattern -#### 1. 设备间的通信，直连的方式 +### Ⅱ. Event bus at the hardware level -CPU所代表的控制器和运算器，要和存储器，也就是我们的主内存，以及输入和输出设备进行通信。 计算机是用什么样的方式来完成，CPU和内存、以及外部输入输出设备的通信呢？ +#### 1. Between devices communication -比如我在键盘上输入一个快捷键，来控制我的音响播放音乐，计算机是用什么样的方式来完成，外部输入输出设备的通信呢？ ![Image text](../doc/image/event/device01.png) ![Image text](../doc/image/event/device02.png) -#### 2. 通过总线降低复杂度 +#### 2. Reduced complexity with the bus ![Image text](../doc/image/event/device03.png) ![Image text](../doc/image/event/device04.png) ![Image text](../doc/image/event/device05.png) -#### 3. 硬件总线的多重架构 +#### 3. Multiple Architectures of Hardware Buses ![Image text](../doc/image/event/device06.png) ![Image text](../doc/image/event/device07.png) -总线的设计思路，核心是为了减少多个模块之间交互的复杂性和耦合度。 +The core of the design idea of the bus is to reduce the complexity and coupling degree of interaction between multiple +modules. -在实际的硬件层面，总线其实就是一组连接电路的线路。因为不同设备之间的速度有差异，所以一台计算机里面往往会有多个总线。 +At the actual hardware level, a bus is actually a set of wires connecting circuits. +Because of the differences in speed between different devices, there are often multiple buses in a computer. -实际上，总线这个设计思路在我们的软件开发过程中也经常会被用到。事件总线就是我们常见的一个设计模式，通常事件总线也会和订阅者发布者模式结合起来，成为大型系统的各个松耦合的模块之间交互的一种主要模式。 +In fact, the design idea of the bus is often used in our software development process. +The event bus is a common design pattern. Usually, the event bus will also be combined with the subscriber-publisher +mode to +become a main mode of interaction between loosely coupled modules of a large-scale system. -### Ⅲ. 软件层面的事件总线 +### Ⅲ. Event bus at software level ![Image text](../doc/image/event/event01.png) ![Image text](../doc/image/event/event02.png) -- 事件总线从设计模式上说叫观察者模式 -- 设计模式没有固定的写法，zfoo event用最简单的注解实现了事件总线 -- zfoo event使用Javassist字节码增强技术动态代理事件接收者，避免了反射，没有性能损耗 - -### Ⅳ. 参考文章 - -- [深入浅出计算机组成原理学习笔记：第四十二讲](https://www.cnblogs.com/luoahong/p/11359768.html) +- The event bus is called the observer mode from the design mode +- There is no fixed way to write the design pattern, zfoo event implements the event bus with the simplest annotation +- zfoo event uses Javassist bytecode enhancement technology to dynamically proxy event receivers, avoiding reflection + and no performance loss \ No newline at end of file diff --git a/event/README_CN.md b/event/README_CN.md new file mode 100644 index 00000000..6452852d --- /dev/null +++ b/event/README_CN.md @@ -0,0 +1,45 @@ +### Ⅰ. 简介 + +- [event](https://github.com/zfoo-project/zfoo/blob/main/event/README.md) 事件总线用来解耦不同模块，提高代码的质量，核心思想是观察者设计模式 + +### Ⅱ. 硬件层面的事件总线 + +#### 1. 设备间的通信，直连的方式 + +CPU所代表的控制器和运算器，要和存储器，也就是我们的主内存，以及输入和输出设备进行通信。 +计算机是用什么样的方式来完成，CPU和内存、以及外部输入输出设备的通信呢？ + +比如我在键盘上输入一个快捷键，来控制我的音响播放音乐，计算机是用什么样的方式来完成，外部输入输出设备的通信呢？ + +![Image text](../doc/image/event/device01.png) +![Image text](../doc/image/event/device02.png) + +#### 2. 通过总线降低复杂度 + +![Image text](../doc/image/event/device03.png) +![Image text](../doc/image/event/device04.png) +![Image text](../doc/image/event/device05.png) + +#### 3. 硬件总线的多重架构 + +![Image text](../doc/image/event/device06.png) +![Image text](../doc/image/event/device07.png) + +总线的设计思路，核心是为了减少多个模块之间交互的复杂性和耦合度。 + +在实际的硬件层面，总线其实就是一组连接电路的线路。因为不同设备之间的速度有差异，所以一台计算机里面往往会有多个总线。 + +实际上，总线这个设计思路在我们的软件开发过程中也经常会被用到。事件总线就是我们常见的一个设计模式，通常事件总线也会和订阅者发布者模式结合起来，成为大型系统的各个松耦合的模块之间交互的一种主要模式。 + +### Ⅲ. 软件层面的事件总线 + +![Image text](../doc/image/event/event01.png) +![Image text](../doc/image/event/event02.png) + +- 事件总线从设计模式上说叫观察者模式 +- 设计模式没有固定的写法，zfoo event用最简单的注解实现了事件总线 +- zfoo event使用Javassist字节码增强技术动态代理事件接收者，避免了反射，没有性能损耗 + +### Ⅳ. 参考文章 + +- [深入浅出计算机组成原理学习笔记：第四十二讲](https://www.cnblogs.com/luoahong/p/11359768.html)