# canal-spring-boot-starter

**Repository Path**: lontten/canal-spring-boot-starter

## Basic Information

- **Project Name**: canal-spring-boot-starter
- **Description**: canal 的 springboot2 starter，支持自动重连
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2024-10-22
- **Last Updated**: 2025-03-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot, canal, SpringBoot2

## README

# canal-spring-boot-starter

<a href="https://gitmoji.dev">
  <img
    src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square"
    alt="Gitmoji"
  />
</a>

#### 组件简介

> 基于 [Canal ](https://github.com/alibaba/canal) 整合的 Starter
> 
> 默认情况下，当服务器的 canal server 宕机后，canal client 会断开链接;
> 但是当 canal server 重启后，client 不会自动重连，还需要我们手动重启 canal client端，十分麻烦。
> 
> canal-spring-boot-starter ，可以在 canal server 重启后，自动重连。


> 支持 Spring Boot 2.x
>
> canal-client 版本 1.1.7

#### 使用说明

##### 1、Spring Boot 项目添加 Maven 依赖

``` xml
<dependency>
    <groupId>io.github.lontten</groupId>
    <artifactId>canal-spring-boot-starter</artifactId>
    <version>2.117.10.RELEASE</version>
</dependency>
```

##### 2、Spring Boot 项目添加 Gradle (Kotlin) 依赖

``` kotlin
implementation("io.github.lontten:canal-spring-boot-starter:2.117.10.RELEASE")
```

##### 3、Spring Boot 项目添加 Gradle 依赖

``` kotlin
implementation 'io.github.lontten:canal-spring-boot-starter:2.117.10.RELEASE'
```

##### 2、使用示例

###### 2.1、根据实际业务需求选择不同的客户端模式

在`application.yml`文件中增加如下配置

```yaml
lontten:
  canal:
    destination: example   # 订阅的 canal 订阅实例
    dbName: demo          # 数据库名字

    retryInterval: 60     # 重试间隔，单位秒，默认60秒
    maxRetryTimes: 10     # 最大重试次数,默认-1，无限制
    
    batchSize: 1000       # 每次轮训，拉取数量大小，默认 1000
    batchInterval: 1      # 每次轮训，拉取间隔，单位秒，默认 1秒

    enableLog: true       # 是否打印日志,默认 true
    
    username: canal       # canal server 账号
    password: canal       # canal server 密码
    
    # 1. 单例模式
    ip: 127.0.0.1       # canal server ip,默认 127.0.0.1
    port: 11111         # canal server 端口,默认 11111

    # 2. zookeeper集群模式
    zkServers: 127.0.0.1:2181   # zookeeper 地址

    # 3. 集群模式
    clusters:                   # canal server 列表
      - ip: 127.0.0.1
        port: 11111
      - ip: 127.0.0.1
        port: 11112

```

###### 2.1、CanalEventHandler 消费者模式

创建Service DemoCanalEventHandler，实现实体处理器 CanalEventHandler 接口

```java

import com.alibaba.otter.canal.protocol.CanalEntry;
import com.lontten.canal.service.CanalEventHandler;
import com.lontten.canal.util.CanalUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Service;

import java.util.List;

@Slf4j
@Service
public class DemoCanalEventHandler implements CanalEventHandler {

    @Override
    public String tableName() {
        return "t_demo";
    }

    @Override
    public void insert(Long id, List<CanalEntry.Column> list) {
        log.info("新增数据，id:{}", id);
    }

    @Override
    public void update(Long id, List<CanalEntry.Column> oldList, List<CanalEntry.Column> newList) {
        log.info("更新数据，id:{}", id);
        CanalEntry.Column uidColumn = CanalUtil.getField(newList, "uid");
        log.info("更新时，是否更新了 uid:{}", uidColumn.getUpdated());
        if (uidColumn.getUpdated()) {
            if (uidColumn.getIsNull()) {
                log.info("将uid 的值 更新为 null");
            }
        }
    }

    @Override
    public void delete(Long id, List<CanalEntry.Column> list) {
        log.info("删除数据，id:{}", id);
    }
}

```