Canal实现MySQL数据实时同步

时间：2023-02-13 19:03:33


Canal实现MySQL数据实时同步

  • ​​1、canal简介​​
  • ​​2、工作原理​​
  • ​​3、Canal环境搭建​​
  • ​​2.1 检查binlog功能是否开启​​
  • ​​2.2 开启binlog功能​​
  • ​​2.2.1 修改mysql的配置文件my.cnf​​
  • ​​2.2.2 重启mysql​​
  • ​​2.2.3 再次登录mysql客户端，查看log_bin变量​​
  • ​​2.3 在mysql里面添加以下的相关用户和权限​​
  • ​​4、下载安装Canal服务​​
  • ​​4.1 下载之后，放到目录中，解压文件​​
  • ​​4.2 修改配置文件​​
  • ​​4.3 进入bin目录下启动​​
  • ​​5、代码整合​​
  • ​​5.1 创建canal_client模块​​
  • ​​5.2 引入相关依赖​​
  • ​​5.3 创建application.properties配置文件​​
  • ​​5.4 编写canal客户端类​​
  • ​​5.5 创建启动类​​
  • ​​5.6 测试​​

1、canal简介

Canal实现MySQL数据实时同步

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

2、工作原理

Canal实现MySQL数据实时同步

  • 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 流)

我自己的应用场景是在统计分析功能中，采用了微服务调用的方式获取统计数据，但是这样耦合度很高，效率相对较低，我现在采用Canal数据库同步工具，通过实时同步数据库的方式实现，例如我们要统计每天注册与登录人数，我们只需要把会员表同步到统计库中，实现本地统计就可以了，这样效率更高，耦合度更低。
Canal是阿里巴巴旗下的一款开源项目，纯Java开发。基于数据库增量日志解析，提供增量数据订阅&消费。

3、Canal环境搭建

canal的原理是基于mysql binlog技术，所以这里要开启mysql的binlog写入功能
在linux系统中，开启mysql服务：​​​systemctl start mysqld​​​或者​​service mysql start​​

2.1 检查binlog功能是否开启

Canal实现MySQL数据实时同步

2.2 开启binlog功能

如果显示状态为OFF表示该功能尚未开启，开启binlog功能

2.2.1 修改mysql的配置文件my.cnf

vim /etc/my.cnf

追加内容：

log-bin=mysql-bin     #binlog文件名
binlog_format=ROW     #选择row模式
server_id=1           #mysql实例id,不能和canal的slaveId重复

Canal实现MySQL数据实时同步

2.2.2 重启mysql

systemctl restart mysqld

或者​​service mysql restart​​

2.2.3 再次登录mysql客户端，查看log_bin变量

Canal实现MySQL数据实时同步


显示为ON表示该功能已开启。

2.3 在mysql里面添加以下的相关用户和权限

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

这其实是添加了能远程访问mysql数据库的用户，账号和密码都是canal,由于我的虚拟机本来就添加过root用户，这里我就不再添加这个canal了，你根据自己情况。

4、下载安装Canal服务

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

4.1 下载之后，放到目录中，解压文件

Canal实现MySQL数据实时同步


我上传到了/opt目录下，现在我将它解压到​​/usr/local/canal​​目录下，

tar zxvf canal.deployer-1.1.4.tar.gz -C /usr/local/canal/

Canal实现MySQL数据实时同步

4.2 修改配置文件

先进入canal所在目录，再修改配置文件

vim conf/example/instance.properties

Canal实现MySQL数据实时同步


Canal实现MySQL数据实时同步

注： mysql 数据解析关注的表，Perl正则表达式. 多个正则之间以逗号(,)分隔，转义符需要双斜杠(\) 常见例子：

  1. 所有表：​​.* or .*\\..*​​
  2. canal schema下所有表： ​​canal\\..*​​
  3. canal下的以canal打头的表：​​canal\\.canal.*​​
  4. canal schema下的一张表：​​canal.test1​​
  5. 多个规则组合使用：​​canal\\..*,mysql.test1,mysql.test2​​​ (逗号分隔) 注意：此过滤条件只针对row模式的数据有效(ps.
    mixed/statement因为不解析sql，所以无法准确提取tableName进行过滤)

