From aefbf4879cd5c136d8fceb7be7d88469fc3fd858 Mon Sep 17 00:00:00 2001 From: Zhiqiang Li Date: Tue, 3 Nov 2020 15:37:31 +0800 Subject: [PATCH] Update README.md --- README.md | 56 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index aea3ab6..fd9628c 100644 --- a/README.md +++ b/README.md @@ -1,45 +1,47 @@ # CanalSharp -## 重构进度 +## 閲嶆瀯杩涘害 -目前重构的版本已经完全覆盖旧版本，且性能更高，代码更优美，实现了旧版本未实现的部分功能。 +鐩墠閲嶆瀯鐨勭増鏈凡缁忓畬鍏ㄨ鐩栨棫鐗堟湰锛屼笖鎬ц兘鏇撮珮锛屼唬鐮佹洿浼樼編锛屽疄鐜颁簡鏃х増鏈湭瀹炵幇鐨勯儴鍒嗗姛鑳姐 English README.md Will be provided after the refactoring is complete. +鏃х増鏈唬鐮侊細https://github.com/dotnetcore/CanalSharp/tree/release/0.2.0 + | Task | Status | | ------------------- | ------ | -| protobuf 3 协议生成 | 已完成 | -| 对接 Canal | 已完成 | -| 数据订阅封装 | | -| 集群支持(热备) | | -| 数据发送到Kafka | | -| 数据发送到Redis | | +| protobuf 3 鍗忚鐢熸垚 | 宸插畬鎴 | +| 瀵规帴 Canal | 宸插畬鎴 | +| 鏁版嵁璁㈤槄灏佽 | | +| 闆嗙兢鏀寔(鐑) | | +| 鏁版嵁鍙戦佸埌Kafka | | +| 鏁版嵁鍙戦佸埌Redis | | -## 快速入门 +## 蹇熷叆闂 ->先决条件：安装Java环境和需要使用的数据库开启binlog +>鍏堝喅鏉′欢锛氬畨瑁匤ava鐜鍜岄渶瑕佷娇鐢ㄧ殑鏁版嵁搴撳紑鍚痓inlog -### 1.运行 Canal Server +### 1.杩愯 Canal Server -（1）下载最新的 Canal Server https://github.com/alibaba/canal/releases/latest, 下载 `canal.deployer-版本号-SNAPSHOT.tar.gz` 文件 +锛1锛変笅杞芥渶鏂扮殑 Canal Server https://github.com/alibaba/canal/releases/latest, 涓嬭浇 `canal.deployer-鐗堟湰鍙-SNAPSHOT.tar.gz` 鏂囦欢 -（2）配置 +锛2锛夐厤缃 -编辑文件 `conf/example/instance.properties` +缂栬緫鏂囦欢 `conf/example/instance.properties` -设置 MySql 地址：`canal.instance.master.address=` +璁剧疆 MySql 鍦板潃锛歚canal.instance.master.address=` -设置 MySql 用户：`canal.instance.dbUsername=` +璁剧疆 MySql 鐢ㄦ埛锛歚canal.instance.dbUsername=` -设置 MySql 密码：`canal.instance.dbPassword=` +璁剧疆 MySql 瀵嗙爜锛歚canal.instance.dbPassword=` -（3）运行 - 进入 `bin` 目录，根据你的系统选择脚本运行。 +锛3锛夎繍琛 + 杩涘叆 `bin` 鐩綍锛屾牴鎹綘鐨勭郴缁熼夋嫨鑴氭湰杩愯銆 -### 2.使用 +### 2.浣跨敤 ````csharp -//初始化日志 +//鍒濆鍖栨棩蹇 using var loggerFactory = LoggerFactory.Create(builder => { builder @@ -48,19 +50,19 @@ using var loggerFactory = LoggerFactory.Create(builder => .AddConsole(); }); -//创建连接 -var conn=new SimpleCanalConnection(new SimpleCanalConnectionOptions(Canal Server 地址,端口 默认 11111,ClientId 自定义), loggerFactory.CreateLogger()); +//鍒涘缓杩炴帴 +var conn=new SimpleCanalConnection(new SimpleCanalConnectionOptions(Canal Server 鍦板潃,绔彛 榛樿 11111,ClientId 鑷畾涔), loggerFactory.CreateLogger()); -//连接到 Canal Server +//杩炴帴鍒 Canal Server await conn.ConnectAsync(); -//订阅需要处理的数据 +//璁㈤槄闇瑕佸鐞嗙殑鏁版嵁 await conn.SubscribeAsync(); while (true) { - //获取数据 + //鑾峰彇鏁版嵁 var msg = await conn.GetAsync(1024); await Task.Delay(300); } ```` ->更详细的文档将在重构完成后提供 +>鏇磋缁嗙殑鏂囨。灏嗗湪閲嶆瀯瀹屾垚鍚庢彁渚