AI 助理
备案控制台
文档
输入文档关键字查找
首页 数据传输服务 操作指南 数据订阅（新控制台） 消费订阅数据 使用SDK示例代码消费订阅数据

使用SDK示例代码消费订阅数据

更新时间：
产品详情
相关技术圈
我的收藏
重要

本文中含有需要您注意的重要提示信息，忽略该信息可能对您的业务造成影响，请务必仔细阅读。

在完成数据订阅通道的配置（创建好订阅任务和消费组）后，您可以自行编写SDK示例代码或使用DTS提供的SDK示例代码来订阅数据变更信息，本文介绍示例代码的使用方法。

重要

本操作为Java语言的SDK客户端示例，Python和Go语言的示例代码，请参见dts-subscribe-demo。

操作步骤

说明

本文以IntelliJ IDEA软件（Community Edition 2020.1 Windows版本）为例，介绍如何运行SDK示例代码来消费订阅数据。

  1. 创建新版数据订阅通道，详情请参见订阅方案概览中的相关配置文档。
  2. 创建一个或多个消费组，详情请参见新增消费组。

  3. 根据业务需求，使用SDK示例代码。

    重要

    在消费订阅数据时，您需要调用DefaultUserRecord的commit方法以提交位点信息，否则会导致数据重复消费。

    • 使用打包好的新版订阅SDK（推荐）

      1. 打开IntelliJ IDEA软件，然后单击Create New Project，新建一个业务Project。

      2. 在新建的业务Project中，找到项目对象模型文件：pom.xml。

      3. 在pom.xml中添加如下依赖：

        <dependency>
    <groupId>com.aliyun.dts</groupId>
    <artifactId>dts-new-subscribe-sdk</artifactId>
    <version>{dts_new_sdk_version}</version>
</dependency>
        重要

        • 您可以在dts-new-subscribe-sdk页面查看最新Maven依赖。

        • dts-new-subscribe-sdk中封装了一个原生依赖：

          <dependency>
  <groupId>org.apache.kafka</groupId>
  <artifactId>kafka-clients</artifactId>
  <version>{version}</version>
</dependency>

        • 2.0.0版本的dts-new-subscribe-sdk封装的是2.7版本的kafka-clients，2.0.0以下版本封装的是1.0.0版本的kafka-clients。

      4. 参考使用示例代码使用新版订阅SDK。

    • 使用定制修改后的新版订阅SDK

      1. 下载SDK示例代码文件，然后解压该文件。

        说明

        单击code，然后选择Download ZIP下载文件。

      2. 定位至SDK示例代码解压的目录，使用文本编辑工具打开pom.xml文件，将数据订阅SDK的版本修改为最新版本。设置SDK版本

        重要

        • 您可以在dts-new-subscribe-sdk页面查看最新Maven依赖。

        • dts-new-subscribe-sdk中封装了一个原生依赖：

          <dependency>
  <groupId>org.apache.kafka</groupId>
  <artifactId>kafka-clients</artifactId>
  <version>{version}</version>
