MySQL增量订阅和消费组件-Canal
2021-08-19 17:54:36 
阿炯
Canal 是阿里巴巴对 MySQL 数据库 Binlog 的增量订阅与消费组件，采用Java开发并在ApacheV2协议下授权。
名称：canal [k 'næl]
译意：水道/管道/沟渠
语言：纯java开发
定位：基于数据库增量日志解析，提供增量数据订阅&消费，目前主要支持了MySQL
背景：早期的阿里巴巴 B2B 公司因为存在杭州和美国双机房部署，存在跨机房同步的业务需求。不过早期的数据库同步业务，主要是基于 trigger 的方式获取增量变更，不过从 2010 年开始，阿里系公司开始逐步的尝试基于数据库的日志解析，获取增量变更进行同步，由此衍生出了增量订阅&消费的业务，从此开启了一段新纪元。目前内部使用的同步，已经支持 MySQL 5.x、8.x 和 Oracle 部分版本的日志解析。
基于日志增量订阅&消费支持的业务：
数据库镜像
数据库实时备份
索引构建和实时维护(拆分异构索引、倒排索引等)
业务 Cache 刷新
带业务逻辑的增量数据处理
预备知识
Canal最核心的运行机制就是依赖于MySQL的主备复制，这里简要说明下MySQL主备复制原理。MySQL Master 将数据变更写入二进制日志(binary log, 其中记录叫做二进制日志事件binary log events，可以通过 show binlog events 进行查看)。
MySQL Slave 将 master 的 binary log events 拷贝到它的中继日志(relay log)。
MySQL Slave 重放 relay log 中事件，将数据变更反映它自己的数据。
MySQL-Binlog是 MySQL 数据库的二进制日志，用于记录用户对数据库操作的SQL语句(除了数据查询语句)信息。如果后续需要配置主从数据库，当需要从数据库同步主数据库的内容，就可以通过 Binlog来进行同步。
Canal 工作原理：
原理相对比较简单：
Canal 模拟MySQL slave的交互协议，伪装自己为MySQL slave，向MySQL master发送dump协议。
MySQL master收到dump请求，开始推送binary log给slave(也就是Canal)。
Canal 解析 binary log 对象(原始为byte流)。
Canal 把解析后的 binary log 以特定格式的进行推送，供下游消费。
架构
说明：
server代表一个canal运行实例，对应于一个jvm
instance对应于一个数据队列 (1个server对应1..n个instance)
instance模块：
eventParser (数据源接入，模拟slave协议和master进行交互，协议解析)
eventSink (Parser和Store链接器，进行数据过滤，加工，分发的工作)
eventStore (数据存储)
metaManager (增量订阅&消费信息管理器)
Canal内部封装了 Binlog对象格式，Canal能够同步 DCL、 DML、 DDL，业务通常关心 INSERT、 UPDATE、 DELETE引起的数据变更。
EventParser设计
大致过程：
整个parser过程大致可分为几步：
Connection获取上一次解析成功的位置 (如果第一次启动，则获取初始指定的位置或者是当前数据库的binlog位点)
Connection建立链接，发送BINLOG_DUMP指令
// 0. write command number
// 1. write 4 bytes bin-log position to start at
// 2. write 2 bytes bin-log flags
// 3. write 4 bytes server id of the slave
// 4. write bin-log file name
Mysql开始推送Binaly Log
接收到的Binaly Log的通过Binlog parser进行协议解析，补充一些特定信息
// 补充字段名字，字段类型，主键信息，unsigned类型处理
传递给EventSink模块进行数据存储，是一个阻塞操作，直到存储成功
存储成功后，定时记录Binaly Log位置
EventSink设计
说明：
数据过滤：支持通配符的过滤模式，表名，字段内容等
数据路由/分发：解决1:n (1个parser对应多个store的模式)
数据归并：解决n:1 (多个parser对应1个store)
数据加工：在进入store之前进行额外的处理，比如join
数据1:n业务
为了合理的利用数据库资源，一般常见的业务都是按照schema进行隔离，然后在mysql上层或者dao这一层面上，进行一个数据源路由，屏蔽数据库物理位置对开发的影响，阿里系主要是通过cobar/tddl来解决数据源路由问题。所以，一般一个数据库实例上，会部署多个schema，每个schema会有由1个或者多个业务方关注。
数据n:1业务
同样，当一个业务的数据规模达到一定的量级后，必然会涉及到水平拆分和垂直拆分的问题，针对这些拆分的数据需要处理时，就需要链接多个store进行处理，消费的位点就会变成多份，而且数据消费的进度无法得到尽可能有序的保证。所以，在一定业务场景下，需要将拆分后的增量数据进行归并处理，比如按照时间戳/全局id进行排序归并。
EventStore设计
1. 目前仅实现了Memory内存模式，后续计划增加本地file存储，mixed混合模式
2. 借鉴了Disruptor的RingBuffer的实现思路
RingBuffer设计：
定义了3个cursor
Put : Sink模块进行数据存储的最后一次写入位置
Get : 数据订阅获取的最后一次提取位置
Ack : 数据消费成功的最后一次消费位置
借鉴Disruptor的RingBuffer的实现，将RingBuffer拉直来看：
实现说明：
Put/Get/Ack cursor用于递增，采用long型存储
buffer的get操作，通过取余或者与操作。(与操作： cusor & (size - 1) , size需要为2的指数，效率比较高)
Instance设计
instance代表了一个实际运行的数据队列，包括了EventPaser,EventSink,EventStore等组件。抽象了CanalInstanceGenerator，主要是考虑配置的管理方式：
manager方式： 和你自己的内部web console/manager系统进行对接。(目前主要是公司内部使用)
spring方式：基于spring xml + properties进行定义，构建spring配置.
Server设计
server代表了一个canal的运行实例，为了方便组件化使用，特意抽象了Embeded(嵌入式) / Netty(网络访问)的两种实现。
Embeded : 对latency和可用性都有比较高的要求，自己又能hold住分布式的相关技术(比如failover)
Netty : 基于netty封装了一层网络协议，由canal server保证其可用性，采用的pull模型，当然latency会稍微打点折扣，不过这个也视情况而定(阿里系的notify和metaq，典型的push/pull模型，目前也逐步的在向pull模型靠拢，push在数据量大的时候会有一些问题)。
HA 机制
线上服务的稳定性极为重要，Canal是支持HA的，其实现机制也是依赖Zookeeper来实现的，与HDFS的HA类似。Canal的HA分为两部分，Canal server和Canal client分别有对应的HA实现。
Canal Server：为了减少对mysql dump的请求，不同server上的instance要求同一时间只能有一个处于running，其他的处于standby状态。
Canal Client：为了保证有序性，一份instance同一时间只能由一个canal client进行get/ack/rollback操作，否则客户端接收无法保证有序。
依赖Zookeeper的特性：
Watcher机制
EPHEMERAL节点(和session生命周期绑定)
大致步骤：
Canal server要启动某个canal instance时都先向zookeeper进行一次尝试启动判断 (实现：创建EPHEMERAL节点，谁创建成功就允许谁启动)。
创建 ZooKeeper节点成功后，对应的Canal server就启动对应的Canal instance，没有创建成功的Canal instance就会处于standby状态。
一旦ZooKeeper发现Canal server A创建的节点消失后，立即通知其他的Canal server再次进行步骤1的操作，重新选出一个Canal server启动instance。
Canal client每次进行connect时，会首先向ZooKeeper询问当前是谁启动了Canal instance，然后和其建立链接，一旦链接不可用，会重新尝试connect。
使用场景
上面介绍了Canal 的原理与运行机制，下面我们从实际场景来看，Canal 能够为我们业务场景解决什么样的问题。
1、不停服迁移
业务在发展初期，为了快速支撑业务发展，很多数据存储设计较为粗放，比如用户表、订单表可能都会设计为单表，此时常规手段会采用分库分表来解决容量和性能问题。但数据迁移会面临最大的问题：线上业务需要正常运行，如果数据在迁移过程中有变更，如何保证数据一致性是最大的挑战。基于Canal，通过订阅数据库的 Binlog，可以很好地解决这一问题。
2、缓存刷新
互联网业务数据源不仅仅为数据库，比如 Redis 在互联网业务较为常用，在数据变更时需要刷新缓存，常规手段是在业务逻辑代码中手动刷新。基于Canal，通过订阅指定表数据的Binlog，可以异步解耦刷新缓存。
3、任务下发
另一种常见应用场景是“下发任务”，当数据变更时需要通知其他依赖系统。其原理是任务系统监听数据库变更，然后将变更的数据写入MQ/Kafka进行任务下发。比如帐号注销时下游业务方需要订单此通知，为用户删除业务数据，或者做数据归档等。
基于Canal可以保证数据下发的精确性，同时业务系统中不会散落着各种下发MQ的代码，从而实现了下发归集，如下图所示：
4、数据异构
在大型网站架构中，数据库都会采用分库分表来解决容量和性能问题，但分库分表之后带来的新问题。比如不同维度的查询或者聚合查询，此时就会非常棘手。一般我们会通过数据异构机制来解决此问题。
所谓的数据异构，那就是将需要join查询的多表按照某一个维度又聚合在一个DB中。基于Canal可以实现数据异构，如下图示意：
数据格式
数据序列化
Canal底层使用protobuf作为数据数据列化的方式，Canal-client在订阅到变更数据时，为null的数据会自动转换为空字符串，在ORM侧数据更新时，因判断逻辑不一致，导致最终表中数据更新为空字符串。
数据对象格式：EntryProtocol.proto
Entry
Header
logfileName [binlog文件名]
logfileOffset [binlog position]
executeTime [binlog里记录变更发生的时间戳]
schemaName [数据库实例]
tableName [表名]
eventType [insert/update/delete类型]
entryType [事务头BEGIN/事务尾END/数据ROWDATA]
storeValue [byte数据,可展开，对应的类型为RowChange]
RowChange
isDdl [是否是ddl变更操作，比如create table/drop table]
sql [具体的ddl sql]
rowDatas [具体insert/update/delete的变更数据，可为多条，1个binlog event事件可对应多条变更，比如批处理]
beforeColumns [Column类型的数组]
afterColumns [Column类型的数组]
Column
index [column序号]
sqlType [jdbc type]
name [column name]
isKey [是否为主键]
updated [是否发生过变更]
isNull [值是否为null]
value [具体的内容，注意为文本]
说明：
可以提供数据库变更前和变更后的字段内容，针对binlog中没有的name,isKey等信息进行补全
可以提供ddl的变更语句
最新版本：1.1
项目主页：
https://github.com/alibaba/canal
https://github.com/alibaba/otter
名称：canal [k 'næl]
译意：水道/管道/沟渠
语言：纯java开发
定位：基于数据库增量日志解析，提供增量数据订阅&消费，目前主要支持了MySQL
背景：早期的阿里巴巴 B2B 公司因为存在杭州和美国双机房部署，存在跨机房同步的业务需求。不过早期的数据库同步业务，主要是基于 trigger 的方式获取增量变更，不过从 2010 年开始，阿里系公司开始逐步的尝试基于数据库的日志解析，获取增量变更进行同步，由此衍生出了增量订阅&消费的业务，从此开启了一段新纪元。目前内部使用的同步，已经支持 MySQL 5.x、8.x 和 Oracle 部分版本的日志解析。
基于日志增量订阅&消费支持的业务：
数据库镜像
数据库实时备份
索引构建和实时维护(拆分异构索引、倒排索引等)
业务 Cache 刷新
带业务逻辑的增量数据处理
预备知识
Canal最核心的运行机制就是依赖于MySQL的主备复制，这里简要说明下MySQL主备复制原理。MySQL Master 将数据变更写入二进制日志(binary log, 其中记录叫做二进制日志事件binary log events，可以通过 show binlog events 进行查看)。
MySQL Slave 将 master 的 binary log events 拷贝到它的中继日志(relay log)。
MySQL Slave 重放 relay log 中事件，将数据变更反映它自己的数据。
MySQL-Binlog是 MySQL 数据库的二进制日志，用于记录用户对数据库操作的SQL语句(除了数据查询语句)信息。如果后续需要配置主从数据库，当需要从数据库同步主数据库的内容，就可以通过 Binlog来进行同步。
Canal 工作原理：
原理相对比较简单：
Canal 模拟MySQL slave的交互协议，伪装自己为MySQL slave，向MySQL master发送dump协议。
MySQL master收到dump请求，开始推送binary log给slave(也就是Canal)。
Canal 解析 binary log 对象(原始为byte流)。
Canal 把解析后的 binary log 以特定格式的进行推送，供下游消费。
架构
说明：
server代表一个canal运行实例，对应于一个jvm
instance对应于一个数据队列 (1个server对应1..n个instance)
instance模块：
eventParser (数据源接入，模拟slave协议和master进行交互，协议解析)
eventSink (Parser和Store链接器，进行数据过滤，加工，分发的工作)
eventStore (数据存储)
metaManager (增量订阅&消费信息管理器)
Canal内部封装了 Binlog对象格式，Canal能够同步 DCL、 DML、 DDL，业务通常关心 INSERT、 UPDATE、 DELETE引起的数据变更。
EventParser设计
大致过程：
整个parser过程大致可分为几步：
Connection获取上一次解析成功的位置 (如果第一次启动，则获取初始指定的位置或者是当前数据库的binlog位点)
Connection建立链接，发送BINLOG_DUMP指令
// 0. write command number
// 1. write 4 bytes bin-log position to start at
// 2. write 2 bytes bin-log flags
// 3. write 4 bytes server id of the slave
// 4. write bin-log file name
Mysql开始推送Binaly Log
接收到的Binaly Log的通过Binlog parser进行协议解析，补充一些特定信息
// 补充字段名字，字段类型，主键信息，unsigned类型处理
传递给EventSink模块进行数据存储，是一个阻塞操作，直到存储成功
存储成功后，定时记录Binaly Log位置
EventSink设计
说明：
数据过滤：支持通配符的过滤模式，表名，字段内容等
数据路由/分发：解决1:n (1个parser对应多个store的模式)
数据归并：解决n:1 (多个parser对应1个store)
数据加工：在进入store之前进行额外的处理，比如join
数据1:n业务
为了合理的利用数据库资源，一般常见的业务都是按照schema进行隔离，然后在mysql上层或者dao这一层面上，进行一个数据源路由，屏蔽数据库物理位置对开发的影响，阿里系主要是通过cobar/tddl来解决数据源路由问题。所以，一般一个数据库实例上，会部署多个schema，每个schema会有由1个或者多个业务方关注。
数据n:1业务
同样，当一个业务的数据规模达到一定的量级后，必然会涉及到水平拆分和垂直拆分的问题，针对这些拆分的数据需要处理时，就需要链接多个store进行处理，消费的位点就会变成多份，而且数据消费的进度无法得到尽可能有序的保证。所以，在一定业务场景下，需要将拆分后的增量数据进行归并处理，比如按照时间戳/全局id进行排序归并。
EventStore设计
1. 目前仅实现了Memory内存模式，后续计划增加本地file存储，mixed混合模式
2. 借鉴了Disruptor的RingBuffer的实现思路
RingBuffer设计：
定义了3个cursor
Put : Sink模块进行数据存储的最后一次写入位置
Get : 数据订阅获取的最后一次提取位置
Ack : 数据消费成功的最后一次消费位置
借鉴Disruptor的RingBuffer的实现，将RingBuffer拉直来看：
实现说明：
Put/Get/Ack cursor用于递增，采用long型存储
buffer的get操作，通过取余或者与操作。(与操作： cusor & (size - 1) , size需要为2的指数，效率比较高)
Instance设计
instance代表了一个实际运行的数据队列，包括了EventPaser,EventSink,EventStore等组件。抽象了CanalInstanceGenerator，主要是考虑配置的管理方式：
manager方式： 和你自己的内部web console/manager系统进行对接。(目前主要是公司内部使用)
spring方式：基于spring xml + properties进行定义，构建spring配置.
Server设计
server代表了一个canal的运行实例，为了方便组件化使用，特意抽象了Embeded(嵌入式) / Netty(网络访问)的两种实现。
Embeded : 对latency和可用性都有比较高的要求，自己又能hold住分布式的相关技术(比如failover)
Netty : 基于netty封装了一层网络协议，由canal server保证其可用性，采用的pull模型，当然latency会稍微打点折扣，不过这个也视情况而定(阿里系的notify和metaq，典型的push/pull模型，目前也逐步的在向pull模型靠拢，push在数据量大的时候会有一些问题)。
HA 机制
线上服务的稳定性极为重要，Canal是支持HA的，其实现机制也是依赖Zookeeper来实现的，与HDFS的HA类似。Canal的HA分为两部分，Canal server和Canal client分别有对应的HA实现。
Canal Server：为了减少对mysql dump的请求，不同server上的instance要求同一时间只能有一个处于running，其他的处于standby状态。
Canal Client：为了保证有序性，一份instance同一时间只能由一个canal client进行get/ack/rollback操作，否则客户端接收无法保证有序。
依赖Zookeeper的特性：
Watcher机制
EPHEMERAL节点(和session生命周期绑定)
大致步骤：
Canal server要启动某个canal instance时都先向zookeeper进行一次尝试启动判断 (实现：创建EPHEMERAL节点，谁创建成功就允许谁启动)。
创建 ZooKeeper节点成功后，对应的Canal server就启动对应的Canal instance，没有创建成功的Canal instance就会处于standby状态。
一旦ZooKeeper发现Canal server A创建的节点消失后，立即通知其他的Canal server再次进行步骤1的操作，重新选出一个Canal server启动instance。
Canal client每次进行connect时，会首先向ZooKeeper询问当前是谁启动了Canal instance，然后和其建立链接，一旦链接不可用，会重新尝试connect。
使用场景
上面介绍了Canal 的原理与运行机制，下面我们从实际场景来看，Canal 能够为我们业务场景解决什么样的问题。
1、不停服迁移
业务在发展初期，为了快速支撑业务发展，很多数据存储设计较为粗放，比如用户表、订单表可能都会设计为单表，此时常规手段会采用分库分表来解决容量和性能问题。但数据迁移会面临最大的问题：线上业务需要正常运行，如果数据在迁移过程中有变更，如何保证数据一致性是最大的挑战。基于Canal，通过订阅数据库的 Binlog，可以很好地解决这一问题。
2、缓存刷新
互联网业务数据源不仅仅为数据库，比如 Redis 在互联网业务较为常用，在数据变更时需要刷新缓存，常规手段是在业务逻辑代码中手动刷新。基于Canal，通过订阅指定表数据的Binlog，可以异步解耦刷新缓存。
3、任务下发
另一种常见应用场景是“下发任务”，当数据变更时需要通知其他依赖系统。其原理是任务系统监听数据库变更，然后将变更的数据写入MQ/Kafka进行任务下发。比如帐号注销时下游业务方需要订单此通知，为用户删除业务数据，或者做数据归档等。
基于Canal可以保证数据下发的精确性，同时业务系统中不会散落着各种下发MQ的代码，从而实现了下发归集，如下图所示：
4、数据异构
在大型网站架构中，数据库都会采用分库分表来解决容量和性能问题，但分库分表之后带来的新问题。比如不同维度的查询或者聚合查询，此时就会非常棘手。一般我们会通过数据异构机制来解决此问题。
所谓的数据异构，那就是将需要join查询的多表按照某一个维度又聚合在一个DB中。基于Canal可以实现数据异构，如下图示意：
数据格式
数据序列化
Canal底层使用protobuf作为数据数据列化的方式，Canal-client在订阅到变更数据时，为null的数据会自动转换为空字符串，在ORM侧数据更新时，因判断逻辑不一致，导致最终表中数据更新为空字符串。
数据对象格式：EntryProtocol.proto
Entry
Header
logfileName [binlog文件名]
logfileOffset [binlog position]
executeTime [binlog里记录变更发生的时间戳]
schemaName [数据库实例]
tableName [表名]
eventType [insert/update/delete类型]
entryType [事务头BEGIN/事务尾END/数据ROWDATA]
storeValue [byte数据,可展开，对应的类型为RowChange]
RowChange
isDdl [是否是ddl变更操作，比如create table/drop table]
sql [具体的ddl sql]
rowDatas [具体insert/update/delete的变更数据，可为多条，1个binlog event事件可对应多条变更，比如批处理]
beforeColumns [Column类型的数组]
afterColumns [Column类型的数组]
Column
index [column序号]
sqlType [jdbc type]
name [column name]
isKey [是否为主键]
updated [是否发生过变更]
isNull [值是否为null]
value [具体的内容，注意为文本]
说明：
可以提供数据库变更前和变更后的字段内容，针对binlog中没有的name,isKey等信息进行补全
可以提供ddl的变更语句
最新版本：1.1
项目主页：
https://github.com/alibaba/canal
https://github.com/alibaba/otter