一、Canal介绍

1、应用场景

在前面的统计分析功能中，我们采取了服务调用获取统计数据，这样耦合度高，效率相对较低，目前我采取另一种实现方式，通过实时同步数据库表的方式实现，例如我们要统计每天注册与登录人数，我们只需把会员表同步到统计库中，实现本地统计就可以了，这样效率更高，耦合度更低，Canal就是一个很好的数据库同步工具。canal是阿里巴巴旗下的一款开源项目，纯Java开发。基于数据库增量日志解析，提供增量数据订阅&消费，目前主要支持了MySQL。

2、Canal环境搭建

canal的原理是基于mysql binlog技术，所以这里一定需要开启mysql的binlog写入功能
开启mysql服务： service mysql start
（1）检查binlog功能是否有开启

  1. mysql> show variables like 'log_bin';
  2. +---------------+-------+
  3. | Variable_name | Value |
  4. +---------------+-------+
  5. | log_bin       | OFF    |
  6. +---------------+-------+
  7. 1 row in set (0.00 sec)

（2）如果显示状态为OFF表示该功能未开启，开启binlog功能

  1. 1，修改 mysql 的配置文件 my.cnf
  2. vi /etc/my.cnf 
  3. 追加内容：
  4. log-bin=mysql-bin     #binlog文件名
  5. binlog_format=ROW     #选择row模式
  6. server_id=1           #mysql实例id,不能和canal的slaveId重复
  8. 2，重启 mysql：
  9. service mysql restart    
  11. 3，登录 mysql 客户端，查看 log_bin 变量
  12. mysql> show variables like 'log_bin';
  13. +---------------+-------+
  14. | Variable_name | Value |
  15. +---------------+-------+
  16. | log_bin       | ON|
  17. +---------------+-------+
  18. 1 row in set (0.00 sec)
  19. ————————————————
  20. 如果显示状态为ON表示该功能已开启

（3）在mysql里面添加以下的相关用户和权限

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

3、下载安装Canal服务

下载地址：https://github.com/alibaba/canal/releases

（1）下载之后，放到目录中，解压文件

cd /usr/local/canal
canal.deployer-1.1.4.tar.gz
tar zxvf canal.deployer-1.1.4.tar.gz

（2）修改配置文件

vi conf/example/instance.properties

  1. #需要改成自己的数据库信息
  2. canal.instance.master.address=192.168.44.132:3306
  4. #需要改成自己的数据库用户名与密码
  6. canal.instance.dbUsername=canal
  7. canal.instance.dbPassword=canal
  9. #需要改成同步的数据库表规则，例如只是同步一下表
  10. #canal.instance.filter.regex=.*\\..*
  11. canal.instance.filter.regex=guli_ucenter.ucenter_member

注：
mysql 数据解析关注的表，Perl正则表达式.
多个正则之间以逗号(,)分隔，转义符需要双斜杠(\)
常见例子：
1. 所有表：. or .\..
2. canal schema下所有表： canal\..
3. canal下的以canal打头的表：canal\.canal.
4. canal schema下的一张表：canal.test1
5. 多个规则组合使用：canal\..,mysql.test1,mysql.test2 (逗号分隔)
注意：此过滤条件只针对row模式的数据有效(ps. mixed/statement因为不解析sql，所以无法准确提取tableName进行过滤)


（3）进入bin目录下启动

sh bin/startup.sh

二、创建canal_client模块

1、在guliedu_parent下创建canal_client模块

fa123a9a-2ef5-49f3-a628-6dc428ce9b0b.png

2、引入相关依赖

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.springframework.boot</groupId>
  4.         <artifactId>spring-boot-starter-web</artifactId>
  5.     </dependency>
  7.     <!--mysql-->
  8.     <dependency>
  9.         <groupId>mysql</groupId>
  10.         <artifactId>mysql-connector-java</artifactId>
  11.     </dependency>
  13.     <dependency>
  14.         <groupId>commons-dbutils</groupId>
  15.         <artifactId>commons-dbutils</artifactId>
  16.     </dependency>
  18.     <dependency>
  19.         <groupId>org.springframework.boot</groupId>
  20.         <artifactId>spring-boot-starter-jdbc</artifactId>
  21.     </dependency>
  23.     <dependency>
  24.         <groupId>com.alibaba.otter</groupId>
  25.         <artifactId>canal.client</artifactId>
  26.     </dependency>
  27. </dependencies>