</dependency>

        • 2.0.0版本的dts-new-subscribe-sdk封装的是2.7版本的kafka-clients，2.0.0以下版本封装的是1.0.0版本的kafka-clients。

      3. 打开IntelliJ IDEA软件，然后单击Open or Import。打开工程

      4. 在弹出的对话框中，定位至SDK示例代码解压的目录，依次展开文件夹，找到项目对象模型文件：pom.xml。找到项目对象模型文件

      5. 在弹出对话框中，选择Open as Project。

      6. 在IntelliJ IDEA软件界面，依次展开文件夹，并根据 SDK客户端的使用模式，选择并双击打开对应的Java文件：DTSConsumerAssignDemo.java或DTSConsumerSubscribeDemo.java。java客户端文件

        说明

        DTS支持以下两种SDK客户端的使用模式：

        • ASSIGN模式：DTS为了保证消息的全局有序，每个订阅Topic只有一个partition，且固定分配至partition 0中。当SDK客户端的使用模式为ASSIGN模式时，建议只启动一个SDK客户端。

        • SUBSCRIBE模式：DTS为了保证消息的全局有序，每个订阅Topic只有一个partition，且固定分配至partition 0中。当SDK客户端的使用模式为SUBSCRIBE模式时，您可以在一个消费组下同时启动多个SDK客户端，以实现灾备。实现原理是当消费组下的正常消费数据的客户端发生故障后，其他的SDK客户端将随机且自动地分配到partition 0，继续消费。

  4. 设置Java文件代码中的必填参数。

    assigndemo

    表 1. 必填参数说明

    参数

    说明

    获取方式

    brokerUrl

    数据订阅通道的网络地址及端口号信息。

    说明

    • 如果您部署SDK客户端所属的ECS实例与数据订阅通道属于经典网络或同一专有网络，建议通过内网地址进行数据订阅，网络延迟最小。

    • 不建议使用公网地址。

    在DTS控制台单击目标订阅实例ID，在基本信息页面的网络区域，您可以获取网络地址及端口号信息。

    topic

    数据订阅通道的订阅Topic。

    在DTS控制台单击目标订阅实例ID，在基本信息页面的基本信息区域，您可以获取到订阅Topic。

    sid

    消费组ID。

    在DTS控制台单击目标订阅实例ID，然后单击数据消费，您可以获取到消费组ID/名称和消费组的账号信息。

    说明

    消费组账号的密码已在您新建消费组时指定。

    userName

    消费组的账号。

    警告

    如您未使用本文提供的客户端，请按照<消费组的账号>-<消费组ID>的格式设置用户名（例如：dtstest-dtsae******bpv），否则无法正常连接。

    password

    该账号的密码。

    initCheckpoint

    消费位点，即SDK客户端消费第一条数据的时间戳，格式为Unix时间戳，例如1620962769。

    说明

    消费位点信息可用于：

    • 当业务程序中断后，传入已消费位点继续消费数据，防止数据丢失。

    • 在订阅客户端启动时，传入所需的消费位点，调整订阅位点，实现按需消费数据。

    消费位点必须在订阅实例的数据范围之内，并需转化为Unix时间戳。

    说明

    • 您可以在订阅任务列表的数据范围列，查看订阅实例的数据范围。

    • Unix时间戳转换工具可用搜索引擎获取。

    ConsumerContext.ConsumerSubscribeMode subscribeMode

    SDK客户端的使用模式，取值为：

    • ConsumerContext.ConsumerSubscribeMode.ASSIGN：ASSIGN模式，即一个消费组下仅支持一个SDK客户端消费订阅数据。

    • ConsumerContext.ConsumerSubscribeMode.SUBSCRIBE：SUBSCRIBE模式，即支持在同一个消费组下同时启动多个SDK客户端实现灾备。

    无

  5. 在IntelliJ IDEA软件界面的顶部，选择Run > Run运行该客户端。

    说明

    首次运行时，软件需要一定时间自动加载相关依赖包并完成安装。

    • 运行结果如下图所示，该客户端可正常订阅到源库的数据变更信息。消费数据

    • SDK客户端每隔一定时间会统计并显示消费数据的信息，包括数据发送和接受时数据总数、数据总量、每秒请求数接收RPS等。统计信息

      表 2. 消费数据的统计信息

      参数

      说明

      outCounts

      SDK客户端所消费的数据总数。

      outBytes

      SDK客户端所消费的数据总量，单位为Byte。

      outRps

      SDK客户端消费数据时的每秒请求数。

      outBps

      SDK客户端消费数据时每秒传送的比特数。

      inBytes

      DTS服务器发送的数据总量，单位为Byte。

      DStoreRecordQueue

      DTS服务器发送数据时，当前数据缓存队列的大小。

      inCounts

      DTS服务器发送数据总数。

      inRps

      DTS服务器发送数据时的每秒请求数。

      __dt

      SDK客户端接收到数据的当前时间戳，单位为毫秒。

      DefaultUserRecordQueue

      序列化后，当前数据缓存队列的大小。

管理消费位点

当SDK客户端首次启动、重启或者发生内部重试时，您需要查询并传入 消费位点，开始或重新消费数据。下文将介绍在不同情况下如何管理和查询消费位点，以确保数据不丢失，且尽量不重复，实现按需消费。

若您需要重置客户端的消费位点，可以根据订阅的模式（SDK使用模式）参考下表查询消费位点并进行修改。

场景

SDK使用模式

位点管理方式

查询消费位点

