SpringBoot系列之集成阿里canal监听MySQL Binlog

Posted 2022-01-29 smileNicky

1、什么是阿里canal？

canal是阿里开源的， 对数据库增量日志解析，提供增量数据订阅和消费的组件。引用官网的图片，canal的工作原理主要是模拟 mysql slave 的交互协议，伪装自己为 MySQL slave，向master发送dump 协议，获取到数据后，解析 binary log 对象数据。

2、canal环境搭建

本博客基于window系统的，linux系统的可以参考quickstart，比较详细。

使用canal需要确保数据库开启了binlog：

show variables like'log_%';

如果没开启，在mysql my.ini配置文件添加配置，注意文件内存为的时候，注意编码格式必须为ANSI，不然会编译报错

[mysqld]
# 开启 binlog
log-bin=mysql-bin 
# 选择 ROW 模式
binlog-format=ROW
# 配置 MySQL replaction 需要定义，不要和 canal 的 slaveId 重复
server_id=1

配置文件修改是否正确，使用命令，查看日志

mysqld --console

重启MySQL实例

net stop mysql
net start mysql

binlog开启后，创建一个canal用户并授权，官网配置是@%，表示所有服务器，因为本地测试的，所以改为localhost就可以

CREATE USER canal IDENTIFIED BY 'canal';  
GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'localhost' identified by 'canal';
FLUSH PRIVILEGES;

下载canal服务端，到官网releases下载对应资料，canal.deployer-1.1.6-SNAPSHOT是服务端，在conf文件夹里找到\\example\\instance.properties，修改数据库配置信息，dbUsername，dbPassword数据库账号密码

到canal服务器安装目录D:\\canal\\canal.deployer-1.1.6-SNAPSHOT\\bin，找到startup.bat执行

3、Canal客户端测试

• JDK 1.8
• SpringBoot2.2.1
• Maven 3.2+
• 开发工具
  • IntelliJ IDEA
  • smartGit

新建SpringBoot工程，使用阿里的脚手架，网速比较快

jdk使用1.8的
加上一些其它的配置

在pom文件加上canal客户端的配置：

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

使用官网提供的例子：

package com.alibaba.otter.canal.sample;
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;


public class SimpleCanalClientExample 


public static void main(String args[]) 
    // 创建链接
    CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress(AddressUtils.getHostIp(),
                                                                                        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("================&gt; 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("-------&gt; before");
                printColumn(rowData.getBeforeColumnsList());
                System.out.println("-------&gt; 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());
    

可以对例子进行修改比如只监控这个数据库实例，connector.subscribe(".*canaltest.*");，我们修改数据库表数据，或者新增表，都可以被监控到，日志打印在控制台：

https://github.com/alibaba/canal/wiki