Debezium 支持

Debezium 引擎，变更数据捕获 (CDC) 入站通道适配器。DebeziumMessageProducer 允许捕获数据库变更事件，将它们转换为消息，然后流式传输到出站通道。

你需要将 Spring Integration Debezium 依赖项包含在你的项目中

Maven
Gradle

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-debezium</artifactId>
    <version>6.3.0</version>
</dependency>

compile "org.springframework.integration:spring-integration-debezium:6.3.0"

您还需要为输入数据库包含一个 Debezium 连接器依赖项。例如，要将 Debezium 与 PostgreSQL 一起使用，您将需要 postgres Debezium 连接器

Maven
Gradle

<dependency>
    <groupId>io.debezium</groupId>
    <artifactId>debezium-connector-postgres</artifactId>
    <version>${debezium-version}</version>
</dependency>

compile "io.debezium:debezium-connector-postgres:{debezium-version}"

将 debezium-version 替换为与正在使用的 spring-integration-debezium 版本兼容的版本。

入站 Debezium 通道适配器

Debezium 适配器需要一个预先配置的 DebeziumEngine.Builder<ChangeEvent<byte[], byte[]>> 实例。

debezium-supplier 提供了一个现成的 DebeziumEngine.Builder Spring Boot 自动配置，并带有方便的 DebeziumProperties 配置抽象。

Debezium Java DSL 可以从提供的 DebeziumEngine.Builder 以及普通 Debezium 配置（例如 java.util.Properties）创建 DebeziumMessageProducer 实例。后者对于一些具有自以为是的配置和序列化格式的常见用例非常方便。

此外，DebeziumMessageProducer 可以使用以下配置属性进行调整

contentType - 允许处理 JSON（默认）、AVRO 和 PROTOBUF 消息内容。contentType 必须 与为提供的 DebeziumEngine.Builder 配置的 SerializationFormat 一致。
enableBatch - 当设置为 false（默认）时，debezium 适配器将为从源数据库接收的每个 ChangeEvent 数据更改事件发送新的 Message。如果设置为 true，则适配器为从 Debezium 引擎接收的每个 ChangeEvent 批次向下游发送一个 Message。这样的有效负载不可序列化，需要自定义序列化/反序列化实现。
enableEmptyPayload - 启用对墓碑（又名删除）消息的支持。在数据库行删除时，Debezium 可以发送一个墓碑更改事件，该事件具有与已删除行相同的键和 Optional.empty 值。默认为 false。
headerMapper - 自定义 HeaderMapper 实现，允许选择和转换 ChangeEvent 头部到 Message 头部。默认的 DefaultDebeziumHeaderMapper 实现为 setHeaderNamesToMap 提供了一个 setter。默认情况下，所有头部都已映射。
taskExecutor - 为 Debezium 引擎设置一个自定义 TaskExecutor。

以下代码片段演示了此通道适配器的各种配置

使用 Java 配置进行配置

以下 Spring Boot 应用程序展示了如何使用 Java 配置配置入站适配器的示例

@SpringBootApplication
public class DebeziumJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(DebeziumJavaApplication.class)
                .web(WebApplicationType.NONE)
                .run(args);
    }

    @Bean
    public MessageChannel debeziumInputChannel() {
        return new DirectChannel();
    }

    @Bean
    public MessageProducer debeziumMessageProducer(
            DebeziumEngine.Builder<ChangeEvent<byte[], byte[]>> debeziumEngineBuilder,
            MessageChannel debeziumInputChannel) {

        DebeziumMessageProducer debeziumMessageProducer =
            new DebeziumMessageProducer(debeziumEngineBuilder);
        debeziumMessageProducer.setOutputChannel(debeziumInputChannel);
        return debeziumMessageProducer;
    }

    @ServiceActivator(inputChannel = "debeziumInputChannel")
    public void handler(Message<?> message) {

        Object destination = message.getHeaders().get(DebeziumHeaders.DESTINATION); (1)

        String key = new String((byte[]) message.getHeaders().get(DebeziumHeaders.KEY)); (2)

        String payload = new String((byte[]) message.getPayload()); (3)

        System.out.println("KEY: " + key + ", DESTINATION: " + destination + ", PAYLOAD: " + payload);
    }

}

1	事件目标的逻辑目标名称。目标通常由 `topic.prefix` 配置选项、数据库名称和表名称组成。例如：`my-topic.inventory.orders`。
2	包含已更改表的键和已更改行的实际键的架构。键架构及其对应的键负载都包含一个字段，用于连接器创建事件时已更改表中的每个 `PRIMARY KEY`（或唯一约束）列。
3	与键类似，负载具有架构部分和负载值部分。架构部分包含描述负载值部分的信封结构的架构，包括其嵌套字段。用于创建、更新或删除数据的操作的更改事件都具有具有信封结构的值负载。

key.converter.schemas.enable=false 和/或 value.converter.schemas.enable=false 允许分别禁用键或负载的邮件内架构内容。

类似地，我们可以配置 DebeziumMessageProducer 以批处理方式处理传入的更改事件

@Bean
public MessageProducer debeziumMessageProducer(
        DebeziumEngine.Builder<ChangeEvent<byte[], byte[]>> debeziumEngineBuilder,
        MessageChannel debeziumInputChannel) {

    DebeziumMessageProducer debeziumMessageProducer = new DebeziumMessageProducer(debeziumEngineBuilder);
	debeziumMessageProducer.setEnableBatch(true);
    debeziumMessageProducer.setOutputChannel(debeziumInputChannel);
    return debeziumMessageProducer;
}

@ServiceActivator(inputChannel = "debeziumInputChannel")
public void handler(List<ChangeEvent<Object, Object>> payload) {
    System.out.println(payload);
}

Debezium Java DSL 支持

spring-integration-debezium 通过 Debezium 工厂和 DebeziumMessageProducerSpec 实现提供了一个方便的 Java DSL fluent API。

Debezium Java DSL 的入站通道适配器是

 DebeziumEngine.Builder<ChangeEvent<byte[], byte[]>>   debeziumEngineBuilder = ...
 IntegrationFlow.from(
    Debezium.inboundChannelAdapter(debeziumEngineBuilder)
        .headerNames("special*")
        .contentType("application/json")
        .enableBatch(false))
    .handle(m -> System.out.println(new String((byte[]) m.getPayload())))

或从本机 Debezium 配置属性创建 DebeziumMessageProducerSpec 实例，并默认为 JSON 序列化格式。

 Properties debeziumConfig = ...
 IntegrationFlow
    .from(Debezium.inboundChannelAdapter(debeziumConfig))
    .handle(m -> System.out.println(new String((byte[]) m.getPayload())))

以下 Spring Boot 应用程序提供了一个使用 Java DSL 配置入站适配器的示例

@SpringBootApplication
public class DebeziumJavaApplication {

    public static void main(String[] args) {
        new SpringApplicationBuilder(DebeziumJavaApplication.class)
            .web(false)
            .run(args);
    }

    @Bean
    public IntegrationFlow debeziumInbound(
        DebeziumEngine.Builder<ChangeEvent<byte[], byte[]>> debeziumEngineBuilder) {

        return IntegrationFlow
                .from(Debezium
                        .inboundChannelAdapter(debeziumEngineBuilder)
					    .headerNames("special*")
					    .contentType("application/json")
					    .enableBatch(false))
                .handle(m -> System.out.println(new String((byte[]) m.getPayload())))
                .get();
    }

}