canal安装及使用

1、准备：

github:https://github.com/alibaba/canal

里面有包括canal的文档，server端 client端的 例子 源码包等等。

2、canal概述：

canal是应阿里巴巴存在杭州和美国的双机房部署，存在跨机房同步的业务需求而提出的。

早期，阿里巴巴B2B公司因为存在杭州和美国双机房部署，存在跨机房同步的业务需求。不过早期的数据库同步业务，主要是基于trigger的方式获取增量变更，不过从2010年开始，阿里系公司开始逐步的尝试基于数据库的日志解析，获取增量变更进行同步，由此衍生出了增量订阅&消费的业务，从此开启了一段新纪元。ps. 目前内部使用的同步，已经支持mysql5.x和oracle部分版本的日志解析


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


数据库镜像
数据库实时备份
多级索引 (卖家和买家各自分库索引)
search build
业务cache刷新
价格变化等重要业务消息

keyword：数据库同步，增量订阅&消费。

3、canal工作原理：

 

从上层来看，复制分成三步：


master将改变记录到二进制日志(binary log)中（这些记录叫做二进制日志事件，binary log events，可以通过show binlog events进行查看）；
slave将master的binary log events拷贝到它的中继日志(relay log)；
slave重做中继日志中的事件，将改变反映它自己的数据。

 

4、部署canal：

 

部署canal-server：

（1）开启mysql的binlog功能，并配置binlog模式为row。

在my.cnf 加入如下：

 

[html] view plain copy

1. [mysqld]
2. log-bin=mysql-bin #添加这一行就ok
3. binlog-format=ROW #选择row模式
4. server_id=1 #配置mysql replaction需要定义，不能和canal的slaveId重复

 

（2）在mysql中 配置canal数据库管理用户，配置相应权限（repication权限）

 

[sql] view plain copy

1. CREATE USER canal IDENTIFIED BY 'canal';
2. GRANT SELECT, REPLICATION SLAVE, REPLICATION CLIENT ON *.* TO 'canal'@'%';
3. -- GRANT ALL PRIVILEGES ON *.* TO 'canal'@'%' ;
4. FLUSH PRIVILEGES;

（3）下载canal https://github.com/alibaba/canal/releases

 

解压到相应文件夹

 

[html] view plain copy

1. tar -zxvf canal canal

canal 文件目录结构

 

 

[html] view plain copy

1. drwxr-xr-x 2 jianghang jianghang 136 2013-02-05 21:51 bin
2. drwxr-xr-x 4 jianghang jianghang 160 2013-02-05 21:51 conf
3. drwxr-xr-x 2 jianghang jianghang 1.3K 2013-02-05 21:51 lib
4. drwxr-xr-x 2 jianghang jianghang 48 2013-02-05 21:29 logs

修改配置 instance.properties

 

 

[html] view plain copy

1. vim canal/conf/example/instance.properties

 

[html] view plain copy

1. #################################################
2. ## mysql serverId
3. canal.instance.mysql.slaveId = 1234
4.  
5. # position info，需要改成自己的数据库信息
6. canal.instance.master.address = 127.0.0.1:3306
7. canal.instance.master.journal.name =
8. canal.instance.master.position =
9. canal.instance.master.timestamp =
10.  
11. #canal.instance.standby.address =
12. #canal.instance.standby.journal.name =
13. #canal.instance.standby.position =
14. #canal.instance.standby.timestamp =
15.  
16. # username/password，需要改成自己的数据库信息
17. canal.instance.dbUsername = canal
18. canal.instance.dbPassword = canal
19. canal.instance.defaultDatabaseName = canal_test
20. canal.instance.connectionCharset = UTF-8
21.  
22. # table regex
23. canal.instance.filter.regex = .*\\..*
24.  
25. #################################################

然后cd到bin目录 启动和停止canal-server

 

启动

[html] view plain copy

1. ./startup.sh

停止

 

 

[html] view plain copy

1. ./stop.sh

验证启动状态，查看log文件

 

 

[html] view plain copy

1. vim canal/log/canal/canal.log

 

[html] view plain copy

1. 2014-07-18 10:21:08.525 [main] INFO com.alibaba.otter.canal.deployer.CanalLauncher - ## start the canal server.
2. 2014-07-18 10:21:08.609 [main] INFO com.alibaba.otter.canal.deployer.CanalController - ## start the canal server[10.12.109.201:11111]
3. 2014-07-18 10:21:09.037 [main] INFO com.alibaba.otter.canal.deployer.CanalLauncher - ## the canal server is running now ......

上述日志信息显示启动canal成功

 

运行canal-client实例:

（1）建立实例maven工程

 

[html] view plain copy

1. mvn archetype:create -DgroupId=com.alibaba.otter -DartifactId=canal.sample

（2）添加pom依赖：

 

 

[html] view plain copy

1. <dependency>
2. <groupId>com.alibaba.otter</groupId>
3. <artifactId>canal.client</artifactId>
4. <version>1.0.12</version>
5. </dependency>

（3）更新依赖 mvn install

 

（4）canal-client.java 实例代码

 

[java] view plain copy

