简介

go-mysql-transfer是一款MySQL数据库实时增量同步工具。能够监听MySQL二进制日志(Binlog)的变动，将变更内容形成指定格式的消息，实时发送到接收端。从而在数据库和接收端之间形成一个高性能、低延迟的增量数据同步更新管道。

特性

1、简单，不依赖其它组件，一键部署

2、集成多种接收端，如：Redis、MongoDB、Elasticsearch、RocketMQ、Kafka、RabbitMQ、HTTP API等，无需编写客户端，开箱即用

3、内置丰富的数据解析、消息生成规则、模板语法

4、支持Lua脚本扩展，可处理复杂逻辑

5、集成Prometheus客户端，支持监控告警

6、集成Web Admin监控页面

7、支持高可用集群部署

8、数据同步失败重试

9、支持全量数据初始化

开源

github：go-mysql-transfer

如果此工具对你有帮助，请在github中Star支持下

安装运行

您可以直接下载编译好的安装包: 点击下载

最新版本：v1.0.3 release

也可以自行编译：

1、依赖Golang 1.14 及以上版本

2、设置 ' GO111MODULE=on '

3、拉取源码 ' git clone https://github.com/wj596/go-mysql-transfer.git '

4、进入目录，执行 ' go build '编译

运行

1、开启MySQL的binlog

#Linux在my.cnf文件
#Windows在my.ini文件
log-bin=mysql-bin # 开启 binlog
binlog-format=ROW # 选择 ROW 模式
server_id=1 # 配置 MySQL replaction 需要定义，不要和 go-mysql-transfer 的 slave_id 重复

2、修改app.yml
3、命令行运行
Windows直接运行 go-mysql-transfer.exe
Linux执行 nohup go-mysql-transfer &

docker运行

基于源码构建镜像

1、拉取源码 ' git clone https://github.com/wj596/go-mysql-transfer.git '
2、修改配置文件 ' app.yml ' 中相关配置
3、构建镜像 ' docker image build -t go-mysql-transfer -f Dockerfile . '
4、运行 ' docker run -d --name go-mysql-transfer -p 8060:8060 go-mysql-transfer:latest '

基于二进制可执行文件构建镜像

1、下载编译好的安装包: 点击下载
2、解压，并修改配置文件 ' app.yml ' 中相关配置
3、构建镜像 ' docker image build -t go-mysql-transfer -f Dockerfile . '
4、运行 ' docker run -d --name go-mysql-transfer -p 8060:8060 go-mysql-transfer:latest '

Redis配置

相关配置如下：

# app.yml
redis_addrs: 127.0.0.1:6379 #地址，多个用逗号分隔
#redis_group_type: cluster   # 集群类型 sentinel或者cluster
#redis_master_name: mymaster # Master节点名称,如果group_type为sentinel则此项不能为空，为cluster此项无效
#redis_pass: 123456 #redis密码
#redis_database: 0  #redis数据库 0-16,默认0。如果group_type为cluster此项无效

支持Redis部署模式：单机、主从(哨兵)、集群(cluster)

基于规则同步

同步规则配置如下：

rule:
  -
    schema: eseap #数据库名称
    table: t_user #表名称
    #order_by_column: id #排序字段，存量数据同步时不能为空
    #column_lower_case:false #列名称转为小写,默认为false
    #column_upper_case:false#列名称转为大写,默认为false
    column_underscore_to_camel: true #列名称下划线转驼峰,默认为false
    # 包含的列，多值逗号分隔，如：id,name,age,area_id  为空时表示包含全部列
    #include_columns: ID,USER_NAME,PASSWORD
    #exclude_columns: BIRTHDAY,MOBIE # 排除掉的列，多值逗号分隔，如：id,name,age,area_id  默认为空
    #column_mappings: CARD_NO=sfz #列名称映射，多个映射关系用逗号分隔，如：USER_NAME=account 表示将字段名USER_NAME映射为account
    #default_column_values: source=binlog,area_name=合肥  #默认的列-值，多个用逗号分隔，如：source=binlog,area_name=合肥
    #date_formatter: yyyy-MM-dd #date类型格式化， 不填写默认yyyy-MM-dd
    #datetime_formatter: yyyy-MM-dd HH:mm:ss #datetime、timestamp类型格式化，不填写默认yyyy-MM-dd HH:mm:ss
    #lua_file_path: lua/t_user.lua   #lua脚本文件，详见使用手册，当此值不为空时后面的配置除redis_structure其余均无效
    #lua_script:   #lua 脚本，详见使用手册，当此值不为空时后面的配置均无效
    value_encoder: json  #值编码，支持json、kv-commas、v-commas；默认为json
    #value_formatter: '{{.ID}}|{{.USER_NAME}}|{{.REAL_NAME}}|{{if eq .STATUS 0}}停用{{else}}启用{{end}}'
    #redis相关
    redis_structure: string # 数据类型。 支持string、hash、list、set、sortedset类型(与redis的数据类型一致)
    redis_key_prefix: USER_ #key的前缀
    redis_key_column: USER_NAME #使用哪个列的值作为key，不填写默认使用主键
    #redis_key_formatter: '{{.ID}}|{{.USER_NAME}}'
    #redis_key_value: user #KEY的值（固定值）；当redis_structure为hash、list、set、sortedset此值不能为空
    #redis_hash_field_prefix: _CARD_ #hash的field前缀，仅redis_structure为hash时起作用
    #redis_hash_field_column: Cert_No #使用哪个列的值作为hash的field，仅redis_structure为hash时起作用，不填写默认使用主键

