canal 官方文档

一、canal安装(1.1.4)

  1. 下载安装包,解压,创建软连接。
  2. 修改配置文件。
    2.1 canal.properties
# 可选项: tcp(默认), kafka, RocketMQ
canal.serverMode = kafka
# kafka/rocketmq 集群配置
canal.mq.servers = nn1.hadoop:9092,nn2.hadoop:9092,s1:9092
# 重试次数
canal.mq.retries = 0
# flagMessage模式下可以调大该值, 但不要超过MQ消息体大小上限
canal.mq.batchSize = 16384
canal.mq.maxRequestSize = 1048576
# flatMessage模式下请将该值改大, 建议50-200
canal.mq.lingerMs = 1
canal.mq.bufferMemory = 33554432
# Canal的batch size, 默认50K, 由于kafka最大消息体限制请勿超过1M(900K以下)
canal.mq.canalBatchSize = 50
# Canal get数据的超时时间, 单位: 毫秒, 空为不限超时
canal.mq.canalGetTimeout = 100
# 是否为flat json格式对象
canal.mq.flatMessage = false
canal.mq.compressionType = none
canal.mq.acks = all
# kafka消息投递是否使用事务
canal.mq.transaction = false

2.2 instance.properties

# 连接的数据库地址
canal.instance.master.address=192.168.1.20:3306
# 用户名,密码
canal.instance.dbUsername = canal
canal.instance.dbPassword = canal
# 同步的库
canal.instance.defaultDatabaseName =
# 数据库的编码格式
canal.instance.connectionCharset = UTF-8
# 表的过滤规则 无论是CanalServer还是Consumer,只要有一方指定了filter都会生效,consumer端如果指定,则会覆盖CanalServer端。
# 所有表:.*   or  .*\\..*
# canal schema下所有表: canal\\..*
# canal下的以canal打头的表:canal\\.canal.*
# canal schema下的一张表:canal.test1
# 多个规则组合使用:canal\\..*,mysql.test1,mysql.test2 (逗号分隔)
canal.instance.filter.regex = .\*\\..\*
...
# mq config
canal.mq.topic=example
# 针对库名或者表名发送动态topic,1.1.3版本后开始支持,需要设置kafka自动创建topic
# canal.mq.dynamicTopic=mytest,.*,mytest.user,mytest\\..*,.*\\..*
# 单队列模式的分区下标
canal.mq.partition=0
# 散列模式的分区数
# hash partition config
#canal.mq.partitionsNum=3
# 散列规则定义
# 库名.表名 : 唯一主键,比如mytest.person:id。多个表之间用逗号分隔
#canal.mq.partitionHash=mytest.person:id,mytest.role:id

2.2.1 canal.mq.dynamicTopic 表达式说明:
canal 1.1.3版本之后, 支持配置格式:schema 或 schema.table,多个配置之间使用逗号或分号分隔:
. 例子1:test\.test 指定匹配的单表,发送到以test_test为名字的topic上
. 例子2:.\.. 匹配所有表,则每个表都会发送到各自表名的topic上
. 例子3:test 指定匹配对应的库,一个库的所有表都会发送到库名的topic上
. 例子4:test\.* 指定匹配的表达式,针对匹配的表会发送到各自表名的topic上
. 例子5:test,test1\.test1,指定多个表达式,会将test库的表都发送到test的topic上,test1\.test1的表发送到对应的test1_test1 topic上,其余的表发送到默认的canal.mq.topic值
为满足更大的灵活性,允许对匹配条件的规则指定发送的topic名字,配置格式:topicName:schema 或 topicName:schema.table:
. 例子1: test:test\.test 指定匹配的单表,发送到以test为名字的topic上
. 例子2: test:.\.. 匹配所有表,因为有指定topic,则每个表都会发送到test的topic下
. 例子3: test:test 指定匹配对应的库,一个库的所有表都会发送到test的topic下
. 例子4:testA:test\.* 指定匹配的表达式,针对匹配的表会发送到testA的topic下
. 例子5:test0:test,test1:test1\.test1,指定多个表达式,会将test库的表都发送到test0的topic下,test1\.test1的表发送到对应的test1的topic下,其余的表发送到默认的canal.mq.topic值

