Canal实现MySQL增量数据的订阅和消费

发布时间 2023-09-16 15:23:24作者: strongmore

介绍

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

canal的工作原理就是把自己伪装成MySQL slave,模拟MySQL slave的交互协议向MySQL Master发送 dump 协议,MySQL mater收到canal发送过来的dump请求,开始推送binary log给canal,然后canal解析binary log,再发送到存储目的地,比如MySQL,Kafka,Elastic Search等。

搭建canal

canal官网

首先要有一个MySQL服务器

可以参考这篇笔记 MySQL搭建主从架构,仅需要配置主机的部分,从机不需要配置,canal作为一个从机。

CREATE USER 'szz'@'%' IDENTIFIED WITH mysql_native_password BY 'pwd1';
GRANT REPLICATION SLAVE,REPLICATION CLIENT ON *.* TO 'szz'@'%';
flush privileges;

注意,配置binlog模式必须配置为row。相比主从配置,多了一个REPLICATION CLIENT权限。

使用docker安装canal

docker pull canal/canal-server:v1.1.4
docker run -d \
--name canal-server \
-p 11111:11111  \
-e canal.instance.master.address=ip:port \
-e canal.instance.mysql.slaveId=1234 \
-e canal.instance.dbUsername=szz \
-e canal.instance.dbPassword=pwd1 \
canal/canal-server:v1.1.4

使用docker安装有问题,运行不起来,具体原因未知

使用jar包运行

wget https://github.com/alibaba/canal/releases/download/canal-1.1.6/canal.deployer-1.1.6.tar.gz

网络原因,最好是下载到windows下,再上传到自己的服务器。

canal.instance.master.address=ip:port
canal.instance.dbUsername=szz
canal.instance.dbPassword=pwd1

编辑配置文件 conf/example/instance.properties

bin/startup.sh

需要配置JAVA_HOME环境变量,启动成功后,会在bin目录下生成canal.pid。
如果出现There is insufficient memory的错误,需要修改startup.sh和restart.sh中的-Xms,-Xmx等启动参数

-Xms128m

java客户端监听

<dependency>
  <groupId>com.alibaba.otter</groupId>
  <artifactId>canal.client</artifactId>
  <version>1.1.6</version>
</dependency>
<dependency>
  <groupId>com.alibaba.otter</groupId>
  <artifactId>canal.protocol</artifactId>
  <version>1.1.6</version>
  <optional>true</optional>
</dependency>
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.Message;

import java.net.InetSocketAddress;
import java.util.List;

public class TestCanalClient {

    private final static int BATCH_SIZE = 1000;

    public static void main(String[] args) {
        CanalConnector connector = createConnector();
        // 创建链接
        try {
            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<CanalEntry.Entry> entrys) {
        for (CanalEntry.Entry entry : entrys) {
            if (entry.getEntryType() == CanalEntry.EntryType.TRANSACTIONBEGIN || entry.getEntryType() == CanalEntry.EntryType.TRANSACTIONEND) {
                //开启/关闭事务的实体类型,跳过
                continue;
            }
            //RowChange对象,包含了一行数据变化的所有特征
            //比如isDdl 是否是ddl变更操作 sql 具体的ddl sql beforeColumns afterColumns 变更前后的数据字段等等
            CanalEntry.RowChange rowChage;
            try {
                rowChage = CanalEntry.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类型
            CanalEntry.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 (CanalEntry.RowData rowData : rowChage.getRowDatasList()) {
                //如果是删除语句
                if (eventType == CanalEntry.EventType.DELETE) {
                    printColumn(rowData.getBeforeColumnsList());
                    //如果是新增语句
                } else if (eventType == CanalEntry.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<CanalEntry.Column> columns) {
        for (CanalEntry.Column column : columns) {
            System.out.println(column.getName() + " : " + column.getValue() + "    update=" + column.getUpdated());
        }
    }

    private static CanalConnector createConnector() {
        CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("ip", 11111), "example", "", "");
        //打开连接
        connector.connect();
        //订阅数据库表,全部表
        connector.subscribe(".*\\..*");
        //回滚到未进行ack的地方,下次fetch的时候,可以从最后一个没有ack的地方开始拿
        connector.rollback();
        return connector;
    }
}

源码分析

1.0 canal源码分析简介

参考

超详细Canal入门,看这篇就够了!
canal官网文档
基于Docker结合Canal实现MySQL实时增量数据传输