# canal-spring-boot-starter

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

## Basic Information

- **Project Name**: canal-spring-boot-starter
- **Description**: canal-client整合springboot
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-12-27
- **Last Updated**: 2023-03-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# canal-spring-boot-starter

## 单机版本Canal

```yaml
spring:
    canal:
      #必须指定
      host: canal server hostName
      #必须指定
      port: canal server port
      #必须指定
      destination: canal server destination
      #当canal没有监听到数据变化时,客户端多久轮询一次数据,单位: 秒,默认为1秒
      fetchInterval: 1
      #canal客户端一次向canal服务器最多请求多少条数据,默认为100
      fetchSize: 100 
      #是否开启数据库列属性到java bean属性的下划线转驼峰映射,默认开启
      underlineToCamel: true
```

## 集群版本Canal

待更新

## 使用

1.拉取本项目,通过mvn install命令将项目安装到本地仓库

2.在项目中引入依赖

```xml
<dependency>
    <groupId>dhy.xpy</groupId>
    <artifactId>canal-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
```

3.配置相关参数

4.使用@CanalTable注解标注监听的表,并且继承CanalMessageListener接口

```java
@Component
@CanalTable("domain_event")
public class DomainEventHandler implements CanalMessageListener<DomainEvent> {
    
    @Override
    public void insert(DomainEvent domainEvent) {
        
    }

    @Override
    public void update(DomainEvent newRecord, DomainEvent oldRecord) {

    }

    @Override
    public void delete(DomainEvent oldRecord) {

    }
}
```