alibaba Canal 增量订阅 & 消费组件，了解，安装，部署实践

可乐cc呀

已于 2023-04-23 17:26:25 修改

阅读量1.1k

点赞数 1

分类专栏： Mysql 文章标签：数据库 mysql java

于 2022-06-27 20:46:42 首次发布

本文链接：https://blog.csdn.net/Crazy_Cw/article/details/125491526

版权

Mysql 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

alibaba Canal 增量订阅 & 消费组件，了解，安装，部署实践

简介

Github地址:https://github.com/alibaba/canal

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

在这里插入图片描述

工作原理

MySQL master：将数据变更写入二进制日志 (binary log, 其中记录叫做二进制日志事件 binary log events，可以通过 show binlog events 进行查看)
MySQL slave 将 ：master 的 binary log events 拷贝到它的中继日志 (relay log)
MySQL slave ：重放 relay log 中事件，将数据变更反映它自己的数据

在这里插入图片描述

canal 工作原理

canal 模拟 MySQL slave 的交互协议，伪装自己为 MySQL slave ，向 MySQL master 发送 dump 协议
MySQL master 收到 dump 请求，开始推送 binary log 给 slave (即 canal)
canal 解析 binary log 对象 (原始为 byte 流)

windows，linux 部署

下载

下载地址：https://github.com/alibaba/canal/releases

canal.deployer-1.1.6.tar.gz，百度云地址链接：https://pan.baidu.com/s/1UIRIaDLm32xPTAdXPvdpYg 提取码：jhnq

canal.deployer-1.1.4.tar.gz，百度云地址链接：https://pan.baidu.com/s/1QV9Dg0_cfsAu-c2zOKwAQg 提取码：gknf

下载部署版本：canal.deployer-1.1.6.tar.gz
在这里插入图片描述

issues地址：https://github.com/alibaba/canal/issues/4245

注意：1.1.6 版本安装包有问题，需要下载源码，自己重新编译版本

Bug：java.io.IOException: ErrorPacket [errorNumber=1146, fieldCount=-1, message=Table ‘test.base table’ doesn’t exist, sqlState=42S02, sqlStateMarker=#]

在这里插入图片描述

下载部署版本： canal.deployer-1.1.4.tar.gz

在这里插入图片描述

安装，以下步骤，我用 1.1.4 版本

直接解压即可，

在这里插入图片描述

bin ：windows 和 Linux 启动命令
conf : 配置文件
lib：依赖包
logs：运行日志文件存放地址

配置Mysql

在my.ini 文件中添加配置

[mysqld]

#开启binlog
log-bin = mysql-bin

#选择 row 模式
binlog-format = ROW 

#配置 mysql replaction 需要定义，不能和 canal 的 slaveId 重
server_id = 1

检查配置是否生效

show variables like 'binlog_format%'

在这里插入图片描述

创建Mysql ，canal，用户

#创建用户
CREATE USER canal IDENTIFIED BY 'canal';

#赋权
GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';    

#刷新
-- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;    
FLUSH PRIVILEGES;

配置 canal

启动报错：ch.qos.logback.core.LogbackException: Unexpected filename extension of file [file:/E:/codes/github/canal/deployer/target/canal/conf/]. Should be either .groovy or .xml

见：https://github.com/alibaba/canal/issues/3150

修改方法，打开 startup.bat 文件 19 行修改如下：
在这里插入图片描述

set CANAL_OPTS= -DappName=otter-canal -Dlogback.configurationFile="%logback_configurationFile%logback.xml" -Dcanal.conf="%canal_conf%"

在这里插入图片描述

/conf/canal.properties 单机下默认不用改配置

/conf/example/ instance.properties 单机下默认不用改配置

启动

打开 bin 目录下， startUp.bat 双击

在这里插入图片描述

检查日志是否启动成功，打开 /logs/example/example.log
在这里插入图片描述

检查日志是否启动成功，打开 /logs/canal/canal.log
在这里插入图片描述

canal 集成 Springboot

引入官方依赖

        <dependency>
            <groupId>com.alibaba.otter</groupId>
            <artifactId>canal.protocol</artifactId>
            <version>1.1.5</version>
        </dependency>

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

编写JAVA编码

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 lombok.extern.slf4j.Slf4j;
import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.core.annotation.Order;
import org.springframework.stereotype.Component;

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

@Component
@Order(value = 1)
@Slf4j
public class canalClient implements ApplicationRunner {

    @Override
    public void run(ApplicationArguments args) throws Exception {
        // 创建链接
        CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("127.0.0.1",
                11111), "example", "", "");
        int batchSize = 1000;
        try {
            connector.connect();
            connector.subscribe(".*\\..*");//指定扫描全库全表，也可以扫描指定库 例如：test_db\..*
            connector.rollback();
            while (true) {
                Message message = connector.getWithoutAck(batchSize); // 获取指定数量的数据
                long batchId = message.getId();
                int size = message.getEntries().size();
                if (batchId == -1 || size == 0) {
                    try {
                        Thread.sleep(1000);
                    } catch (InterruptedException e) {
                    }
                } else {
                    parseEntry(message.getEntries());
                }

                connector.ack(batchId); // 提交确认
            }
        } catch (Exception e) {
            e.printStackTrace();
            log.error("成功断开监测连接!尝试重连");
        } finally {
            connector.disconnect();
        }
    }

    private void parseEntry(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);
            }
            String tableName = entry.getHeader().getTableName(); //获取表名，用于处理业务
            EventType eventType = rowChage.getEventType(); //当前数据库操作类型

            for (RowData rowData : rowChage.getRowDatasList()) {
                List<Column> afterColumnsList = rowData.getAfterColumnsList(); //获取所有字段，用于处理业务
                
                switch (eventType) {
                    /**
                     * 删除操作
                     */
                    case DELETE:
                        //todo 处理业务逻辑
                        break;
                    /**
                     * 添加操作
                     */
                    case INSERT:
                        //todo 处理业务逻辑
                        break;
                    /**
                     * 更新操作
                     */
                    case UPDATE:
                        //todo 处理业务逻辑
                        break;
                    default:
                        break;
                }
            }
        }

    }
  
  /**
  * 枚举类
  *
  */  
  public static enum EntryType implements ProtocolMessageEnum {
        TRANSACTIONBEGIN(0, 1),
        ROWDATA(1, 2),
        TRANSACTIONEND(2, 3),
        HEARTBEAT(3, 4),
        GTIDLOG(4, 5);

        public static final int TRANSACTIONBEGIN_VALUE = 1;
        public static final int ROWDATA_VALUE = 2;
        public static final int TRANSACTIONEND_VALUE = 3;
        public static final int HEARTBEAT_VALUE = 4;
        public static final int GTIDLOG_VALUE = 5;
        private static Internal.EnumLiteMap<EntryType> internalValueMap = new Internal.EnumLiteMap<EntryType>() {
            public EntryType findValueByNumber(int number) {
                return CanalEntry.EntryType.valueOf(number);
            }
        };
        private static final EntryType[] VALUES = values();
        private final int index;
        private final int value;

        public final int getNumber() {
            return this.value;
        }

        public static EntryType valueOf(int value) {
            switch (value) {
                case 1:
                    return TRANSACTIONBEGIN;
                case 2:
                    return ROWDATA;
                case 3:
                    return TRANSACTIONEND;
                case 4:
                    return HEARTBEAT;
                case 5:
                    return GTIDLOG;
                default:
                    return null;
            }
        }

        public static Internal.EnumLiteMap<EntryType> internalGetValueMap() {
            return internalValueMap;
        }

        public final Descriptors.EnumValueDescriptor getValueDescriptor() {
            return (Descriptors.EnumValueDescriptor)getDescriptor().getValues().get(this.index);
        }

        public final Descriptors.EnumDescriptor getDescriptorForType() {
            return getDescriptor();
        }

        public static final Descriptors.EnumDescriptor getDescriptor() {
            return (Descriptors.EnumDescriptor)CanalEntry.getDescriptor().getEnumTypes().get(0);
        }

        public static EntryType valueOf(Descriptors.EnumValueDescriptor desc) {
            if (desc.getType() != getDescriptor()) {
                throw new IllegalArgumentException("EnumValueDescriptor is not for this type.");
            } else {
                return VALUES[desc.getIndex()];
            }
        }

        private EntryType(int index, int value) {
            this.index = index;
            this.value = value;
        }
    }
}

