canal,译意为水道/管道/沟渠,主要用途是基于 MySQL 数据库增量日志解析,提供增量数据订阅和消费。

canal实际应用所在的位置如下图:

一、canal能做什么
canal的数据同步不是全量的,而是增量。基于binary log增量订阅和消费,canal可以做:

数据库镜像
数据库实时备份
索引构建和实时维护
业务cache(缓存)刷新
带业务逻辑的增量数据处理
二、搭建canal
在MySQL中需要创建一个用户,并授权:

-- 使用命令登录:mysql -u root -p
-- 创建用户 用户名:canal 密码:Canal@123456
create user 'canal'@'%' identified by 'Canal@123456';
-- 授权 *.*表示所有库
grant SELECT, REPLICATION SLAVE, REPLICATION CLIENT on *.* to 'canal'@'%' identified by 'Canal@123456';
在MySQL配置文件my.cnf设置如下信息:

[mysqld]
# 打开binlog
log-bin=mysql-bin
# 选择ROW(行)模式
binlog-format=ROW
# 配置MySQL replaction需要定义,不要和canal的slaveId重复
server_id=1
改了配置文件之后,重启MySQL,使用命令查看是否打开binlog模式:

查看binlog日志文件列表:

查看当前正在写入的binlog文件:

进入到配置文件/etc/my.cnf中查看mysql数据文件存放路径

发现有很多bin文件,说明binlog日志开启成功,能实时记录保存DML操作

二、canal安装
官网下载地址https://github.com/alibaba/canal/releases

修改配置文件:vim conf/canal.properties

canal.instance.parser.parallelThreadSize = 16
 把这一行的注释符号去掉(java才能成功运行)
 修改配置文件:vi conf/example/instance.properties## mysql serverId , v1.0.26+ will autoGen
 ## v1.0.26版本后会自动生成slaveId,所以可以不用配置
 # canal.instance.mysql.slaveId=0
  
 # 数据库地址
 canal.instance.master.address=127.0.0.1:3306
 # binlog日志名称
 canal.instance.master.journal.name=mysql-bin.000001
 # mysql主库链接时起始的binlog偏移量
 canal.instance.master.position=154
 # mysql主库链接时起始的binlog的时间戳
 canal.instance.master.timestamp=
 canal.instance.master.gtid=
  
 # username/password
 # 在MySQL服务器授权的账号密码
 canal.instance.dbUsername=canal
 canal.instance.dbPassword=Canal@123456
 # 字符集
 canal.instance.connectionCharset = UTF-8
 # enable druid Decrypt database password
 canal.instance.enableDruid=false
  
 # table regex .*\\..*表示监听所有表 也可以写具体的表名,用,隔开
 canal.instance.filter.regex=.*\\..*
 # mysql 数据解析表的黑名单,多个表用,隔开
 canal.instance.filter.black.regex=
 进入bin目录下启动 (sh bin/startup.sh)
 并查看进程 ps -ef | grep canal

三、Java客户端操作
首先引入maven依赖:

<dependency>
     <groupId>com.alibaba.otter</groupId>
     <artifactId>canal.client</artifactId>
     <version>1.1.4</version>
 </dependency>


然后创建一个canal项目,使用SpringBoot构建,如图所示

在CannalClient类使用Spring Bean的生命周期函数afterPropertiesSet():