4.3 进入bin目录下启动

./startup.sh

Canal实现MySQL数据实时同步

5、代码整合

5.1 创建canal_client模块

我的项目是个微服务项目，比较大，你就只关注canal_clientedu这一个模块即可。

Canal实现MySQL数据实时同步

5.2 引入相关依赖

没指定版本号是因为在父项目中已经指定过了。

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!--mysql-->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>

    <dependency>
        <groupId>commons-dbutils</groupId>
        <artifactId>commons-dbutils</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-jdbc</artifactId>
    </dependency>

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

5.3 创建application.properties配置文件

# 服务端口
server.port=10000
# 服务名
spring.application.name=canal-client

# 环境设置：dev、test、prod
spring.profiles.active=dev

# mysql数据库连接
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/guli?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

5.4 编写canal客户端类

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 com.google.protobuf.InvalidProtocolBufferException;
import org.apache.commons.dbutils.DbUtils;
import org.apache.commons.dbutils.QueryRunner;
import org.springframework.stereotype.Component;

import javax.annotation.Resource;
import javax.sql.DataSource;
import java.net.InetSocketAddress;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.Iterator;
import java.util.List;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedQueue;

@Component
public class CanalClient {

    //sql队列
    private Queue<String> SQL_QUEUE = new ConcurrentLinkedQueue<>();

    @Resource
    private DataSource dataSource;