其中,
value_encoder表示值编码格式，支持json、kv-commas、v-commas三种格式，不填写默认为json，具体如下表：

json：格式如：{"id": "1001","userName": "admin","password": "123456", "createTime": "2020-07-20 14:29:19"}
kv-commas：key-value逗号分隔。格式如：id=1001,userName=admin,password=123456,createTime=2020-07-20 14:29:19
v-commas：value逗号分隔，格式如：1001,admin,123456,2020-07-20 14:29:19

value_formatter表示值的格式化表达式，当value_formatter不为空时value_encoder无效。 redis_key_formatter表示KEY的格式化表达式。

同步数据为string类型

t_user表，数据如下：

配置如下：

    schema: eseap #数据库名称
    table: t_user #表名称
    column_underscore_to_camel: true #列名称下划线转驼峰,默认为false
    value_encoder: json  #值编码
    redis_structure: string # 数据类型。 支持string、hash、list、set、sortedset类型(与redis的数据类型一致)
    redis_key_prefix: USER_ #key的前缀
    redis_key_column: USER_NAME #使用哪个列的值作为key，不填写默认使用主键

同步到Redis的数据如下：

同步数据为list类型

t_user表，数据如下：

配置如下：

    value_formatter: '{{.ID}}|{{.USER_NAME}}' # 值格式化表达式，如：{{.ID}}|{{.USER_NAME}},{{.ID}}表示ID字段的值、{{.USER_NAME}}表示USER_NAME字段的值
    redis_structure: list 
    redis_key_value: user_list #key的值（固定值）；当redis_structure为hash、list、set、sortedset此值不能为空

同步到Redis的数据如下：

同步为set类型

t_user表，数据如下：

配置如下：

    value_formatter: '{{.ID}}|{{.USER_NAME}}' # 值格式化表达式，如：{{.ID}}|{{.USER_NAME}},{{.ID}}表示ID字段的值、{{.USER_NAME}}表示USER_NAME字段的值
    redis_structure: set
    redis_key_value: user_set #key的值（固定值）；当redis_structure为hash、list、set、sortedset此值不能为空

同步到Redis的数据如下：

同步数据为order set类型

t_user表，数据如下：

配置如下：

    value_formatter: '{{.ID}}|{{.USER_NAME}}' # 值格式化表达式，如：{{.ID}}|{{.USER_NAME}},{{.ID}}表示ID字段的值、{{.USER_NAME}}表示USER_NAME字段的值
    redis_structure: sortedset
    redis_key_value: users #key的值（固定值）；当redis_structure为hash、list、set、sortedset此值不能为空
    redis_sorted_set_score_column: CREATE_TIME  #sortedset的score，当数据类型为sortedset时，此项不能为空，此项的值应为数字类型

同步到Redis的数据如下：

同步数据为hash类型

t_user表，数据如下：

配置如下：

    column_underscore_to_camel: true #列名称下划线转驼峰,默认为false
    value_encoder: json  #值编码，支持json、kv-commas、v-commas
    redis_structure: hash 
    redis_key_value: user_cache #key的值（固定值）；当redis_structure为hash、list、set、sortedset此值不能为空
    redis_hash_field_prefix: user_name_ #hash的field前缀，仅redis_structure为hash时起作用
    redis_hash_field_column: user_name #使用哪个列的值作为hash的field，仅redis_structure为hash时起作用，不填写默认使用主键