1. /**
2. * Created by hp on 14-7-17.
3. */
4. import java.net.InetSocketAddress;
5. import java.util.List;
6.  
7. import com.alibaba.otter.canal.client.CanalConnector;
8. import com.alibaba.otter.canal.common.utils.AddressUtils;
9. import com.alibaba.otter.canal.protocol.Message;
10. import com.alibaba.otter.canal.protocol.CanalEntry.Column;
11. import com.alibaba.otter.canal.protocol.CanalEntry.Entry;
12. import com.alibaba.otter.canal.protocol.CanalEntry.EntryType;
13. import com.alibaba.otter.canal.protocol.CanalEntry.EventType;
14. import com.alibaba.otter.canal.protocol.CanalEntry.RowChange;
15. import com.alibaba.otter.canal.protocol.CanalEntry.RowData;
16. import com.alibaba.otter.canal.client.*;
17. import org.jetbrains.annotations.NotNull;
18.  
19. public class ClientSample {
20.  
21. public static void main(String args[]) {
22. // 创建链接
23. CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress(AddressUtils.getHostIp(),
24. 11111), "example", "", "");
25. int batchSize = 1000;
26. int emptyCount = 0;
27. try {
28. connector.connect();
29. connector.subscribe(".*\\..*");
30. connector.rollback();
31. int totalEmtryCount = 1200;
32. while (emptyCount < totalEmtryCount) {
33. Message message = connector.getWithoutAck(batchSize); // 获取指定数量的数据
34. long batchId = message.getId();
35. int size = message.getEntries().size();
36. if (batchId == -1 || size == 0) {
37. emptyCount++;
38. System.out.println("empty count : " + emptyCount);
39. try {
40. Thread.sleep(1000);
41. } catch (InterruptedException e) {
42. e.printStackTrace();
43. }
44. } else {
45. emptyCount = 0;
46. // System.out.printf("message[batchId=%s,size=%s] \n", batchId, size);
47. printEntry(message.getEntries());
48. }
49.  
50. connector.ack(batchId); // 提交确认
51. // connector.rollback(batchId); // 处理失败, 回滚数据
52. }
53.  
54. System.out.println("empty too many times, exit");
55. } finally {
56. connector.disconnect();
57. }
58. }
59.  
60. private static void printEntry(@NotNull List<Entry> entrys) {
61. for (Entry entry : entrys) {
62. if (entry.getEntryType() == EntryType.TRANSACTIONBEGIN || entry.getEntryType() == EntryType.TRANSACTIONEND) {
63. continue;
64. }
65.  
66. RowChange rowChage = null;
67. try {
68. rowChage = RowChange.parseFrom(entry.getStoreValue());
69. } catch (Exception e) {
70. throw new RuntimeException("ERROR ## parser of eromanga-event has an error , data:" + entry.toString(),
71. e);
72. }
73.  
74. EventType eventType = rowChage.getEventType();
75. System.out.println(String.format("================> binlog[%s:%s] , name[%s,%s] , eventType : %s",
76. entry.getHeader().getLogfileName(), entry.getHeader().getLogfileOffset(),
77. entry.getHeader().getSchemaName(), entry.getHeader().getTableName(),
78. eventType));
79.  
80. for (RowData rowData : rowChage.getRowDatasList()) {
81. if (eventType == EventType.DELETE) {
82. printColumn(rowData.getBeforeColumnsList());
83. } else if (eventType == EventType.INSERT) {
84. printColumn(rowData.getAfterColumnsList());
85. } else {
86. System.out.println("-------> before");
87. printColumn(rowData.getBeforeColumnsList());
88. System.out.println("-------> after");
89. printColumn(rowData.getAfterColumnsList());
90. }
91. }
92. }
93. }
94.  
95. private static void printColumn(@NotNull List<Column> columns) {
96. for (Column column : columns) {
97. System.out.println(column.getName() + " : " + column.getValue() + " update=" + column.getUpdated());
98. }
99. }
100. }

（5）运行java实例

 

启动后看到控制端信息：

 

[html] view plain copy

1. empty count : 1
2. empty count : 2
3. empty count : 3
4. empty count : 4

（6）触发数据库变更

 

 

[html] view plain copy

1. create table test (
2. uid int (4) primary key not null auto_increment,
3. name varchar(10) not null);
4.  
5. insert into test (name) values('10');

 

 

 

（7）client 抓取mysql信息:

 

[html] view plain copy

1. ================> binlog[mysql-bin.000016:3281] , name[canal_test,test] , eventType : INSERT
2. uid : 7 update=false
3. name : 10 update=false
4. empty count : 1
5. empty count : 2

5、部署过程中产生问题：

 

（1）启动失败，log日志中地址正在使用

1、11111端口正在被占用 可以用 ls -i:11111 查看监听进程谁占用端口 或者 用 ps -ef | grep 11111 查看哪个进程占用端口号 然后 kill -9 进程号 杀掉占用进程

2、可以编辑 canal/conf/canal.properties 中的端口号 ，改为不占用的端口

（2）canal无法抓取mysql触发数据库改变的信息

1、检查mysql是否打开binlog写入功能 检查binlog 是否为行模式。

 

[html] view plain copy

1. show variables like "binlog_format"

2、检查my.cnf 和 instance.properties 等配置文件填写信息是否正确。

 

3、检查client 代码 调试实例代码

4、版本兼容问题，canal 1.8 换成 canal 1.7 继续测试

5、查看所有日志文件 分析日志