mirror of
https://github.com/alibaba/canal.git
synced 2026-11-04 00:30:15 +08:00
Updated DevGuide (markdown)
Li Qiang
61
DevGuide.md
61
DevGuide.md
@@ -5,11 +5,11 @@
|
|||||||
## 产品设计
|
## 产品设计
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
|
||||||
- server 代表一个 canal 运行实例，对应于一个 jvm
|
|
||||||
- instance 对应于一个数据队列 （1个 canal server 对应 1..n 个 instance )
|
|
||||||
|
|
||||||
- instance下的子模块
|
- server 代表一个 canal 运行实例，对应于一个 jvm
|
||||||
|
- instance 对应于一个数据队列 （1个 canal server 对应 1..n 个 instance )
|
||||||
|
|
||||||
|
- instance 下的子模块
|
||||||
- eventParser: 数据源接入，模拟 slave 协议和 master 进行交互，协议解析
|
- eventParser: 数据源接入，模拟 slave 协议和 master 进行交互，协议解析
|
||||||
- eventSink: Parser 和 Store 链接器，进行数据过滤，加工，分发的工作
|
- eventSink: Parser 和 Store 链接器，进行数据过滤，加工，分发的工作
|
||||||
- eventStore: 数据存储
|
- eventStore: 数据存储
|
||||||
@@ -18,10 +18,10 @@
|
|||||||
### 整体类图设计
|
### 整体类图设计
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
|
||||||
- CanalLifeCycle: 所有 canal 模块的生命周期接口
|
- CanalLifeCycle: 所有 canal 模块的生命周期接口
|
||||||
- CanalInstance: 组合 parser,sink,store 三个子模块，三个子模块的生命周期统一受 CanalInstance 管理
|
- CanalInstance: 组合 parser,sink,store 三个子模块，三个子模块的生命周期统一受 CanalInstance 管理
|
||||||
- CanalServer: 聚合了多个 CanalInstance
|
- CanalServer: 聚合了多个 CanalInstance
|
||||||
|
|
||||||
#### EventParser 设计
|
#### EventParser 设计
|
||||||
|
|
||||||
@@ -31,50 +31,46 @@
|
|||||||
- CanalLogPositionManager : 记录binlog 最后一次解析成功位置信息，主要是描述下一次canal启动的位点
|
- CanalLogPositionManager : 记录binlog 最后一次解析成功位置信息，主要是描述下一次canal启动的位点
|
||||||
- CanalHAController: 控制 EventParser 的链接主机管理，判断当前该链接哪个mysql数据库
|
- CanalHAController: 控制 EventParser 的链接主机管理，判断当前该链接哪个mysql数据库
|
||||||
|
|
||||||
- Tips
|
- 目前开源版本只支持 MySQL binlog , 默认通过 MySQL binlog dump 远程获取 binlog ,但也可以使用 LocalBinlog - 类 relay log 模式，直接消费本地文件中的 binlog
|
||||||
- 目前开源版本只支持 MySQL binlog , 默认通过 MySQL binlog dump 远程获取 binlog ,但也可以使用 LocalBinlog - 类似 relay log 模式，直接消费本地文件中的 binlog
|
|
||||||
|
#### CanalLogPositionManager 设计
|
||||||
|
|
||||||
#### CanalLogPositionManager 设计
|
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
- 如果 CanalEventStore 选择的是内存模式，可不保留解析位置，下一次 canal 启动时直接依赖 CanalMetaManager 记录的最后一次消费成功的位点即可. (最后一次ack提交的数据位点)
|
||||||
- 如果 CanalEventStore 选择的是内存模式，可不保留解析位置，下一次 canal 启动时直接依赖 CanalMetaManager 记录的最后一次消费成功的位点即可. (最后一次ack提交的数据位点)
|
- 如果 CanalEventStore 选择的是持久化模式，可通过 zookeeper 记录位点信息，canal instance 发生 failover 切换到另一台机器，可通过读取 zookeeper 获取位点信息
|
||||||
- 如果 CanalEventStore 选择的是持久化模式，可通过 zookeeper 记录位点信息，canal instance 发生 failover 切换到另一台机器，可通过读取 zookeeper 获取位点信息
|
- 可通过实现自己的 CanalLogPositionManager，比如记录位点信息到本地文件/nas 文件实现简单可用的无 HA 模式
|
||||||
- 可通过实现自己的 CanalLogPositionManager，比如记录位点信息到本地文件/nas 文件实现简单可用的无 HA 模式
|
|
||||||
|
|
||||||
#### CanalHAController类图设计
|
#### CanalHAController类图设计
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
- 失败检测常见方式可定时发送心跳语句到当前链接的数据库，超过一定次数检测失败时，尝试切换到备机
|
||||||
- 失败检测常见方式可定时发送心跳语句到当前链接的数据库，超过一定次数检测失败时，尝试切换到备机
|
- 如果有一套数据库主备信息管理系统，当数据库主备切换或者机器下线，推送配置到各个应用节点，HAController 收到后，控制 EventParser 进行链接切换
|
||||||
- 阿里内部会有一套数据库主备信息管理系统，DBA 做了数据库主备切换或者机器下线，推送配置到各个应用节点，HAController 收到后，控制 EventParser 进行链接切换
|
|
||||||
|
|
||||||
#### EventSink类图设计和扩展
|
#### EventSink类图设计和扩展
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
- 常见的 sink 业务有 1:n 和 n:1 形式，目前 GroupEventSink 主要是解决 n:1 的归并类业务
|
||||||
- 常见的 sink 业务有 1:n 和 n:1 形式，目前 GroupEventSink 主要是解决 n:1 的归并类业务
|
|
||||||
|
|
||||||
### EventStore类图设计和扩展
|
### EventStore类图设计和扩展
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
- 抽象 CanalStoreScavenge ， 解决数据的清理，比如定时清理，满了之后清理，每次 ack 清理等
|
||||||
- 抽象 CanalStoreScavenge ， 解决数据的清理，比如定时清理，满了之后清理，每次 ack 清理等
|
- CanalEventStore 接口，主要包含 put/get/ack/rollback 的相关接口. put/get 操作会组成一个生产者/消费者模式，每个 store 都会有存储大小设计，存储满了，put 操作会阻塞等待 get 获取数据，所以不会无线占用存储，比如内存大小
|
||||||
- CanalEventStore 接口，主要包含 put/get/ack/rollback 的相关接口. put/get 操作会组成一个生产者/消费者模式，每个 store 都会有存储大小设计，存储满了，put 操作会阻塞等待 get 获取数据，所以不会无线占用存储，比如内存大小
|
- EventStore 目前实现了 memory 模式，支持按照内存大小和内存记录数进行存储大小限制
|
||||||
- EventStore 目前实现了 memory 模式，支持按照内存大小和内存记录数进行存储大小限制
|
- 后续可开发基于本地文件的存储模式
|
||||||
- 后续可开发基于本地文件的存储模式
|
- 基于文件存储和内存存储，开发 mixed 模式，做成两级队列，内存 buffer 有空位时，将文件的数据读入到内存 buffer 中
|
||||||
- 基于文件存储和内存存储，开发 mixed 模式，做成两级队列，内存 buffer 有空位时，将文件的数据读入到内存 buffer 中
|
- mixed 模式实现可以让 canal 落地消费/订阅的模型,取 1 份binlog数据，提供多个客户端消费，消费有快有慢，各自保留消费位点
|
||||||
- mixed 模式实现可以让 canal 落地消费/订阅的模型,取 1 份binlog数据，提供多个客户端消费，消费有快有慢，各自保留消费位点
|
|
||||||
|
|
||||||
#### MetaManager类图设计和扩展
|
#### MetaManager类图设计和扩展
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
- Tips
|
- metaManager 目前支持了多种模式，最顶层 memory 和 zookeeper 模式，然后是 mixed 模式-先写内存，再写zookeeper
|
||||||
- metaManager 目前支持了多种模式，最顶层 memory 和 zookeeper 模式，然后是 mixed 模式-先写内存，再写zookeeper
|
- 可通过实现自己的 CanalMetaManager，比如记录位点信息到本地文件/nas文件，简单可用的无 HA 模式
|
||||||
- 可通过实现自己的 CanalMetaManager，比如记录位点信息到本地文件/nas文件，简单可用的无 HA 模式
|
|
||||||
|
|
||||||
## 应用扩展
|
## 应用扩展
|
||||||
|
|
||||||
@@ -126,9 +122,8 @@
|
|||||||
......
|
......
|
||||||
```
|
```
|
||||||
|
|
||||||
- Tips
|
- 一份 instance.xml 中有一份或者多份 instance 定义，优先以 destination 名字查找对应的 instance bean 定义，如果没有，则按默认的名字 “instance” 查找 instance 对象,例如 `xxxx-instance.xml` 中定义 id 分别为 `instance-1`, `instance-2` 的两个 bean. 这两个 bean 将为同名的 instance 提供自定义的 `eventParser , evnetSink , evnetStore , metaManager，alarmHandler`.如果没有自定义这些 bean, 就使用 id="instance" 的 bean 来配置 canal instance.
|
||||||
- 一份 instance.xml 中有一份或者多份 instance 定义，优先以 destination 名字查找对应的 instance bean 定义，如果没有，则按默认的名字 “instance” 查找 instance 对象,例如 `xxxx-instance.xml` 中定义 id 分别为 `instance-1`, `instance-2` 的两个 bean. 这两个 bean 将为同名的 instance 提供自定义的 `eventParser , evnetSink , evnetStore , metaManager，alarmHandler`.如果没有自定义这些 bean, 就使用 id="instance" 的 bean 来配置 canal instance.
|
- 一份 instance bean 定义，需要包含 eventParser , evnetSink , evnetStore , metaManager，alarmHandler 的5个模块定义，( alarmHandler 主要是一些报警机制处理，因为简单没展开，可扩展)
|
||||||
- 一份 instance bean 定义，需要包含 eventParser , evnetSink , evnetStore , metaManager，alarmHandler 的5个模块定义，( alarmHandler 主要是一些报警机制处理，因为简单没展开，可扩展)
|
|
||||||
|
|
||||||
```xml
|
```xml
|
||||||
<bean id="instance-1" class="com.alibaba.otter.canal.instance.spring.CanalInstanceWithSpring">
|
<bean id="instance-1" class="com.alibaba.otter.canal.instance.spring.CanalInstanceWithSpring">
|
||||||
|
|||||||
Reference in New Issue
Block a user