    /**
     * canal入库方法
     */
    public void run() {

        CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("192.168.159.33",
                11111), "example", "", "");
        int batchSize = 1000;
        try {
            connector.connect();
            connector.subscribe(".*\\..*");
            connector.rollback();
            try {
                while (true) {
                    //尝试从master那边拉去数据batchSize条记录，有多少取多少
                    Message message = connector.getWithoutAck(batchSize);
                    long batchId = message.getId();
                    int size = message.getEntries().size();
                    if (batchId == -1 || size == 0) {
                        Thread.sleep(1000);
                    } else {
                        dataHandle(message.getEntries());
                    }
                    connector.ack(batchId);

                    //当队列里面堆积的sql大于一定数值的时候就模拟执行
                    if (SQL_QUEUE.size() >= 1) {
                        executeQueueSql();
                    }
                }
            } catch (InterruptedException e) {
                e.printStackTrace();
            } catch (InvalidProtocolBufferException e) {
                e.printStackTrace();
            }
        } finally {
            connector.disconnect();
        }
    }

    /**
     * 模拟执行队列里面的sql语句
     */
    public void executeQueueSql() {
        int size = SQL_QUEUE.size();
        for (int i = 0; i < size; i++) {
            String sql = SQL_QUEUE.poll();
            System.out.println("[sql]----> " + sql);

            this.execute(sql.toString());
        }
    }

    /**
     * 数据处理
     *
     * @param entrys
     */
    private void dataHandle(List<Entry> entrys) throws InvalidProtocolBufferException {
        for (Entry entry : entrys) {
            if (EntryType.ROWDATA == entry.getEntryType()) {
                RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
                EventType eventType = rowChange.getEventType();
                if (eventType == EventType.DELETE) {
                    saveDeleteSql(entry);
                } else if (eventType == EventType.UPDATE) {
                    saveUpdateSql(entry);
                } else if (eventType == EventType.INSERT) {
                    saveInsertSql(entry);
                }
            }
        }
    }

    /**
     * 保存更新语句
     *
     * @param entry
     */
    private void saveUpdateSql(Entry entry) {
        try {
            RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
            List<RowData> rowDatasList = rowChange.getRowDatasList();
            for (RowData rowData : rowDatasList) {
                List<Column> newColumnList = rowData.getAfterColumnsList();
                StringBuffer sql = new StringBuffer("update " + entry.getHeader().getTableName() + " set ");
                for (int i = 0; i < newColumnList.size(); i++) {
                    sql.append(" " + newColumnList.get(i).getName()
                            + " = '" + newColumnList.get(i).getValue() + "'");
                    if (i != newColumnList.size() - 1) {
                        sql.append(",");
                    }
                }
                sql.append(" where ");
                List<Column> oldColumnList = rowData.getBeforeColumnsList();
                for (Column column : oldColumnList) {
                    if (column.getIsKey()) {
                        //暂时只支持单一主键
                        sql.append(column.getName() + "=" + column.getValue());
                        break;
                    }
                }
                SQL_QUEUE.add(sql.toString());
            }
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }
    }

    /**
     * 保存删除语句
     *
     * @param entry
     */
    private void saveDeleteSql(Entry entry) {
        try {
            RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
            List<RowData> rowDatasList = rowChange.getRowDatasList();
            for (RowData rowData : rowDatasList) {
                List<Column> columnList = rowData.getBeforeColumnsList();
                StringBuffer sql = new StringBuffer("delete from " + entry.getHeader().getTableName() + " where ");
                for (Column column : columnList) {
                    if (column.getIsKey()) {
                        //暂时只支持单一主键
                        sql.append(column.getName() + "=" + column.getValue());
                        break;
                    }
                }
                SQL_QUEUE.add(sql.toString());
            }
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }
    }

    /**
     * 保存插入语句
     *
     * @param entry
     */
    private void saveInsertSql(Entry entry) {
        try {
            RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
            List<RowData> rowDatasList = rowChange.getRowDatasList();
            for (RowData rowData : rowDatasList) {
                List<Column> columnList = rowData.getAfterColumnsList();
                StringBuffer sql = new StringBuffer("insert into " + entry.getHeader().getTableName() + " (");
                for (int i = 0; i < columnList.size(); i++) {
                    sql.append(columnList.get(i).getName());
                    if (i != columnList.size() - 1) {
                        sql.append(",");
                    }
                }
                sql.append(") VALUES (");
                for (int i = 0; i < columnList.size(); i++) {
                    sql.append("'" + columnList.get(i).getValue() + "'");
                    if (i != columnList.size() - 1) {
                        sql.append(",");
                    }
                }
                sql.append(")");
                SQL_QUEUE.add(sql.toString());
            }
        } catch (InvalidProtocolBufferException e) {
            e.printStackTrace();
        }
    }

    /**
     * 入库
     * @param sql
     */
    public void execute(String sql) {
        Connection con = null;
        try {
            if(null == sql) return;
            con = dataSource.getConnection();
            QueryRunner qr = new QueryRunner();
            int row = qr.execute(con, sql);
            System.out.println("update: "+ row);
        } catch (SQLException e) {
            e.printStackTrace();
        } finally {
            DbUtils.closeQuietly(con);
        }
    }
}

这个地方的ip你改成你自己虚拟机或者服务器上的。

Canal实现MySQL数据实时同步

5.5 创建启动类

@SpringBootApplication
public class CanalApplication implements CommandLineRunner {
    @Resource
    private CanalClient canalClient;

    public static void main(String[] args) {
        SpringApplication.run(CanalApplication.class, args);
    }

    @Override
    public void run(String... strings) throws Exception {
        //项目启动，执行canal客户端监听
        canalClient.run();
    }
}

5.6 测试

数据同步的前提是远程linux系统和本地windows系统的数据库和数据表的名称和结构要完全一样。
我的表结构

CREATE TABLE `members` (
  `id` int(11) NOT NULL,
  `username` varchar(100) DEFAULT NULL,
  `age` int(11) DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

测试之前需要

在linux系统中插入一条数据测试

Canal实现MySQL数据实时同步


看本地控制台

Canal实现MySQL数据实时同步


在Linux中更新以下上面那条数据

Canal实现MySQL数据实时同步


看本地控制台

Canal实现MySQL数据实时同步


看下本地windows的mysql数据库表中数据是否和linux上面的数据一致

Canal实现MySQL数据实时同步

数据完全一致，没有任何的问题


标签：

相关文章