3、创建application.properties配置文件

  1. # 服务端口
  2. server.port=10000
  3. # 服务名
  4. spring.application.name=canal-client
  6. # 环境设置：dev、test、prod
  7. spring.profiles.active=dev
  9. # mysql数据库连接
  10. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
  11. spring.datasource.url=jdbc:mysql://localhost:3306/guli?serverTimezone=GMT%2B8
  12. spring.datasource.username=root
  13. spring.datasource.password=root

4、编写canal客户端类

  1. import com.alibaba.otter.canal.client.CanalConnector;
  2. import com.alibaba.otter.canal.client.CanalConnectors;
  3. import com.alibaba.otter.canal.protocol.CanalEntry.*;
  4. import com.alibaba.otter.canal.protocol.Message;
  5. import com.google.protobuf.InvalidProtocolBufferException;
  6. import org.apache.commons.dbutils.DbUtils;
  7. import org.apache.commons.dbutils.QueryRunner;
  8. import org.springframework.stereotype.Component;
  10. import javax.annotation.Resource;
  11. import javax.sql.DataSource;
  12. import java.net.InetSocketAddress;
  13. import java.sql.Connection;
  14. import java.sql.SQLException;
  15. import java.util.Iterator;
  16. import java.util.List;
  17. import java.util.Queue;
  18. import java.util.concurrent.ConcurrentLinkedQueue;
  20. @Component
  21. public class CanalClient {
  23.     //sql队列
  24.     private Queue<String> SQL_QUEUE = new ConcurrentLinkedQueue<>();
  26.     @Resource
  27.     private DataSource dataSource;
  29.     /**
  30.      * canal入库方法
  31.      */
  32.     public void run() {
  34.         CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("192.168.44.132",
  35.                 11111), "example", "", "");
  36.         int batchSize = 1000;
  37.         try {
  38.             connector.connect();
  39.             connector.subscribe(".*\\..*");
  40.             connector.rollback();
  41.             try {
  42.                 while (true) {
  43.                     //尝试从master那边拉去数据batchSize条记录，有多少取多少
  44.                     Message message = connector.getWithoutAck(batchSize);
  45.                     long batchId = message.getId();
  46.                     int size = message.getEntries().size();
  47.                     if (batchId == -1 || size == 0) {
  48.                         Thread.sleep(1000);
  49.                     } else {
  50.                         dataHandle(message.getEntries());
  51.                     }
  52.                     connector.ack(batchId);
  54.                     //当队列里面堆积的sql大于一定数值的时候就模拟执行
  55.                     if (SQL_QUEUE.size() >= 1) {
  56.                         executeQueueSql();
  57.                     }
  58.                 }
  59.             } catch (InterruptedException e) {
  60.                 e.printStackTrace();
  61.             } catch (InvalidProtocolBufferException e) {
  62.                 e.printStackTrace();
  63.             }
  64.         } finally {
  65.             connector.disconnect();
  66.         }
  67.     }
  69.     /**
  70.      * 模拟执行队列里面的sql语句
  71.      */
  72.     public void executeQueueSql() {
  73.         int size = SQL_QUEUE.size();
  74.         for (int i = 0; i < size; i++) {
  75.             String sql = SQL_QUEUE.poll();
  76.             System.out.println("[sql]----> " + sql);
  78.             this.execute(sql.toString());
  79.         }
  80.     }
  82.     /**
  83.      * 数据处理
  84.      *
  85.      * @param entrys
  86.      */
  87.     private void dataHandle(List<Entry> entrys) throws InvalidProtocolBufferException {
  88.         for (Entry entry : entrys) {
  89.             if (EntryType.ROWDATA == entry.getEntryType()) {
  90.                 RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
  91.                 EventType eventType = rowChange.getEventType();
  92.                 if (eventType == EventType.DELETE) {
  93.                     saveDeleteSql(entry);
  94.                 } else if (eventType == EventType.UPDATE) {
  95.                     saveUpdateSql(entry);
  96.                 } else if (eventType == EventType.INSERT) {
  97.                     saveInsertSql(entry);
  98.                 }
  99.             }
  100.         }
  101.     }
  103.     /**
  104.      * 保存更新语句
  105.      *
  106.      * @param entry
  107.      */
  108.     private void saveUpdateSql(Entry entry) {
  109.         try {
  110.             RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
  111.             List<RowData> rowDatasList = rowChange.getRowDatasList();
  112.             for (RowData rowData : rowDatasList) {
  113.                 List<Column> newColumnList = rowData.getAfterColumnsList();
  114.                 StringBuffer sql = new StringBuffer("update " + entry.getHeader().getTableName() + " set ");
  115.                 for (int i = 0; i < newColumnList.size(); i++) {
  116.                     sql.append(" " + newColumnList.get(i).getName()
  117.                             + " = '" + newColumnList.get(i).getValue() + "'");
  118.                     if (i != newColumnList.size() - 1) {
  119.                         sql.append(",");
  120.                     }
  121.                 }
  122.                 sql.append(" where ");
  123.                 List<Column> oldColumnList = rowData.getBeforeColumnsList();
  124.                 for (Column column : oldColumnList) {
  125.                     if (column.getIsKey()) {
  126.                         //暂时只支持单一主键
  127.                         sql.append(column.getName() + "=" + column.getValue());
  128.                         break;
  129.                     }
  130.                 }
  131.                 SQL_QUEUE.add(sql.toString());
  132.             }
  133.         } catch (InvalidProtocolBufferException e) {
  134.             e.printStackTrace();
  135.         }
  136.     }
  138.     /**
  139.      * 保存删除语句
  140.      *
  141.      * @param entry
  142.      */
  143.     private void saveDeleteSql(Entry entry) {
  144.         try {
  145.             RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
  146.             List<RowData> rowDatasList = rowChange.getRowDatasList();
  147.             for (RowData rowData : rowDatasList) {
  148.                 List<Column> columnList = rowData.getBeforeColumnsList();
  149.                 StringBuffer sql = new StringBuffer("delete from " + entry.getHeader().getTableName() + " where ");
  150.                 for (Column column : columnList) {
  151.                     if (column.getIsKey()) {
  152.                         //暂时只支持单一主键
  153.                         sql.append(column.getName() + "=" + column.getValue());
  154.                         break;
  155.                     }
  156.                 }
  157.                 SQL_QUEUE.add(sql.toString());
  158.             }
  159.         } catch (InvalidProtocolBufferException e) {
  160.             e.printStackTrace();
  161.         }
  162.     }
  164.     /**
  165.      * 保存插入语句
  166.      *
  167.      * @param entry
  168.      */
  169.     private void saveInsertSql(Entry entry) {
  170.         try {
  171.             RowChange rowChange = RowChange.parseFrom(entry.getStoreValue());
  172.             List<RowData> rowDatasList = rowChange.getRowDatasList();
  173.             for (RowData rowData : rowDatasList) {
  174.                 List<Column> columnList = rowData.getAfterColumnsList();
  175.                 StringBuffer sql = new StringBuffer("insert into " + entry.getHeader().getTableName() + " (");
  176.                 for (int i = 0; i < columnList.size(); i++) {
  177.                     sql.append(columnList.get(i).getName());
  178.                     if (i != columnList.size() - 1) {
  179.                         sql.append(",");
  180.                     }
  181.                 }
  182.                 sql.append(") VALUES (");
  183.                 for (int i = 0; i < columnList.size(); i++) {
  184.                     sql.append("'" + columnList.get(i).getValue() + "'");
  185.                     if (i != columnList.size() - 1) {
  186.                         sql.append(",");
  187.                     }
  188.                 }
  189.                 sql.append(")");
  190.                 SQL_QUEUE.add(sql.toString());
  191.             }
  192.         } catch (InvalidProtocolBufferException e) {
  193.             e.printStackTrace();
  194.         }
  195.     }
  197.     /**
  198.      * 入库
  199.      * @param sql
  200.      */
  201.     public void execute(String sql) {
  202.         Connection con = null;
  203.         try {
  204.             if(null == sql) return;
  205.             con = dataSource.getConnection();
  206.             QueryRunner qr = new QueryRunner();
  207.             int row = qr.execute(con, sql);
  208.             System.out.println("update: "+ row);
  209.         } catch (SQLException e) {
  210.             e.printStackTrace();
  211.         } finally {
  212.             DbUtils.closeQuietly(con);
  213.         }
  214.     }
  215. }

5、创建启动类

  1. @SpringBootApplication
  2. public class CanalApplication implements CommandLineRunner {
  3.     @Resource
  4.     private CanalClient canalClient;
  6.     public static void main(String[] args) {
  7.         SpringApplication.run(CanalApplication.class, args);
  8.     }
  10.     @Override
  11.     public void run(String... strings) throws Exception {
  12.         //项目启动，执行canal客户端监听
  13.         canalClient.run();
  14.     }
  15. }