Canal--服务端和客户端搭建

服务端

源码编译

git clone https://github.com/alibaba/canal.git

用IDEA打开克隆的项目

等待maven下载完依赖后开始编译过程

依赖下载完成后,打开maven选项卡,把Profiles改为release

找到root pom项

选择下面的lifecycle-->install开始编译:

可以看到编译已经开始了:

看到如下输出代表编译完成

编译完成后在target下面会看到如下的压缩包:

其中我们需要的是canal.deployer-1.1.5-SNAPSHOT.tar.gz这个压缩包,这个是canal服务端部署的项目。

部署和运行

部署和运行比较简单,只需机器上有java8环境即可,windows或linux都需要先解压缩canal.deployer-1.1.5-SNAPSHOT.tar.gz,然后修改配置文件中的数据库连接地址和数据库用户名密码,需要相应的权限。

准备

对于自建 MySQL , 需要先开启 Binlog 写入功能，配置 binlog-format 为 ROW 模式，my.cnf 中配置如下

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

注意：针对阿里云 RDS for MySQL , 默认打开了 binlog , 并且账号默认具有 binlog dump 权限 , 不需要任何权限或者 binlog 设置,可以直接跳过这一步

授权 canal 链接 MySQL 账号具有作为 MySQL slave 的权限, 如果已有账户可直接 grant

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

FLUSH PRIVILEGES;

修改配置文件

在canal.deployer-1.1.5-SNAPSHOT/conf/example/instance.properties中做如下修改:

运行服务端

Windows直接运行bin目录下的startup.bat即可启动canal服务端

Linux保证startup.sh有执行权限之后直接运行./startup.sh即可

客户端

Java客户端

用IDEA新建一个maven项目,并在pom.xml中加入如下配置项:

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

等待maven下载完成后在项目中新建一个SimpleCanalClientExample类(ip和端口改为你自己的服务端ip端口),内容如下:

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("================> 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("-------> before");
                    printColumn(rowData.getBeforeColumnsList());
                    System.out.println("-------> 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());
        }
    }

}

运行此类中的main方法,然后在目标数据库修改数据:

会在控制台看到如下输出:

插入数据:

insert into student values(1,'闫绍帅',23,1,'备注');

修改数据:

update student set name='yanshaoshuai' where id=1;

删除数据:

delete from student where id=1;

PHP客户端

PHP版本采用5.6版本,在在命令行执行composer命令:

composer require xingwenge/canal_php

待命令执行完成后会发现所在目录下会下载了很多文件:

用phpstom打开所在文件夹,修改vendor\xingwenge\canal_php\src\sample\client.php文件

require要修改保证你能引用到自动加载的php文件,地址端口配置成你的服务端信息。然后运行此文件

可在控制台看到如下输出:

插入:

insert into student values(1,'闫绍帅',23,1,'备注');

修改:

update student set name='yanshaoshuai' where id=1;

删除:

delete from student where id=1;

事件类型定义:

/** 事件类型 **/
enum EventType {
   EVENTTYPECOMPATIBLEPROTO2 = 0;
    INSERT        =     1;
    UPDATE        =     2;
    DELETE        =     3;
    CREATE    =     4;
    ALTER     =     5;
    ERASE     =     6;
    QUERY     =     7;
    TRUNCATE   =     8;
    RENAME        =     9;
    /**CREATE INDEX**/
    CINDEX    =     10;
    DINDEX        =     11;
    GTID        =       12;
    /** XA **/
    XACOMMIT    =       13;
    XAROLLBACK  =     14;
    /** MASTER HEARTBEAT **/
    MHEARTBEAT  =       15;
}