Spring Boot + Canal 实现数据库实时监控

深碍√TFBOYSˉ_ 2023-09-28 21:19 10阅读 0赞

### Canal 工作原理 ###

![format_png][]

1.  Canal 模拟 MySQL slave 的交互协议，伪装自己为 MySQL slave，向 MySQL master 发送 dump 协议
2.  MySQL master 收到 dump 请求，开始推送 binary log 给 slave（也就是 Canal）
3.  Canal 解析 binary log 对象（原始为 byte 流）

### MySQL 打开 binlog 模式 ###

在 MySQL 配置文件 my.cnf 设置如下信息：

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

改了配置文件之后，重启 MySQL，使用命令查看是否打开 binlog 模式：

`SHOW VARIABLES LIKE 'log_bin';`

![format_png 1][]

查看 binlog 日志文件列表：`SHOW BINARY LOGS;`

查看当前正在写入的 binlog 文件：`SHOW MASTER STATUS;` **记录文件名 File 和 Position 值**。

### 启动 Canal 服务 ###

1.  下载地址（canal.deployer-1.1.5.tar.gz）：[github.com/alibaba/can…][github.com_alibaba_can]
2.  参数配置

> 详细配置可以参考：
> 
> [blog.csdn.net/zhou12314/a…][blog.csdn.net_zhou12314_a]
> 
> [www.cnblogs.com/zpan2019/p/…][www.cnblogs.com_zpan2019_p]

1）`canal.deployer-1.1.5\conf\canal.properties` 进行全局配置，可以修改 IP、端口号或实例

# 默认有一个 example，需要增加实例的可以配置
    canal.destinations = example
    复制代码

2）`canal.deployer-1.1.5\conf\example\instance.properties` 进行局部实例配置，可以修改数据库账号和密码、数据库表名、binlog 文件名和 position 等

# 没有改变的就没有贴出来，注意 MySQL 的用户名和密码
    canal.instance.master.address=192.168.58.131:3306
    # username/password
    canal.instance.dbUsername=test
    canal.instance.dbPassword=liubihao
    canal.instance.connectionCharset = UTF-8
    # enable druid Decrypt database password
    canal.instance.enableDruid=false
    # table regex
    canal.instance.filter.regex=.*\\..*
    # table black regex
    canal.instance.filter.black.regex=
    复制代码

mysql 数据解析关注的表，Perl正则表达式.
    多个正则之间以逗号(,)分隔，转义符需要双斜杠(\\) 
    常见例子：
    1.  所有表：.*   or  .*\\..*
    2.  canal schema下所有表： canal\\..*
    3.  canal下的以canal打头的表：canal\\.canal.*
    4.  canal schema下的一张表：canal.test1
    5.  多个规则组合使用：canal\\..*,mysql.test1,mysql.test2 (逗号分隔)
    复制代码

1.  `bin/start.sh` 启动服务（Windows 系统为 `bin/start.bat`）

![format_png 2][]

### 后端进行相应配置 ###

#### 修改 `pom.xml` ####

<dependency>
      <groupId>com.alibaba.otter</groupId>
      <artifactId>canal.client</artifactId>
      <version>1.1.4</version>
    </dependency>
    复制代码

#### 新建 `CanalClient.java` ####

package org.nwpu.atcss.util;
    
    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 org.springframework.stereotype.Component;
    
    import java.util.List;
    import java.net.InetSocketAddress;
    
    @Component
    public class CanalClient {
      private static void printEntries(List<Entry> entries) throws Exception {
        for (Entry entry : entries) {
          if (entry.getEntryType() != EntryType.ROWDATA) {
            continue;
          }
    
          RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
    
          EventType eventType = rowChange.getEventType();
          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));
    
          for (RowData rowData : rowChange.getRowDatasList()) {
            switch (rowChange.getEventType()) {
              case INSERT:
                System.out.println("INSERT ");
                printColumns(rowData.getAfterColumnsList());
                break;
              case UPDATE:
                System.out.println("UPDATE ");
                printColumns(rowData.getAfterColumnsList());
                break;
              case DELETE:
                System.out.println("DELETE ");
                printColumns(rowData.getBeforeColumnsList());
                break;
              default:
                break;
            }
          }
        }
      }
    
      private static void printColumns(List<Column> columns) {
        for (Column column : columns) {
          System.out.println(column.getName() + " : " + column.getValue() + " update=" + column.getUpdated());
        }
      }
    
      public static void main(String[] args) throws Exception {
        // hostname, port, destination, username, password
        CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("127.0.0.1", 11111), "example", "", "");
        try {
          connector.connect();
          // 监听的表，格式为数据库.表名,数据库.表名
          connector.subscribe(".*\\..*");
          connector.rollback();
    
          while (true) {
            Message message = connector.getWithoutAck(100); // 获取指定数量的数据
            long batchId = message.getId();
            if (batchId == -1 || message.getEntries().isEmpty()) {
              Thread.sleep(1000);
              continue;
            }
            // System.out.println(message.getEntries());
            printEntries(message.getEntries());
            connector.ack(batchId); // 提交确认，消费成功，通知server删除数据
            // connector.rollback(batchId);// 处理失败, 回滚数据，后续重新获取数据
          }
        } catch (Exception e) {
          System.out.println("Something Error.");
        } finally {
          connector.disconnect();
        }
      }
    }
    复制代码

### 测试 ###

启动 `CanalClient.java`；

修改本地数据库内容之后，控制台成功监听并报告更新信息。

![format_png 3][]

### FAQ ###

#### Canal 监听不到 MySQL 变化 ####

#### CanalEntry 获取不到 RowData ####

是 MySQL 5.X 版本的原因，建议升级 MySQL 为 8.X 版本。

[format_png]: https://img-blog.csdnimg.cn/img_convert/436257b6637c73a5b8bbf81973b4163b.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/b57ad963fda58949bf326f9bc1057ef1.webp?x-oss-process=image/format,png
[github.com_alibaba_can]: https://link.juejin.cn?target=https%3A%2F%2Fgithub.com%2Falibaba%2Fcanal%2Freleases%2Ftag%2Fcanal-1.1.5
[blog.csdn.net_zhou12314_a]: https://link.juejin.cn?target=https%3A%2F%2Fblog.csdn.net%2Fzhou12314%2Farticle%2Fdetails%2F86365567
[www.cnblogs.com_zpan2019_p]: https://link.juejin.cn?target=https%3A%2F%2Fwww.cnblogs.com%2Fzpan2019%2Fp%2F13563593.html
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/d47219a38e58769f6b0d0b24816b7ca7.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/7075cabecc1172ecd5e5fb5c734bd32f.webp?x-oss-process=image/format,png