Canal介绍
Canal
1.介绍
canal [kə’næl]，译意为水道/管道/沟渠，主要用途是基于 MySQL 数据库增量日志解析，提供增量数据订阅和消费
早期阿里巴巴因为杭州和美国双机房部署，存在跨机房同步的业务需求，实现方式主要是基于业务 trigger 获取增量变更。从 2010 年开始，业务逐步尝试数据库日志解析获取增量变更进行同步，由此衍生出了大量的数据库增量订阅和消费业务。
基于日志增量订阅和消费的业务包括
- 数据库镜像
- 数据库实时备份
- 索引构建和实时维护(拆分异构索引、倒排索引等)
- 业务 cache 刷新
- 带业务逻辑的增量数据处理
当前的 canal 支持源端 MySQL 版本包括 5.1.x , 5.5.x , 5.6.x , 5.7.x , 8.0.x
2.工作原理
2.1MySQL主备复制原理
- MySQL master 将数据变更写入二进制日志( binary log, 其中记录叫做二进制日志事件binary log events，可以通过 show binlog events 进行查看)
- MySQL slave 将 master 的 binary log events 拷贝到它的中继日志(relay log)
- MySQL slave 重放 relay log 中事件，将数据变更反映它自己的数据
2.2canal 工作原理
- canal 模拟 MySQL slave 的交互协议，伪装自己为 MySQL slave ，向 MySQL master 发送dump 协议
- MySQL master 收到 dump 请求，开始推送 binary log 给 slave (即 canal )
- canal 解析 binary log 对象(原始为 byte 流)
3.准备
-
对于自建 MySQL , 需要先开启 Binlog 写入功能，配置 binlog-format 为 ROW 模式，my.cnf 中配置如下
[mysqld] log-bin=mysql-bin # 开启 binlog binlog-format=ROW # 选择 ROW 模式 server_id=1 # 配置 MySQL replaction 需要定义，不要和 canal 的 slaveId 重复- 注意：针对阿里云 RDS for MySQL , 默认打开了 binlog , 并且账号默认具有 binlog dump 权限 , 不需要任何权限或者 binlog 设置,可以直接跳过这一步
-
授权 canal 链接 MySQL 账号具有作为 MySQL slave 的权限, 如果已有账户可直接 grant
CREATE USER canal IDENTIFIED BY 'canal'; GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%'; -- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ; FLUSH PRIVILEGES;
4.启动
-
下载 canal, 访问 release 页面 , 选择需要的包下载, 如以 1.1.4 版本为例
wget https://github.com/alibaba/canal/releases/download/canal-1.1.4/canal.deployer-1.1.4.tar.gz -
解压缩
mkdir /opt/canal tar zxvf canal.deployer-1.1.4.tar.gz -C /opt/canal-
解压完成后，进入 /opt/canal 目录，可以看到如下结构
drwxr-xr-x 2 root root 93 Jan 7 11:04 bin drwxr-xr-x 5 root root 123 Jan 7 11:05 conf drwxr-xr-x 2 root root 4096 Jan 6 16:45 lib drwxrwxrwx 4 root root 34 Jan 6 18:24 logs
-
-
配置修改
vi conf/example/instance.properties## mysql serverId canal.instance.mysql.slaveId = 1234 #position info，需要改成自己的数据库信息 canal.instance.master.address = 127.0.0.1:3306 canal.instance.master.journal.name = canal.instance.master.position = canal.instance.master.timestamp = #canal.instance.standby.address = #canal.instance.standby.journal.name = #canal.instance.standby.position = #canal.instance.standby.timestamp = #username/password，需要改成自己的数据库信息 canal.instance.dbUsername = canal canal.instance.dbPassword = canal canal.instance.defaultDatabaseName = canal.instance.connectionCharset = UTF-8 #table regex canal.instance.filter.regex = .\*\\\\..\*- canal.instance.connectionCharset 代表数据库的编码方式对应到 java 中的编码类型，比如 UTF-8，GBK , ISO-8859-1
- 如果系统是1个 cpu，需要将 canal.instance.parser.parallel 设置为 false
-
启动
sh bin/startup.sh -
查看 server 日志
vi logs/canal/canal.log2022-01-07 11:04:14.313 [main] INFO com.alibaba.otter.canal.deployer.CanalLauncher - ## set default uncaught exception handler 2022-01-07 11:04:14.451 [main] INFO com.alibaba.otter.canal.deployer.CanalLauncher - ## load canal configurations 2022-01-07 11:04:14.463 [main] INFO com.alibaba.otter.canal.deployer.CanalStarter - ## start the canal server. 2022-01-07 11:04:14.530 [main] INFO com.alibaba.otter.canal.deployer.CanalController - ## start the canal server[192.168.9.152(192.168.9.152):11111] 2022-01-07 11:04:16.608 [main] INFO com.alibaba.otter.canal.deployer.CanalStarter - ## the canal server is running now ...... -
查看 instance 的日志
vi logs/example/example.log2022-01-07 11:04:15.270 [main] INFO c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties] 2022-01-07 11:04:15.283 [main] INFO c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties] 2022-01-07 11:04:15.594 [main] WARN o.s.beans.GenericTypeAwarePropertyDescriptor - Invalid JavaBean property 'connectionCharset' being accessed! Ambiguous write methods found next to actually used [public void com.alibaba.otter.canal.parse.inbound.mysql.AbstractMysqlEventParser.setConnectionCharset(java.nio.charset.Charset)]: [public void com.alibaba.otter.canal.parse.inbound.mysql.AbstractMysqlEventParser.setConnectionCharset(java.lang.String)] 2022-01-07 11:04:15.675 [main] INFO c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [canal.properties] 2022-01-07 11:04:15.676 [main] INFO c.a.o.c.i.spring.support.PropertyPlaceholderConfigurer - Loading properties file from class path resource [example/instance.properties] 2022-01-07 11:04:16.509 [main] INFO c.a.otter.canal.instance.spring.CanalInstanceWithSpring - start CannalInstance for 1-example 2022-01-07 11:04:16.521 [main] WARN c.a.o.canal.parse.inbound.mysql.dbsync.LogEventConvert - --> init table filter : ^.*\..*$ 2022-01-07 11:04:16.521 [main] WARN c.a.o.canal.parse.inbound.mysql.dbsync.LogEventConvert - --> init table black filter : 2022-01-07 11:04:16.546 [main] INFO c.a.otter.canal.instance.core.AbstractCanalInstance - start successful.... -
关闭
sh bin/stop.sh
5.使用
canal的介绍在官网有非常详细的说明，如果想了解更多，大家可以移步官网（https://github.com/alibaba/canal）了解。我这里补充下使用中不太容易理解部分。
canal的部署主要分为server端和client端。
server端部署好以后，可以直接监听mysql binlog,因为server端是把自己模拟成了mysql slave，所以，只能接受数据，没有进行任何逻辑的处理，具体的逻辑处理，需要client端进行处理。
client端一般是需要大家进行简单的开发。https://github.com/alibaba/canal/wiki/ClientAPI 有一个简单的示例，很容易理解。
5.1.依赖配置
com.alibaba.otter
canal.client
1.1.4
5.2.CanalClient代码
package com.seabox.canal;
import java.net.InetSocketAddress;
import java.util.List;
import com.alibaba.otter.canal.client.CanalConnectors;
import com.alibaba.otter.canal.client.CanalConnector;
import com.alibaba.otter.canal.common.utils.AddressUtils;
import com.alibaba.otter.canal.protocol.Message;
import com.alibaba.otter.canal.protocol.CanalEntry.Column;
import com.alibaba.otter.canal.protocol.CanalEntry.Entry;
import com.alibaba.otter.canal.protocol.CanalEntry.EntryType;
import com.alibaba.otter.canal.protocol.CanalEntry.EventType;
import com.alibaba.otter.canal.protocol.CanalEntry.RowChange;
import com.alibaba.otter.canal.protocol.CanalEntry.RowData;
/**
* @author: Denny
* @date: 2022/1/7 12:50
* @desc:
*/
public class CanalClient {
public static void main(String args[]) {
// 创建链接
CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("192.168.9.152",
11111), "example", "", "");
int batchSize = 1000;
int emptyCount = 0;
try {
connector.connect();
connector.subscribe(".*\\..*");
connector.rollback();
int totalEmptyCount = 120;
while (emptyCount < totalEmptyCount) {
Message message = connector.getWithoutAck(batchSize); // 获取指定数量的数据
long batchId = message.getId();
int size = message.getEntries().size();
if (batchId == -1 || size == 0) {
emptyCount++;
System.out.println("empty count : " + emptyCount);
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
}
} else {
emptyCount = 0;
// System.out.printf("message[batchId=%s,size=%s] \n", batchId, size);
printEntry(message.getEntries());
}
connector.ack(batchId); // 提交确认
// connector.rollback(batchId); // 处理失败, 回滚数据
}
System.out.println("empty too many times, exit");
} finally {
connector.disconnect();
}
}
private static void printEntry(List<Entry> entrys) {
for (Entry entry : entrys) {
if (entry.getEntryType() == EntryType.TRANSACTIONBEGIN || entry.getEntryType() == EntryType.TRANSACTIONEND) {
continue;
}
RowChange rowChage = null;
try {
rowChage = RowChange.parseFrom(entry.getStoreValue());
} catch (Exception e) {
throw new RuntimeException("ERROR ## parser of eromanga-event has an error , data:" + entry.toString(),
e);
}
EventType eventType = rowChage.getEventType();
System.out.println(String.format("================> binlog[%s:%s] , name[%s,%s] , eventType : %s",
entry.getHeader().getLogfileName(), entry.getHeader().getLogfileOffset(),
entry.getHeader().getSchemaName(), entry.getHeader().getTableName(),
eventType));
for (RowData rowData : rowChage.getRowDatasList()) {
if (eventType == EventType.DELETE) {
printColumn(rowData.getBeforeColumnsList());
} else if (eventType == EventType.INSERT) {
printColumn(rowData.getAfterColumnsList());
} else {
System.out.println("-------> before");
printColumn(rowData.getBeforeColumnsList());
System.out.println("-------> after");
printColumn(rowData.getAfterColumnsList());
}
}
}
}
private static void printColumn(List<Column> columns) {
for (Column column : columns) {
System.out.println(column.getName() + " : " + column.getValue() + " update=" + column.getUpdated());
}
}
}
5.3.运行Client
首先启动Canal Server。参考上述说明。
其次启动Canal Client，可以从控制台从看到类似消息：
empty count : 1
empty count : 2
empty count : 3
empty count : 4
此时代表当前数据库无变更数据。
5.4.触发数据库变更
mysql> use test;
Database changed
mysql> CREATE TABLE `xdual` (
-> `ID` int(11) NOT NULL AUTO_INCREMENT,
-> `X` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
-> PRIMARY KEY (`ID`)
-> ) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8 ;
Query OK, 0 rows affected (0.06 sec)
mysql> insert into xdual(id,x) values(null,now());
Query OK, 1 row affected (0.06 sec)
可以从控制台中看到：
empty count : 1
empty count : 2
empty count : 3
================> binlog[mysql-bin.000002:1102] , name[test,xdual] , eventType : INSERT
ID : 4 update=true
X : 2022-01-07 14:42:34 update=true
从binlog可以看到，test库的xdual表insert了一条记录，内容为：（4，2022-01-07 14:42:34）。
6.总结
实时数仓中，一般会采用监控mysql的binlog日志来实时采集数据。
附录一：canal的集群模式及HA安装
Single模式部署方便，简单，一般用于本地测试，学习。
Cluster模式需要依赖于Zookeeper安装。一般用于生产环境。
Canal Cluster模式安装
- 前提，保证zookeeper已经开启。
- 修改mysql配置
输入命令：vim /etc/my.cnf
MySQL需要先开启 Binlog 写入功能，配置 binlog-format 为 ROW 模式，具体如下
[mysqld]
log-bin=mysql-bin # 开启 binlog
binlog-format=ROW # 选择 ROW 模式
server_id=1 # 配置 MySQL replaction 需要定义，不要和 canal 的 slaveId 重复
- 修改canal.properties文件
#如果是Single模式，这里为空
#Cluster模式要改为zk的地址
canal.zkServers = hadoop101:2181,hadoop102:2181,hadoop103:2181
- 修改instance.properties文件
#该id和mysql的id不要重复
canal.instance.mysql.slaveId=2
到此，则Canal的Cluster模式安装完成。
Canal HA搭建
把刚刚配置好Cluster模式下的Canal 分发给集群另一个节点。
修改instance.properties文件
#该id和mysql的id不要重复，但要和前面与你一同搭建HA的Canal保持一致。
canal.instance.mysql.slaveId=2
zk的地址
canal.zkServers = hadoop101:2181,hadoop102:2181,hadoop103:2181
* 修改instance.properties文件
~~~shell
#该id和mysql的id不要重复
canal.instance.mysql.slaveId=2
到此，则Canal的Cluster模式安装完成。
Canal HA搭建
把刚刚配置好Cluster模式下的Canal 分发给集群另一个节点。
修改instance.properties文件
#该id和mysql的id不要重复，但要和前面与你一同搭建HA的Canal保持一致。
canal.instance.mysql.slaveId=2
到此，Canal HA 搭建完成。