SpringBoot整合Canal、RabbitMQ監聽數據變更~
經過調研發現，使用Canal來監聽MySQL的binlog變化可以實現這個需求，可是在監聽到變化后需要馬上保存變更記錄，除非再做一些邏輯處理，于是我又結合了RabbitMQ來處理保存變更記錄的操作。
需求
我想要在SpringBoot中采用一種與業務代碼解耦合的方式，來實現數據的變更記錄，記錄的內容是新數據，如果是更新操作還得有舊數據內容。
經過調研發現，使用Canal來監聽MySQL的binlog變化可以實現這個需求，可是在監聽到變化后需要馬上保存變更記錄，除非再做一些邏輯處理，于是我又結合了RabbitMQ來處理保存變更記錄的操作。
步驟
- 啟動MySQL環境，并開啟binlog
- 啟動Canal環境，為其創建一個MySQL賬號，然后以Slave的形式連接MySQL
- Canal服務模式設為TCP，用Java編寫客戶端代碼，監聽MySQL的binlog修改
- Canal服務模式設為RabbitMQ，啟動RabbitMQ環境，配置Canal和RabbitMQ的連接，用消息隊列去接收binlog修改事件
環境搭建
環境搭建基于docker-compose：
version: "3"
services:
mysql:
network_mode: mynetwork
container_name: mymysql
ports:
- 3306:3306
restart: always
volumes:
- /etc/localtime:/etc/localtime
- /home/mycontainers/mymysql/data:/data
- /home/mycontainers/mymysql/mysql:/var/lib/mysql
- /home/mycontainers/mymysql/conf:/etc/mysql
environment:
- MYSQL_ROOT_PASSWORD=root
command:
--character-set-server=utf8mb4
--collation-server=utf8mb4_unicode_ci
--log-bin=/var/lib/mysql/mysql-bin
--server-id=1
--binlog-format=ROW
--expire_logs_days=7
--max_binlog_size=500M
image: mysql:5.7.20
rabbitmq:
container_name: myrabbit
ports:
- 15672:15672
- 5672:5672
restart: always
volumes:
- /etc/localtime:/etc/localtime
- /home/mycontainers/myrabbit/rabbitmq:/var/lib/rabbitmq
network_mode: mynetwork
environment:
- RABBITMQ_DEFAULT_USER=admin
- RABBITMQ_DEFAULT_PASS=123456
image: rabbitmq:3.8-management
canal-server:
container_name: canal-server
restart: always
ports:
- 11110:11110
- 11111:11111
- 11112:11112
volumes:
- /home/mycontainers/canal-server/conf/canal.properties:/home/admin/canal-server/conf/canal.properties
- /home/mycontainers/canal-server/conf/instance.properties:/home/admin/canal-server/conf/example/instance.properties
- /home/mycontainers/canal-server/logs:/home/admin/canal-server/logs
network_mode: mynetwork
depends_on:
- mysql
- rabbitmq
# - canal-admin
image: canal/canal-server:v1.1.5我們需要修改下Canal環境的配置文件：canal.properties和instance.properties，映射Canal中的以下兩個路徑：
- /home/admin/canal-server/conf/canal.properties配置文件中，canal.destinations意思是server上部署的instance列表，
- /home/admin/canal-server/conf/example/instance.properties這里的/example是指instance即實例名，要和上面canal.properties內instance配置對應，canal會為實例創建對應的文件夾，一個Client對應一個實例
以下是我們需要準備的兩個配置文件具體內容：
canal.properties
#################################################
######### common argument #############
#################################################
# tcp bind ip
canal.ip =
# register ip to zookeeper
canal.register.ip =
canal.port = 11111
canal.metrics.pull.port = 11112
# canal instance user/passwd
# canal.user = canal
# canal.passwd = E3619321C1A937C46A0D8BD1DAC39F93B27D4458
# canal admin config
# canal.admin.manager = canal-admin:8089
# canal.admin.port = 11110
# canal.admin.user = admin
# canal.admin.passwd = 6BB4837EB74329105EE4568DDA7DC67ED2CA2AD9
# admin auto register 自動注冊
# canal.admin.register.auto = true
# 集群名，單機則不寫
# canal.admin.register.cluster =
# Canal Server 名字
# canal.admin.register.name = canal-admin
canal.zkServers =
# flush data to zk
canal.zookeeper.flush.period = 1000
canal.withoutNetty = false
# tcp, kafka, rocketMQ, rabbitMQ, pulsarMQ
canal.serverMode = tcp
# flush meta cursor/parse position to file
canal.file.data.dir = ${canal.conf.dir}
canal.file.flush.period = 1000
## memory store RingBuffer size, should be Math.pow(2,n)
canal.instance.memory.buffer.size = 16384
## memory store RingBuffer used memory unit size , default 1kb
canal.instance.memory.buffer.memunit = 1024
## meory store gets mode used MEMSIZE or ITEMSIZE
canal.instance.memory.batch.mode = MEMSIZE
canal.instance.memory.rawEntry = true
## detecing config
canal.instance.detecting.enable = false
#canal.instance.detecting.sql = insert into retl.xdual values(1,now()) on duplicate key update x=now()
canal.instance.detecting.sql = select 1
canal.instance.detecting.interval.time = 3
canal.instance.detecting.retry.threshold = 3
canal.instance.detecting.heartbeatHaEnable = false
# support maximum transaction size, more than the size of the transaction will be cut into multiple transactions delivery
canal.instance.transaction.size = 1024
# mysql fallback connected to new master should fallback times
canal.instance.fallbackIntervalInSeconds = 60
# network config
canal.instance.network.receiveBufferSize = 16384
canal.instance.network.sendBufferSize = 16384
canal.instance.network.soTimeout = 30
# binlog filter config
canal.instance.filter.druid.ddl = true
canal.instance.filter.query.dcl = false
canal.instance.filter.query.dml = false
canal.instance.filter.query.ddl = false
canal.instance.filter.table.error = false
canal.instance.filter.rows = false
canal.instance.filter.transaction.entry = false
canal.instance.filter.dml.insert = false
canal.instance.filter.dml.update = false
canal.instance.filter.dml.delete = false
# binlog format/image check
canal.instance.binlog.format = ROW,STATEMENT,MIXED
canal.instance.binlog.image = FULL,MINIMAL,NOBLOB
# binlog ddl isolation
canal.instance.get.ddl.isolation = false
# parallel parser config
canal.instance.parser.parallel = true
## concurrent thread number, default 60% available processors, suggest not to exceed Runtime.getRuntime().availableProcessors()
canal.instance.parser.parallelThreadSize = 16
## disruptor ringbuffer size, must be power of 2
canal.instance.parser.parallelBufferSize = 256
# table meta tsdb info
canal.instance.tsdb.enable = true
canal.instance.tsdb.dir = ${canal.file.data.dir:../conf}/${canal.instance.destination:}
canal.instance.tsdb.url = jdbc:h2:${canal.instance.tsdb.dir}/h2;CACHE_SIZE=1000;MODE=MYSQL;
canal.instance.tsdb.dbUsername = canal
canal.instance.tsdb.dbPassword = canal
# dump snapshot interval, default 24 hour
canal.instance.tsdb.snapshot.interval = 24
# purge snapshot expire , default 360 hour(15 days)
canal.instance.tsdb.snapshot.expire = 360
#################################################
######### destinations #############
#################################################
canal.destinations = canal-exchange
# conf root dir
canal.conf.dir = ../conf
# auto scan instance dir add/remove and start/stop instance
canal.auto.scan = true
canal.auto.scan.interval = 5
# set this value to 'true' means that when binlog pos not found, skip to latest.
# WARN: pls keep 'false' in production env, or if you know what you want.
canal.auto.reset.latest.pos.mode = false
canal.instance.tsdb.spring.xml = classpath:spring/tsdb/h2-tsdb.xml
#canal.instance.tsdb.spring.xml = classpath:spring/tsdb/mysql-tsdb.xml
canal.instance.global.mode = spring
canal.instance.global.lazy = false
canal.instance.global.manager.address = ${canal.admin.manager}
#canal.instance.global.spring.xml = classpath:spring/memory-instance.xml
canal.instance.global.spring.xml = classpath:spring/file-instance.xml
#canal.instance.global.spring.xml = classpath:spring/default-instance.xml
##################################################
######### MQ Properties #############
##################################################
# aliyun ak/sk , support rds/mq
canal.aliyun.accessKey =
canal.aliyun.secretKey =
canal.aliyun.uid=
canal.mq.flatMessage = true
canal.mq.canalBatchSize = 50
canal.mq.canalGetTimeout = 100
# Set this value to "cloud", if you want open message trace feature in aliyun.
canal.mq.accessChannel = local
canal.mq.database.hash = true
canal.mq.send.thread.size = 30
canal.mq.build.thread.size = 8
##################################################
######### RabbitMQ #############
##################################################
rabbitmq.host = myrabbit
rabbitmq.virtual.host = /
rabbitmq.exchange = canal-exchange
rabbitmq.username = admin
rabbitmq.password = RabbitMQ密碼
rabbitmq.deliveryMode =此時canal.serverMode = tcp，即TCP直連，我們先開啟這個服務，然后手寫Java客戶端代碼去連接它，等下再改為RabbitMQ。
通過注釋可以看到，canal支持的服務模式有：tcp, kafka, rocketMQ, rabbitMQ, pulsarMQ，即主流的消息隊列都支持。
instance.properties
#################################################
## mysql serverId , v1.0.26+ will autoGen
#canal.instance.mysql.slaveId=123
# enable gtid use true/false
canal.instance.gtidon=false
# position info
canal.instance.master.address=mymysql:3306
canal.instance.master.journal.name=
canal.instance.master.position=
canal.instance.master.timestamp=
canal.instance.master.gtid=
# rds oss binlog
canal.instance.rds.accesskey=
canal.instance.rds.secretkey=
canal.instance.rds.instanceId=
# table meta tsdb info
canal.instance.tsdb.enable=true
#canal.instance.tsdb.url=jdbc:mysql://127.0.0.1:3306/canal_tsdb
#canal.instance.tsdb.dbUsername=canal
#canal.instance.tsdb.dbPassword=canal
#canal.instance.standby.address =
#canal.instance.standby.journal.name =
#canal.instance.standby.position =
#canal.instance.standby.timestamp =
#canal.instance.standby.gtid=
# username/password
canal.instance.dbUsername=canal
canal.instance.dbPassword=canal
canal.instance.connectionCharset = UTF-8
# enable druid Decrypt database password
canal.instance.enableDruid=false
#canal.instance.pwdPublicKey=MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBALK4BUxdDltRRE5/zXpVEVPUgunvscYFtEip3pmLlhrWpacX7y7GCMo2/JM6LeHmiiNdH1FWgGCpUfircSwlWKUCAwEAAQ==
# table regex
canal.instance.filter.regex=.*\..*
# table black regex
canal.instance.filter.black.regex=mysql\.slave_.*
# table field filter(format: schema1.tableName1:field1/field2,schema2.tableName2:field1/field2)
#canal.instance.filter.field=test1.t_product:id/subject/keywords,test2.t_company:id/name/contact/ch
# table field black filter(format: schema1.tableName1:field1/field2,schema2.tableName2:field1/field2)
#canal.instance.filter.black.field=test1.t_product:subject/product_image,test2.t_company:id/name/contact/ch
# mq config
canal.mq.topic=canal-routing-key
# dynamic topic route by schema or table regex
#canal.mq.dynamicTopic=mytest1.user,topic2:mytest2\..*,.*\..*
canal.mq.partition=0把這兩個配置文件映射好，再次提醒，注意實例的路徑名，默認是：/example/instance.properties
修改canal配置文件
我們需要修改這個實例配置文件，去連接MySQL，確保以下的配置正確：
canal.instance.master.address=mymysql:3306
canal.instance.dbUsername=canal
canal.instance.dbPassword=canalmymysql是同為docker容器的MySQL環境，端口3306是指內部端口。
這里多說明一下，docker端口配置時假設為：13306:3306，那么容器對外的端口就是13306，內部是3306，在本示例中，MySQL和Canal都是容器環境，所以Canal連接MySQL需要滿足以下條件：
- 處于同一網段（docker-compose.yml中的mynetwork）
- 訪問內部端口（即3306，而非13306）
dbUsername和dbPassword為MySQL賬號密碼，為了開發方便可以使用root/root，但是我仍建議自行創建用戶并分配訪問權限：
# 進入docker中的mysql容器
docker exec -it mymysql bash
# 進入mysql指令模式
mysql -uroot -proot
# 編寫MySQL語句并執行
> ...-- 選擇mysql
use mysql;
-- 創建canal用戶，賬密：canal/canal
create user 'canal'@'%' identified by 'canal';
-- 分配權限，以及允許所有主機登錄該用戶
grant SELECT, INSERT, UPDATE, DELETE, REPLICATION SLAVE, REPLICATION CLIENT on *.* to 'canal'@'%';
-- 刷新一下使其生效
flush privileges;
-- 附帶一個刪除用戶指令
drop user 'canal'@'%';用navicat或者shell去登錄canal這個用戶，可以訪問即創建成功
整合SpringBoot Canal實現客戶端
Maven依賴：
<canal.version>1.1.5</canal.version>
<!--canal-->
<dependency>
<groupId>com.alibaba.otter</groupId>
<artifactId>canal.client</artifactId>
<version>${canal.version}</version>
</dependency>
<dependency>
<groupId>com.alibaba.otter</groupId>
<artifactId>canal.protocol</artifactId>
<version>${canal.version}</version>
</dependency>
復制代碼新增組件并啟動：
import com.alibaba.otter.canal.client.CanalConnector;
import com.alibaba.otter.canal.client.CanalConnectors;
import com.alibaba.otter.canal.protocol.CanalEntry;
import com.alibaba.otter.canal.protocol.Message;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
import java.net.InetSocketAddress;
import java.util.List;
@Component
public class CanalClient {
private final static int BATCH_SIZE = 1000;
public void run() {
// 創建鏈接
CanalConnector connector = CanalConnectors.newSingleConnector(new InetSocketAddress("localhost", 11111), "canal-exchange", "canal", "canal");
try {
//打開連接
connector.connect();
//訂閱數據庫表,全部表
connector.subscribe(".*\..*");
//回滾到未進行ack的地方，下次fetch的時候，可以從最后一個沒有ack的地方開始拿
connector.rollback();
while (true) {
// 獲取指定數量的數據
Message message = connector.getWithoutAck(BATCH_SIZE);
//獲取批量ID
long batchId = message.getId();
//獲取批量的數量
int size = message.getEntries().size();
//如果沒有數據
if (batchId == -1 || size == 0) {
try {
//線程休眠2秒
Thread.sleep(2000);
} catch (InterruptedException e) {
e.printStackTrace();
}
} else {
//如果有數據,處理數據
printEntry(message.getEntries());
}
//進行 batch id 的確認。確認之后，小于等于此 batchId 的 Message 都會被確認。
connector.ack(batchId);
}
} catch (Exception e) {
e.printStackTrace();
} finally {
connector.disconnect();
}
}
/**
* 打印canal server解析binlog獲得的實體類信息
*/
private static void printEntry(List<CanalEntry.Entry> entrys) {
for (CanalEntry.Entry entry : entrys) {
if (entry.getEntryType() == CanalEntry.EntryType.TRANSACTIONBEGIN || entry.getEntryType() == CanalEntry.EntryType.TRANSACTIONEND) {
//開啟/關閉事務的實體類型，跳過
continue;
}
//RowChange對象，包含了一行數據變化的所有特征
//比如isDdl 是否是ddl變更操作 sql 具體的ddl sql beforeColumns afterColumns 變更前后的數據字段等等
CanalEntry.RowChange rowChage;
try {
rowChage = CanalEntry.RowChange.parseFrom(entry.getStoreValue());
} catch (Exception e) {
throw new RuntimeException("ERROR ## parser of eromanga-event has an error , data:" + entry.toString(), e);
}
//獲取操作類型：insert/update/delete類型
CanalEntry.EventType eventType = rowChage.getEventType();
//打印Header信息
System.out.println(String.format("================》; binlog[%s:%s] , name[%s,%s] , eventType : %s",
entry.getHeader().getLogfileName(), entry.getHeader().getLogfileOffset(),
entry.getHeader().getSchemaName(), entry.getHeader().getTableName(),
eventType));
//判斷是否是DDL語句
if (rowChage.getIsDdl()) {
System.out.println("================》;isDdl: true,sql:" + rowChage.getSql());
}
//獲取RowChange對象里的每一行數據，打印出來
for (CanalEntry.RowData rowData : rowChage.getRowDatasList()) {
//如果是刪除語句
if (eventType == CanalEntry.EventType.DELETE) {
printColumn(rowData.getBeforeColumnsList());
//如果是新增語句
} else if (eventType == CanalEntry.EventType.INSERT) {
printColumn(rowData.getAfterColumnsList());
//如果是更新的語句
} else {
//變更前的數據
System.out.println("------->; before");
printColumn(rowData.getBeforeColumnsList());
//變更后的數據
System.out.println("------->; after");
printColumn(rowData.getAfterColumnsList());
}
}
}
}
private static void printColumn(List<CanalEntry.Column> columns) {
for (CanalEntry.Column column : columns) {
System.out.println(column.getName() + " : " + column.getValue() + " update=" + column.getUpdated());
}
}
}啟動類Application：
@SpringBootApplication
public class BaseApplication implements CommandLineRunner {
@Autowired
private CanalClient canalClient;
@Override
public void run(String... args) throws Exception {
canalClient.run();
}
}啟動程序，此時新增或修改數據庫中的數據，我們就能從客戶端中監聽到
不過我建議監聽的信息放到消息隊列中，在空閑的時候去處理，所以直接配置Canal整合RabbitMQ更好。
Canal整合RabbitMQ
修改canal.properties中的serverMode：
canal.serverMode = rabbitMQ修改instance.properties中的topic：
canal.mq.topic=canal-routing-key然后找到關于RabbitMQ的配置：
##################################################
######### RabbitMQ #############
##################################################
# 連接rabbit，寫IP，因為同個網絡下，所以可以寫容器名
rabbitmq.host = myrabbit
rabbitmq.virtual.host = /
# 交換器名稱，等等我們要去手動創建
rabbitmq.exchange = canal-exchange
# 賬密
rabbitmq.username = admin
rabbitmq.password = 123456
# 暫不支持指定端口，使用的是默認的5762，好在在本示例中適用重新啟動容器，進入RabbitMQ管理頁面創建exchange交換器和隊列queue：
- 新建exchange，命名為：canal-exchange
- 新建queue，命名為：canal-queue
- 綁定exchange和queue，routing-key設置為：canal-routing-key，這里對應上面instance.properties的canal.mq.topic
順帶一提，上面這段可以忽略，因為在SpringBoot的RabbitMQ配置中，會自動創建交換器exchange和隊列queue，不過手動創建的話，可以在忽略SpringBoot的基礎上，直接在RabbitMQ的管理頁面上看到修改記錄的消息。
SpringBoot整合RabbitMQ
依賴：
<amqp.version>2.3.4.RELEASE</amqp.version>
<!--消息隊列-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-amqp</artifactId>
<version>${amqp.version}</version>
</dependency>application.yml：
spring:
rabbitmq:
# host: myserverhost
host: 192.168.0.108
port: 5672
username: admin
password: RabbitMQ密碼
# 消息確認配置項
# 確認消息已發送到交換機(Exchange)
publisher-confirm-type: correlated
# 確認消息已發送到隊列(Queue)
publisher-returns: trueRabbitMQ配置類：
@Configuration
public class RabbitConfig {
@Bean
public RabbitTemplate rabbitTemplate(ConnectionFactory connectionFactory) {
RabbitTemplate template = new RabbitTemplate();
template.setConnectionFactory(connectionFactory);
template.setMessageConverter(new Jackson2JsonMessageConverter());
return template;
}
/**
* template.setMessageConverter(new Jackson2JsonMessageConverter());
* 這段和上面這行代碼解決RabbitListener循環報錯的問題
*/
@Bean
public SimpleRabbitListenerContainerFactory rabbitListenerContainerFactory(ConnectionFactory connectionFactory) {
SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
factory.setConnectionFactory(connectionFactory);
factory.setMessageConverter(new Jackson2JsonMessageConverter());
return factory;
}
}Canal消息生產者：
public static final String CanalQueue = "canal-queue";
public static final String CanalExchange = "canal-exchange";
public static final String CanalRouting = "canal-routing-key";
復制代碼
/**
* Canal消息提供者，canal-server生產的消息通過RabbitMQ消息隊列發送
*/
@Configuration
public class CanalProvider {
/**
* 隊列
*/
@Bean
public Queue canalQueue() {
/**
* durable:是否持久化，默認false，持久化隊列：會被存儲在磁盤上，當消息代理重啟時仍然存在；暫存隊列：當前連接有效
* exclusive:默認為false，只能被當前創建的連接使用，而且當連接關閉后隊列即被刪除。此參考優先級高于durable
* autoDelete:是否自動刪除，當沒有生產者或者消費者使用此隊列，該隊列會自動刪除
*/
return new Queue(RabbitConstant.CanalQueue, true);
}
/**
* 交換機，這里使用直連交換機
*/
@Bean
DirectExchange canalExchange() {
return new DirectExchange(RabbitConstant.CanalExchange, true, false);
}
/**
* 綁定交換機和隊列，并設置匹配鍵
*/
@Bean
Binding bindingCanal() {
return BindingBuilder.bind(canalQueue()).to(canalExchange()).with(RabbitConstant.CanalRouting);
}
}Canal消息消費者：
/**
* Canal消息消費者
*/
@Component
@RabbitListener(queues = RabbitConstant.CanalQueue)
public class CanalComsumer {
private final SysBackupService sysBackupService;
public CanalComsumer(SysBackupService sysBackupService) {
this.sysBackupService = sysBackupService;
}
@RabbitHandler
public void process(Map<String, Object> msg) {
System.out.println("收到canal消息：" + msg);
boolean isDdl = (boolean) msg.get("isDdl");
// 不處理DDL事件
if (isDdl) {
return;
}
// TiCDC的id，應該具有唯一性，先保存再說
int tid = (int) msg.get("id");
// TiCDC生成該消息的時間戳，13位毫秒級
long ts = (long) msg.get("ts");
// 數據庫
String database = (String) msg.get("database");
// 表
String table = (String) msg.get("table");
// 類型：INSERT/UPDATE/DELETE
String type = (String) msg.get("type");
// 每一列的數據值
List<?> data = (List<?>) msg.get("data");
// 僅當type為UPDATE時才有值，記錄每一列的名字和UPDATE之前的數據值
List<?> old = (List<?>) msg.get("old");
// 跳過sys_backup，防止無限循環
if ("sys_backup".equalsIgnoreCase(table)) {
return;
}
// 只處理指定類型
if (!"INSERT".equalsIgnoreCase(type)
&& !"UPDATE".equalsIgnoreCase(type)
&& !"DELETE".equalsIgnoreCase(type)) {
return;
}
}
}測試一下，修改MySQL中的一條消息，Canal就會發送信息到RabbitMQ，我們就能從監聽的RabbitMQ隊列中得到該條消息。
責任編輯：武曉燕
來源：
JAVA日知錄
