gemini / php-mysql-replication
MySQL复制协议的纯PHP实现。这允许您接收诸如插入、更新、删除等事件及其数据和原始SQL查询。
Requires
- php: >=7.3
- ext-bcmath: *
- ext-json: *
- ext-sockets: *
- doctrine/collections: ^1.3
- doctrine/dbal: ^3.0
- psr/simple-cache: ^1.0
- symfony/dependency-injection: ^3.1|^4.0|^5.0
- symfony/event-dispatcher: ^3.1|^4.0|^5.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^2.18
- phpstan/phpstan: ^0.12.68
- phpunit/phpunit: ^9.0
Replaces
README
MySQL复制协议的纯PHP实现。这允许您接收诸如插入、更新、删除等事件及其数据和原始SQL查询。
基于以下创作者的优秀作品:https://github.com/noplay/python-mysql-replication 和 https://github.com/fengxiangyun/mysql-replication
从 krowinski 分支
安装
在您的项目中
composer require gemini/php-mysql-replication
或独立使用
git clone https://github.com/gemini/php-mysql-replication.git composer install -o
兼容性(基于集成测试)
- mysql 5.5
- mysql 5.6
- mysql 5.7
- mysql 8.0(仅限mysql_native_password)
- mariadb 5.5
- mariadb 10.0
- mariadb 10.1
- 可能是基于原生MySQL的percona版本
MySQL服务器设置
在您的MySQL服务器配置文件中,您需要启用复制
[mysqld]
server-id = 1
log_bin = /var/log/mysql/mysql-bin.log
expire_logs_days = 10
max_binlog_size = 100M
binlog-format = row #Very important if you want to receive write, update and delete row events
MySQL复制事件说明 https://dev.mysqlserver.cn/doc/internals/en/event-meanings.html
MySQL用户权限
GRANT REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'user'@'host';
GRANT SELECT ON `dbName`.* TO 'user'@'host';
配置
使用ConfigBuilder或ConfigFactory创建配置。可用选项
'user' - 您的MySQL用户(必填)
'ip'或'host' - 您的MySQL主机/ip(必填)
'password' - 您的MySQL密码(必填)
'port' - 您的MySQL主机端口(默认3306)
'charset' - 数据库连接字符集(默认utf8)
'gtid' - 从中开始复制的GTID标记(格式9b1c8d18-2a76-11e5-a26b-000c2976f3f3:1-177592)
'mariaDbGtid' - 从中开始复制的MariaDB GTID标记(格式1-1-3,0-1-88)
'slaveId' - 用于标识的脚本奴隶ID(SHOW SLAVE HOSTS)
'binLogFileName' - 从中开始复制的二进制日志文件名
'binLogPosition' - 从中开始复制的位置
'eventsOnly' - 要监听的事件数组(完整列表在ConstEventType.php文件中)
'eventsIgnore' - 要忽略的事件数组(完整列表在ConstEventType.php文件中)
'tablesOnly' - 只监听给定表的数组(默认所有表)
'databasesOnly' - 只监听给定数据库的数组(默认所有数据库)
'tableCacheSize' - 一些数据是从信息模式中收集的,这些数据被缓存。
'custom' - 如果必须在扩展/实现的自己的类中设置一些参数
'heartbeatPeriod' - 设置复制心跳之间的秒间隔。每当主机的二进制日志被更新为事件时,下一次心跳的等待期被重置。间隔是一个范围从0到4294967的十进制值,以毫秒为单位;最小非零值是0.001。只有在二进制日志文件中存在未发送事件超过间隔的时间段时,主机才会发送心跳。
类似的项目
Ruby: https://github.com/y310/kodama
Java: https://github.com/shyiko/mysql-binlog-connector-java
GO: https://github.com/siddontang/go-mysql
Python: https://github.com/noplay/python-mysql-replication
.NET: https://github.com/rusuly/MySqlCdc
示例
所有示例都可在示例目录中找到
此示例将所有复制事件输出到控制台
请记得根据您的用户、主机和密码更改配置
用户应具有复制权限 [ REPLICATION CLIENT, SELECT]
php example/dump_events.php
对于测试 SQL 事件
CREATE DATABASE php_mysql_replication; use php_mysql_replication; CREATE TABLE test4 (id int NOT NULL AUTO_INCREMENT, data VARCHAR(255), data2 VARCHAR(255), PRIMARY KEY(id)); INSERT INTO test4 (data,data2) VALUES ("Hello", "World"); UPDATE test4 SET data = "World", data2="Hello" WHERE id = 1; DELETE FROM test4 WHERE id = 1;
输出将类似于以下内容(取决于配置,例如 GTID 开/关)
=== Event format description ===
Date: 2017-07-06T13:31:11+00:00
Log position: 0
Event size: 116
Memory usage 2.4 MB
=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803092
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13675
Memory usage 2.42 MB
=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803237
Event size: 145
Database: php_mysql_replication
Execution time: 0
Query: CREATE DATABASE php_mysql_replication
Memory usage 2.45 MB
=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803285
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13676
Memory usage 2.45 MB
=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803500
Event size: 215
Database: php_mysql_replication
Execution time: 0
Query: CREATE TABLE test4 (id int NOT NULL AUTO_INCREMENT, data VARCHAR(255), data2 VARCHAR(255), PRIMARY KEY(id))
Memory usage 2.45 MB
=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803548
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13677
Memory usage 2.45 MB
=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803637
Event size: 89
Database: php_mysql_replication
Execution time: 0
Query: BEGIN
Memory usage 2.45 MB
=== Event tableMap ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803708
Event size: 71
Table: test4
Database: php_mysql_replication
Table Id: 866
Columns amount: 3
Memory usage 2.71 MB
=== Event write ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803762
Event size: 54
Table: test4
Affected columns: 3
Changed rows: 1
Values: Array
(
[0] => Array
(
[id] => 1
[data] => Hello
[data2] => World
)
)
Memory usage 2.74 MB
=== Event xid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803793
Event size: 31
Transaction ID: 662802
Memory usage 2.75 MB
=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803841
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13678
Memory usage 2.75 MB
=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57803930
Event size: 89
Database: php_mysql_replication
Execution time: 0
Query: BEGIN
Memory usage 2.76 MB
=== Event tableMap ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804001
Event size: 71
Table: test4
Database: php_mysql_replication
Table Id: 866
Columns amount: 3
Memory usage 2.75 MB
=== Event update ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804075
Event size: 74
Table: test4
Affected columns: 3
Changed rows: 1
Values: Array
(
[0] => Array
(
[before] => Array
(
[id] => 1
[data] => Hello
[data2] => World
)
[after] => Array
(
[id] => 1
[data] => World
[data2] => Hello
)
)
)
Memory usage 2.76 MB
=== Event xid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804106
Event size: 31
Transaction ID: 662803
Memory usage 2.76 MB
=== Event gtid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804154
Event size: 48
Commit: true
GTID NEXT: 3403c535-624f-11e7-9940-0800275713ee:13679
Memory usage 2.76 MB
=== Event query ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804243
Event size: 89
Database: php_mysql_replication
Execution time: 0
Query: BEGIN
Memory usage 2.76 MB
=== Event tableMap ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804314
Event size: 71
Table: test4
Database: php_mysql_replication
Table Id: 866
Columns amount: 3
Memory usage 2.76 MB
=== Event delete ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804368
Event size: 54
Table: test4
Affected columns: 3
Changed rows: 1
Values: Array
(
[0] => Array
(
[id] => 1
[data] => World
[data2] => Hello
)
)
Memory usage 2.77 MB
=== Event xid ===
Date: 2017-07-06T15:23:44+00:00
Log position: 57804399
Event size: 31
Transaction ID: 662804
Memory usage 2.77 MB
基准测试
在虚拟机上测试过
Debian 8.7
PHP 5.6.30
Percona 5.6.35
inxi
CPU(s)~4 Single core Intel Core i5-2500Ks (-SMP-) clocked at 5901 Mhz Kernel~3.16.0-4-amd64 x86_64 Up~1 day Mem~1340.3/1996.9MB HDD~41.9GB(27.7% used) Procs~122 Client~Shell inxi~2.1.28
php example/benchmark.php
Start insert data
7442 event by seconds (1000 total)
7679 event by seconds (2000 total)
7914 event by seconds (3000 total)
7904 event by seconds (4000 total)
7965 event by seconds (5000 total)
8006 event by seconds (6000 total)
8048 event by seconds (7000 total)
8038 event by seconds (8000 total)
8040 event by seconds (9000 total)
8055 event by seconds (10000 total)
8058 event by seconds (11000 total)
8071 event by seconds (12000 total)
常见问题解答(FAQ)
首先,MySQL 不提供异步调用。您通常需要在应用程序中编程此功能(通过事件调度并将它们添加到某个队列系统中)。如果您的数据库有多个入口点,例如 Web、后端和其他微服务,则向所有这些添加处理并不总是便宜的。但是,使用 MySQL 复制协议,您可以对写事件进行监听并异步处理(最佳组合是将其添加到某个队列系统,如 rabbitmq、redis 或 kafka)。它还适用于缓存失效、搜索引擎复制、实时分析和审计。
首先,您需要知道,可能会通过很多事件,例如,如果您更新表 "bar" 中的 1,000,000 条记录,并且您需要从表 "foo" 中的这一条插入,那么所有这些都必须由脚本处理,您需要等待数据。这是正常的,这就是它的工作方式。您可以使用配置选项来加快速度。另外,如果脚本崩溃,您需要不时地保存从 binlog(或 gtid)的位置,以便在再次运行此脚本时从该位置开始,以避免重复。
就像我在第 1 点提到的,使用 rabbitmq、redis 或 kafka 等队列系统,它们将让您能够以多个脚本来处理数据。
创建一个问题,我会在空闲时间尝试解决它 :)
它就像任何其他 MySQL 从机一样工作,并产生相同的开销。
为了解决这个问题,最好是将数据库配置中的 "net_read_timeout" 和 "net_write_timeout" 增加到 3600。(感谢 Bijimon)
在 my.conf 中设置 binlog_row_image=full
以修复仅接收部分更新的问题。
在 my.conf 中设置 log_slave_updates=on
以修复此问题 (#71)(#66)