ASSIGN模式、SUBSCRIBE模式

  • 由于SDK客户端每5秒保存一次消息位点，并提交至DTS服务器，如需查询最近一次消费位点，您可通过以下路径查询：

    • SDK客户端所在服务器的localCheckpointStore文件。

    • 订阅通道的数据消费界面。

  • 如您在consumerContext.java文件中setUserRegisteredStore(new UserMetaStore())配置了外部的持久化共享存储介质（如数据库），该存储介质每5秒会保存一次消息位点，供您查询。

首次启动SDK客户端，需传入消费位点，来消费数据。

ASSIGN模式、SUBSCRIBE模式

根据SDK客户端使用模式，选择Java文件DTSConsumerAssignDemo.java或DTSConsumerSubscribeDemo.java，并配置消费位点initCheckpoint进行消费。配置方式，请参见3和4。

SDK客户端因内部重试，需重新传入上一个记录的消费位点，以继续消费数据。

ASSIGN模式

按如下顺序，查找上一个记录的消费位点，找到即可返回位点信息：

  1. 您在consumerContext.java文件中setUserRegisteredStore(new UserMetaStore())配置的外部存储介质。

  2. SDK客户端所在服务器的localCheckpointStore文件。

  3. 您在DTSConsumerSubscribeDemo.java文件中initCheckpoint传入的开始时间戳（start timestamp）。

SUBSCRIBE模式

按如下顺序，查找上一个记录的消费位点，找到即可返回位点信息：

  1. 您在consumerContext.java文件中setUserRegisteredStore(new UserMetaStore())配置的外部存储介质。

  2. DTS Server（增量数据采集模块）保存的位点。

    说明

    SDK客户端调用commit方法更新消费位点后，此位点才会更新。

  3. 您在DTSConsumerSubscribeDemo.java文件中initCheckpoint传入的开始时间戳（start timestamp）。

  4. 使用DTS Server（新建增量数据采集模块）的起始位点。

    重要

    如果增量数据采集模块发生了切换，新建的增量数据采集模块将无法保存客户端上次的消费位点信息，可能会导致从一个较旧的位点开始消费订阅数据。建议您在客户端持久化存储消费位点，详情请参见持久化存储消费位点。

已重启SDK客户端，需重新传入上一个记录的消费位点，以继续消费数据。

ASSIGN模式

根据consumerContext.java文件中setForceUseCheckpoint配置情况，查询消费位点，找到即可返回位点信息：

  • 配置为true时，每次重启SDK客户端，都会强制使用传入的initCheckpoint作为消费位点。

  • 配置为false或者没有配置时，请按如下顺序，查找上一个记录的消费位点：

    1. SDK客户端所在服务器的localCheckpointStore文件。

    2. DTS Server（增量数据采集模块）保存的位点。

      说明

      SDK客户端调用commit方法更新消费位点后，此位点才会更新。

    3. 您在consumerContext.java文件中setUserRegisteredStore(new UserMetaStore())配置的外部存储介质。

SUBSCRIBE模式

该模式下consumerContext.java文件中setForceUseCheckpoint配置不生效，请按如下顺序，查找上一个记录的消费位点：

  1. 您在consumerContext.java文件中setUserRegisteredStore(new UserMetaStore())配置的外部存储介质。

  2. DTS Server（增量数据采集模块）保存的位点。

    说明

    SDK客户端调用commit方法更新消费位点后，此位点才会更新。

  3. 您在DTSConsumerSubscribeDemo.java文件中initCheckpoint传入的开始时间戳（start timestamp）。

  4. 使用DTS Server（新建增量数据采集模块）的起始位点。

持久化存储消费位点

如果增量数据采集模块触发容灾机制（特别是SUBSCRIBE模式），新建的增量数据采集模块将无法保存客户端上次的消费位点信息，可能会导致客户端从一个较旧的位点开始消费订阅数据，从而造成历史数据的重复消费。例如：增量数据服务切换前，老的增量数据采集模块位点范围为2023年11月11日 08:00:00~ 2023年11月12日 08:00:00，客户端的消费位点为2023年11月12日 08:00:00；增量数据服务切换后，新的增量数据采集模块位点范围为2023年11月08日 10:00:00~ 2023年11月12日 08:01:00，那么客户端会从新的增量数据采集模块的起始位点2023年11月08日 10:00:00开始消费，造成重复消费历史数据。

