README

一.canal-php 简介

canal-php 是阿里巴巴开源项目 Canal的PHP客户端，用于MySQL数据库binlog的增量订阅和消费。为PHP开发者提供了一个更友好的Canal使用方式。Canal是MySQL数据库binlog的增量订阅和消费组件。

基于日志增量订阅和消费支持的业务：

数据库镜像
数据库实时备份
多级索引（卖家和买家各自分库索引）
搜索构建
业务缓存刷新
价格变化等重要业务消息

关于Canal的更多信息，请访问 https://github.com/alibaba/canal/wiki

二.应用场景

canal-php 作为Canal的客户端，其应用场景就是Canal的应用场景。关于应用场景在Canal介绍一节已有概述。举一些实际的使用例子：

1.替代使用轮询数据库方式来监控数据库变更，有效改善轮询消耗数据库资源。

2.根据数据库的变更实时更新搜索引擎，比如电商场景下商品信息发生变更，实时同步到商品搜索引擎Elasticsearch、solr等。

3.根据数据库的变更实时更新缓存，比如电商场景下商品价格、库存发生变更实时同步到redis。

4.数据库异地备份、数据同步

5.根据数据库变更触发某种业务，比如电商场景下，创建订单超过xx时间未支付被自动取消，我们获取到这条订单数据的状态变更即可向用户推送消息。

6.将数据库变更整理成自己的数据格式发送到kafka等消息队列，供消息队列的消费者进行消费。

三.工作原理

canal-php 是Canal的PHP客户端，它与Canal通过Socket进行通信，传输协议是TCP，交互协议采用的是Google Protocol Buffer 3.0。

四.工作流程

1.Canal连接到MySQL数据库，模拟slave。

2.canal-php 与Canal建立连接。

3.数据库发生变更写入到binlog。

4.Canal向数据库发送dump请求，获取binlog并解析。

5.canal-php 向Canal请求数据库变更。

6.Canal发送解析后的数据给canal-php。

7.canal-php收到数据，消费成功，发送回执。（可选）

8.Canal记录消费位置。

五.快速启动

安装Canal

Canal的安装以及配置使用请查看 https://github.com/alibaba/canal/wiki/QuickStart

构建canal php客户端

$ composer require xingwenge/canal_php

or

$ git clone https://github.com/xingwenge/canal-php.git
$ cd canal-php
$ composer update

建立与Canal的连接

try {
    $client = CanalConnectorFactory::createClient(CanalClient::TYPE_SOCKET_CLUE);
    # $client = CanalConnectorFactory::createClient(CanalClient::TYPE_SWOOLE);

    $client->connect("127.0.0.1", 11111);
    $client->checkValid();
    $client->subscribe("1001", "example", ".*\\..*");
    # $client->subscribe("1001", "example", "db_name.tb_name"); # 设置过滤

    while (true) {
        $message = $client->get(100);
        if ($entries = $message->getEntries()) {
            foreach ($entries as $entry) {
                Fmt::println($entry);
            }
        }
        sleep(1);
    }

    $client->disConnect();
} catch (\Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

更多详情请查看 Sample

性能

本地开发环境

消费速度：sql insert 10000 事件，32秒消耗完成。消费速度 312.5 条/s。

内存使用：4 M。

bain2018 / canal

维护者

详细信息