package com.yijiu.deploy;
  
 import com.alibaba.otter.canal.client.CanalConnector;
 import com.alibaba.otter.canal.client.CanalConnectors;
 import com.alibaba.otter.canal.protocol.CanalEntry;
 import com.alibaba.otter.canal.protocol.CanalEntry.*;
 import com.alibaba.otter.canal.protocol.Message;
 import org.springframework.beans.factory.InitializingBean;
 import org.springframework.stereotype.Component;
  
 import java.net.InetSocketAddress;
 import java.util.List;
  
 @Component
 public class CanalClient implements InitializingBean {
  
     private final static int BATCH_SIZE = 1000;
  
     @Override
     public void afterPropertiesSet() throws Exception {
         // 创建链接
         CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("10.104.188.67", 11111), "example", "", "");
         try {
             //打开连接
             connector.connect();
             //订阅数据库表,全部表
             connector.subscribe(".*\\..*");
             //回滚到未进行ack的地方,下次fetch的时候,可以从最后一个没有ack的地方开始拿
             connector.rollback();
             while (true) {
                 // 获取指定数量的数据
                 Message message = connector.getWithoutAck(BATCH_SIZE);
                 //获取批量ID
                 long batchId = message.getId();
                 //获取批量的数量
                 int size = message.getEntries().size();
                 //如果没有数据
                 if (batchId == -1 || size == 0) {
                     try {
                         //线程休眠2秒
                         Thread.sleep(2000);
                     } catch (InterruptedException e) {
                         e.printStackTrace();
                     }
                 } else {
                     //如果有数据,处理数据
                     printEntry(message.getEntries());
                 }
                 //进行 batch id 的确认。确认之后,小于等于此 batchId 的 Message 都会被确认。
                 connector.ack(batchId);
             }
         } catch (Exception e) {
             e.printStackTrace();
         } finally {
             connector.disconnect();
         }
     }
  
     /**
      * 打印canal server解析binlog获得的实体类信息
      */
     private static void printEntry(List<Entry> entrys) {
         for (CanalEntry.Entry entry : entrys) {
             if (entry.getEntryType() == CanalEntry.EntryType.TRANSACTIONBEGIN || entry.getEntryType() == EntryType.TRANSACTIONEND) {
                 //开启/关闭事务的实体类型,跳过
                 continue;
             }
             //RowChange对象,包含了一行数据变化的所有特征
             //比如isDdl 是否是ddl变更操作 sql 具体的ddl sql beforeColumns afterColumns 变更前后的数据字段等等
             RowChange rowChage;
             try {
                 rowChage = RowChange.parseFrom(entry.getStoreValue());
             } catch (Exception e) {
                 throw new RuntimeException("ERROR ## parser of eromanga-event has an error , data:" + entry.toString(), e);
             }
             //获取操作类型:insert/update/delete类型
             EventType eventType = rowChage.getEventType();
             //打印Header信息
             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));
             //判断是否是DDL语句
             if (rowChage.getIsDdl()) {
                 System.out.println("================》;isDdl: true,sql:" + rowChage.getSql());
             }
             //获取RowChange对象里的每一行数据,打印出来
             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());
         }
     }
 }


以上就完成了Java客户端的代码。

开始测试,首先启动MySQL、Canal Server,还有刚刚写的Spring Boot项目。然后创建表:

CREATE TABLE `tb_commodity_info` (
   `id` varchar(32) NOT NULL,
   `commodity_name` varchar(512) DEFAULT NULL COMMENT '商品名称',
   `commodity_price` varchar(36) DEFAULT '0' COMMENT '商品价格',
   `number` int(10) DEFAULT '0' COMMENT '商品数量',
   `description` varchar(2048) DEFAULT '' COMMENT '商品描述',
   PRIMARY KEY (`id`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COMMENT='商品信息表';


然后我们在控制台就可以看到如下信息:

如果新增一条数据到表中:

INSERT INTO tb_commodity_info VALUES('3e71a81fd80711eaaed600163e046cc3','叉烧包','3.99',3,'又大又香的叉烧包,老人小孩都喜欢');
控制台可以看到如下信息:

canal的好处在于对业务代码没有侵入,因为是基于监听binlog日志去进行同步数据的。实时性也能做到准实时,其实是很多企业一种比较常见的数据同步的方案。

通过上面的学习之后,我们应该都明白canal是什么,它的原理,还有用法。实际上这仅仅只是入门,因为实际项目中我们不是这样玩的...

实际项目我们是配置MQ模式,配合RocketMQ或者Kafka,canal会把数据发送到MQ的topic中,然后通过消息队列的消费者进行处理。

补充。binlog row模式,在没有变更的情况下,执行是不生效的。

开启binlog的时候,注意server_id,以及注意默认的偏移量之类的。