2.2.2 canal.mq.partitionHash 表达式说明
canal 1.1.3版本之后, 支持配置格式:schema.table:pk1^pk2,多个配置之间使用逗号分隔:
. 例子1:test\.test:pk1^pk2 指定匹配的单表,对应的hash字段为pk1 + pk2
. 例子2:.\..:id 正则匹配,指定所有正则匹配的表对应的hash字段为id
. 例子3:.\..:\(pk\) 正则匹配,指定所有正则匹配的表对应的hash字段为表主键(自动查找)
. 例子4: 匹配规则啥都不写,则默认发到0这个partition上
. 例子5:.\.. ,不指定pk信息的正则匹配,将所有正则匹配的表,对应的hash字段为表名。按表hash: 一张表的所有数据可以发到同一个分区,不同表之间会做散列 (会有热点表分区过大问题)
. 例子6: test\.test:id,.\..* , 针对test的表按照id散列,其余的表按照table散列
. 注意:设置匹配规则,多条匹配规则之间是按照顺序进行匹配(命中一条规则就返回)

  1. MySQL配置
    3.1 开启 Binlog 写入功能,配置 binlog-format 为 ROW 模式,my.cnf 中配置如下:
[mysqld]
log-bin=mysql-bin # 开启 binlog
binlog-format=ROW # 选择 ROW 模式
server_id=1 # 配置 MySQL replaction 需要定义,不要和 canal 的 slaveId 重复

3.2 授权 canal 链接 MySQL 账号具有作为 MySQL slave 的权限

CREATE USER canal IDENTIFIED BY 'canal';  
GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';
-- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;
FLUSH PRIVILEGES;

二、kafka_2.11-2.1.1 安装

三、测试

  1. 创建 MySQL 测试表
CREATE TABLE `order` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `order_id` varchar(64) NOT NULL COMMENT '订单ID',
  `amount` decimal(10,2) NOT NULL DEFAULT '0.00' COMMENT '订单金额',
  `create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
  PRIMARY KEY (`id`),
  UNIQUE KEY `id` (`id`),
  UNIQUE KEY `uniq_order_id` (`order_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='订单表';
  1. 执行一条 insert 语句
INSERT INTO `order` (order_id, amount) VALUES ('300', 300.0);

启动一个 kafka 消费者,观察结果如下:

{
    "data":[
        {
            "id":"3",
            "order_id":"300",
            "amount":"300.0",
            "create_time":"2020-05-13 16:54:19"
        }
    ],
    "database":"canal_test",
    "es":1589360059000,
    "id":3,
    "isDdl":false,
    "mysqlType":{
        "id":"bigint(20)",
        "order_id":"varchar(64)",
        "amount":"decimal(10,2)",
        "create_time":"datetime"
    },
    "old":null,
    "pkNames":[
        "id"
    ],
    "sql":"",
    "sqlType":{
        "id":-5,
        "order_id":12,
        "amount":3,
        "create_time":93
    },
    "table":"order",
    "ts":1589360060236,
    "type":"INSERT"
}
  1. 执行一条 update 语句
UPDATE `order`
SET amount = 350.0
WHERE order_id = '300';

观察结果如下:

{
    "data":[
        {
            "id":"3",
            "order_id":"300",
            "amount":"350.0",
            "create_time":"2020-05-13 16:54:19"
        }
    ],
    "database":"canal_test",
    "es":1589361037000,
    "id":4,
    "isDdl":false,
    "mysqlType":{
        "id":"bigint(20)",
        "order_id":"varchar(64)",
        "amount":"decimal(10,2)",
        "create_time":"datetime"
    },
    "old":[
        {
            "amount":"300.0"
        }
    ],
    "pkNames":[
        "id"
    ],
    "sql":"",
    "sqlType":{
        "id":-5,
        "order_id":12,
        "amount":3,
        "create_time":93
    },
    "table":"order",
    "ts":1589361037721,
    "type":"UPDATE"
}
  1. 执行一条 delete 语句
DELETE FROM `order`
WHERE order_id = '300';

结果如下:

{
    "data":[
        {
            "id":"3",
            "order_id":"300",
            "amount":"350.0",
            "create_time":"2020-05-13 16:54:19"
        }
    ],
    "database":"canal_test",
    "es":1589361229000,
    "id":5,
    "isDdl":false,
    "mysqlType":{
        "id":"bigint(20)",
        "order_id":"varchar(64)",
        "amount":"decimal(10,2)",
        "create_time":"datetime"
    },
    "old":null,
    "pkNames":[
        "id"
    ],
    "sql":"",
    "sqlType":{
        "id":-5,
        "order_id":12,
        "amount":3,
        "create_time":93
    },
    "table":"order",
    "ts":1589361230115,
    "type":"DELETE"
}