使用第三方开源依赖 canal-starter。

地址：https://github.com/NormanGyllenhaal/canal-client

依赖：

	    <dependency>
            <groupId>top.javatool</groupId>
            <artifactId>canal-spring-boot-starter</artifactId>
            <version>1.2.1-RELEASE</version>
        </dependency>

编写配置文件：

canal:
  destination: example  # canal实例名默认为example可以在配置文件中修改
  server: 192.168.0.5:11111

编写单表监听器：

//需要监听的表
@CanalTable("history_log")  
@Component
public class HistoryLogHandler implements EntryHandler<HistoryLog> {//指定表关系实体类
    @Override
    public void insert(HistoryLog historyLog) {
        //新增数据时执行此方法
    }
    @Override
    public void update(HistoryLog before, HistoryLog after) {
        //更新数据时执行此方法
    }
    @Override
    public void delete(HistoryLog historyLog) {
        //删除数据时执行此方法
    }
}

编写全表监听器

@CanalTable(value = "all")
@Component
public class DefaultEntryHandler implements EntryHandler<Map<String, String>> {
     @Override
        public void insert(Map<String, String> map) {
            logger.info("insert message  {}", map);
        }
    
        @Override
        public void update(Map<String, String> before, Map<String, String> after) {
            logger.info("update before {} ", before);
            logger.info("update after {}", after);
        }
    
        @Override
        public void delete(Map<String, String> map) {
            logger.info("delete  {}", map);
        }
}

总结

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

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

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

Canal 的部署也是支持集群的，需要配合 ZooKeeper 进行集群管理。

可乐cc呀

关注

1
点赞
踩
5

收藏

觉得还不错? 一键收藏
打赏
1
评论
alibaba Canal 增量订阅 & 消费组件，了解，安装，部署实践

下载部署版本：canal.deployer-1.1.6.tar.gzissues地址：https://github.com/alibaba/canal/issues/4245注意：1.1.6 版本安装包有问题，需要下载源码，自己重新编译版本下载部署版本： canal.deployer-1.1.4.tar.gz直接解压即可，配置 canal见：https://github.com/alibaba/canal/issues/3150修改方法，打开 startup.bat 文件 19 行修改如下
复制链接

扫一扫