同步到Redis的数据如下：

使用规则能将一个table映射成为一个HASH，但如果需要将talbe中的每一行映射成一个HASH，可以使用Lua脚本实现，详请参见后续的示例。

基于Lua脚本同步

使用Lua脚本可以实现更复杂的数据处理逻辑，go-mysql-transfer支持Lua5.1语法

示例一

t_user表，数据如下：

Lua脚本：

-- t_user_redis.lua

local json = require("json")   -- 加载json模块
local ops = require("redisOps") --加载redis操作模块

local row = ops.rawRow()  --数据库当前变更的一行数据,table类型，key为列名称
local action = ops.rawAction()  --当前数据库事件,包括：insert、updare、delete

local id = row["ID"] --获取ID列的值
local userName = row["USER_NAME"] --获取USER_NAME列的值
local key = "user_"..id -- 定义key

if action == "delete" -- 删除事件
then
	ops.DEL(key) 
	ops.SREM("user_set",userName) 
else 
	local password = row["PASSWORD"] --获取USER_NAME列的值
	local createTime = row["CREATE_TIME"] --获取CREATE_TIME列的值
	local result = {}  -- 定义一个table
	result["id"] = id
	result["userName"] = userName
	result["password"] = password
	result["createTime"] = createTime
	result["source"] = "binlog" -- 数据来源
	local val = json.encode(result) -- 将newTable转为json
	ops.SET(key,val) -- 对应Redis的SET命令，第一个参数为key(支持string类型)，第二个参数为value
	
	if action == "update" -- 修改事件
	then
		local oldRow = ops.rawOldRow()  --数据库变更之前的数据(修改之前的数据)
		local oldUserName = oldRow["USER_NAME"] --获取USER_NAME列的值
		ops.SREM("user_set",oldUserName) -- 删除旧值
	end
	
	ops.SADD("user_set",userName) -- 对应Redis的SADD命令，第一个参数为key(支持string类型)，第二个参数为value
end

引入脚本：

rule:
  -
    schema: eseap
    table: t_user
    lua_file_path: lua/t_user_redis.lua   #lua脚本文件

同步到Redis的数据如下：

示例二，将talbe中的一行映射成一个HASH

Lua脚本如下：

-- t_user_redis2.lua

local ops = require("redisOps") --加载redis操作模块

local row = ops.rawRow()  --当前数据库的一行数据,table类型，key为列名称
local action = ops.rawAction()  --当前数据库事件,包括：insert、updare、delete

if action == "insert" -- 只监听insert事件
then
    local key = row["USER_NAME"] --获取USER_NAME列的值
   
    local id = row["ID"] --获取ID列的值
    local userName = row["USER_NAME"] --获取USER_NAME列的值
    local password = row["PASSWORD"] --获取PASSWORD列的值
    local createTime = row["CREATE_TIME"] --获取CREATE_TIME列的值
    
    ops.HSET(key,"id",id) -- 对应Redis的HSET命令
    ops.HSET(key,"userName",userName) -- 对应Redis的HSET命令
    ops.HSET(key,"password",password) -- 对应Redis的HSET命令
    ops.HSET(key,"createTime",createTime) -- 对应Redis的HSET命令
end

引入脚本：

rule:
  -
    schema: eseap
    table: t_user
    lua_file_path: lua/t_user_redis2.lua   #lua脚本文件

同步到Redis的数据如下：

RedisOps模块

redisOps模块提供了操作Redis的方法，如下：

SET: Redis字符串命令,设置指定key的值。如：ops.SET(key,val)
DEL: Redis字符串命令,删除指定key的值。如：ops.DEL(key)
HSET: Redishash命令,设置哈希表key中的字段field的值。如：ops.HSET(key,field,val)
HDEL: Redishash命令,设置哈希表key中的字段。如：ops.HDEL(key,field)
RPUSH: Redis列表命令,将值插入到列表key的头部。如：ops.RPUSH(key,val)
LREM: Redis列表命令,移除列表key的值。如：ops.LREM(key,val)
SADD: Redis集合命令,向集合key添加值。如：ops.SADD(key,val)
SREM: Redis集合命令,移除集合key的值。如：ops.SREM(key,val)
ZADD: Redis有序集合命令,向有序集合key添加值。如：ops.ZADD(key,score,val)
ZREM: Redis有序集合命令,移除有序集合key的值。如：ops.ZREM(key,val)