为了规避这种切换场景对历史数据的重复消费，建议您在客户端配置一个在客户端保存的消费位点持久化存储方式。示例方法如下，您可以根据实际情况进行修改。

  1. 创建一个UserMetaStore()方法，继承实现AbstractUserMetaStore()方法。

    例如使用MySQL数据库存储位点信息，Java示例代码如下：

    public class UserMetaStore extends AbstractUserMetaStore {

    @Override
    protected void saveData(String groupID, String toStoreJson) {
        Connection con = getConnection();
			  String sql = "insert into dts_checkpoint(group_id, checkpoint) values(?, ?)";

        PreparedStatement pres = null;
        ResultSet rs = null;

        try {
            pres = con.prepareStatement(sql);
            pres.setString(1, groupID);
            pres.setString(2, toStoreJson);
            pres.execute();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            close(rs, pres, con);
        }
    }

    @Override
    protected String getData(String groupID) {
        Connection con = getConnection();
			  String sql = "select checkpoint from dts_checkpoint where group_id = ?";

        PreparedStatement pres = null;
        ResultSet rs = null;

        try {
            pres = con.prepareStatement(sql);
            pres.setString(1, groupID);
						ResultSet rs = pres.executeQuery()
                          
            String checkpoint = rs.getString("checkpoint");
          
            return checkpoint;
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            close(rs, pres, con);
        }
    }
}

  2. 在consumerContext.java文件中的setUserRegisteredStore(new UserMetaStore())方法，配置外部存储介质。

常见问题

  • 无法连接订阅实例，如何处理？

    请根据报错提示进行排查，详情请参见问题排查。

  • 持久化后的消费位点是什么格式的数据？

    消费位点在持久化处理后，将返回JSON格式的数据。其中，持久化后的消费位点的格式为Unix时间戳，您可以直接将其传回SDK进行使用。如下返回数据中，"timestamp"后的1700709977即为持久化后的消费位点。

    {"groupID":"dtsglg11d48230***","streamCheckpoint":[{"partition":0,"offset":577989,"topic":"ap_southeast_1_vpc_rm_t4n22s21iysr6****_root_version2","timestamp":1700709977,"info":""}]}

  • 订阅任务是否支持多个客户端并行消费？

    不支持。SUBSCRIBE模式允许多个客户端并行，但只有一个客户端可以消费到数据。

  • 是否支持使用Python或Go语言消费订阅数据？

    支持。Python和Go语言的示例代码，请参见dts-subscribe-demo。

问题排查

问题

报错提示

原因

解决方法

无法连接

ERROR
CheckResult{isOk=false, errMsg='telnet dts-cn-hangzhou.aliyuncs.com:18009
failed, please check the network and if the brokerUrl is correct'}
(com.aliyun.dts.subscribe.clients.DefaultDTSConsumer)

brokerUrl填写错误。

填入正确的brokerUrl、userName和password，查询方式，请参见必填参数说明。

telnet real node *** failed, please check the network

无法通过broker地址连接真实的IP地址。

ERROR CheckResult{isOk=false, errMsg='build kafka consumer failed, error: org.apache.kafka.common.errors.TimeoutException: Timeout expired while fetching topic metadata, probably the user name or password is wrong'} (com.aliyun.dts.subscribe.clients.DefaultDTSConsumer)

用户名和密码错误。

com.aliyun.dts.subscribe.clients.exception.TimestampSeekException: RecordGenerator:seek timestamp for topic [cn_hangzhou_rm_bp11tv2923n87081s_rdsdt_dtsacct-0] with timestamp [1610249501] failed

consumerContext.java文件中 setUseCheckpoint配置为true，但消费位点不在订阅实例的数据范围之内。

传入在订阅实例的数据范围之内的消费位点，查询方式，请参见必填参数说明。

消费订阅速度变慢

无

  • 通过查询统计信息中的参数DStoreRecordQueue和DefaultUserRecordQueue队列的大小，分析消费数据变慢的原因。查询方式，请参见消费数据的统计信息。

    • 如参数DStoreRecordQueue保持为0，则表示DTS服务器拉取数据速度变慢。

    • 如参数DefaultUserRecordQueue保持为默认值512，则表示SDK客户端消费数据的速度变慢。

  • 根据实际情况，修改代码中的消费位点（initCheckpoint）进行重置位点。

上一篇：管理消费组下一篇：使用SDK示例代码消费PolarDB-X 1.0订阅数据
文档推荐