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;
}