spring-kafkaのJava APIを使用してKafkaクラスタのトピックを操作する

記録: 462

シナリオ: Spring Boot マイクロサービスに spring-kafka-2.8.2 を統合して、Kafka クラスターを操作するためのトピックを作成および削除します。

バージョン：JDK 1.8、Spring Boot 2.6.3、kafka_2.12-2.8.0、spring-kafka-2.8.2。

Kafka クラスターのインストール: https://blog.csdn.net/zhangbeizhen18/article/details/131156084

1.マイクロサービスでKafka 情報を構成する

1.1 pom.xml に依存関係を追加する

pom.xml ファイル:

<dependency>
  <groupId>org.springframework.kafka</groupId>
  <artifactId>spring-kafka</artifactId>
  <version>2.8.2</version>
</dependency>

分析: spring-kafka の選択は、通常、spring-boot に統合された対応するバージョンです。

知っておいてください: spring-kafka フレームワークの最下層はネイティブの kafka クライアントを使用します。この例はバージョン 3.0.0 に対応します。

1.2 application.yml で Kafka 情報を構成する

設定の詳細は、公式 Web サイトの設定にあります: https://kafka.apache.org/documentation/

(1) application.ymlの設定内容

spring:
  kafka:
    #kafka集群的IP和端口,格式:(ip:port)
    bootstrap-servers:
      - 192.168.19.161:29092
      - 192.168.19.162:29092
      - 192.168.19.163:29092
    #生产者
    producer:
      #客户端发送服务端失败的重试次数
      retries: 2
      #多个记录被发送到同一个分区时,生产者将尝试将记录一起批处理成更少的请求.
      #此设置有助于提高客户端和服务器的性能,配置控制默认批量大小(以字节为单位)
      batch-size: 16384
      #生产者可用于缓冲等待发送到服务器的记录的总内存字节数(以字节为单位)
      buffer-memory: 33554432
      #指定key使用的序列化类
      key-serializer: org.apache.kafka.common.serialization.StringSerializer
      #指定value使用的序列化类
      value-serializer: org.apache.kafka.common.serialization.StringSerializer
      #生产者producer要求leader节点在考虑完成请求之前收到的确认数,用于控制发送记录在服务端的持久化
      #acks=0,设置为0,则生产者producer将不会等待来自服务器的任何确认.该记录将立即添加到套接字(socket)缓冲区并视为已发送.在这种情况下,无法保证服务器已收到记录,并且重试配置(retries)将不会生效(因为客户端通常不会知道任何故障),每条记录返回的偏移量始终设置为-1.
      #acks=1,设置为1,leader节点会把记录写入本地日志,不需要等待所有follower节点完全确认就会立即应答producer.在这种情况下,在follower节点复制前,leader节点确认记录后立即失败的话,记录将会丢失.
      #acks=all,acks=-1,leader节点将等待所有同步复制副本完成再确认记录,这保证了只要至少有一个同步复制副本存活,记录就不会丢失.
      acks: -1
    consumer:
      #开启consumer的偏移量(offset)自动提交到Kafka
      enable-auto-commit: true
      #consumer的偏移量(offset)自动提交的时间间隔,单位毫秒
      auto-commit-interval: 1000
      #在Kafka中没有初始化偏移量或者当前偏移量不存在情况
      #earliest,在偏移量无效的情况下,自动重置为最早的偏移量
      #latest,在偏移量无效的情况下,自动重置为最新的偏移量
      #none,在偏移量无效的情况下,抛出异常.
      auto-offset-reset: latest
      #一次调用poll返回的最大记录条数
      max-poll-records: 500
      #请求阻塞的最大时间(毫秒)
      fetch-max-wait: 500
      #请求应答的最小字节数
      fetch-min-size: 1
      #心跳间隔时间(毫秒)
      heartbeat-interval: 3000
      #指定key使用的反序列化类
      key-deserializer: org.apache.kafka.common.serialization.StringDeserializer
      #指定value使用的反序列化类
      value-deserializer: org.apache.kafka.common.serialization.StringDeserializer

(2) 分析

構成クラスには、Spring Boot パッケージ spring-boot-autoconfigure-2.6.3.jar で自動的にアノテーションが付けられます。

分類：org.springframework.boot.autoconfigure.kafka.KafkaProperties。

@ConfigurationProperties アノテーションを使用して有効にします。プレフィックスは spring.kafka です。

spring-kafka フレームワークには、Kafka スタンドアロンバージョンと Kafka クラスターバージョンを操作するための異なる構成があります。

bootstrap-servers 属性では、スタンドアロンバージョンは IP: ポートのペアで構成されます。クラスターバージョンは、複数の IP: ポートのペアで構成できます。

1.3 ロジックのロード

Spring Boot マイクロサービスが開始されると、Spring Boot は application.yml の構成情報を読み取り、構成内容に従って spring-boot-autoconfigure-2.6.3.jar 内の KafkaProperties を見つけて、対応するプロパティに注入します。Spring Boot マイクロサービスが開始されると、Spring 環境で KafkaProperties の構成情報を取得できるようになります。

Spring の spring-kafka フレームワークは、KafkaProperties 構成情報を KafkaAdmin に挿入します。

KafkaAdminClientを使用してAdminClientを作成し、AdminClientを使用してTopicを操作します。

2. AdminClient を使用して Kafka クラスターのトピックを作成します

AdminClient全称：org.apache.kafka.clients.admin.AdminClient

spring-kafka は統合されていますが、Kafka クラスターのトピックの操作に関しては、主に kafka-clients の API が使用されます。

(1) サンプルコード

@RestController
@RequestMapping("/hub/example/cluster/topic")
@Slf4j
public class OperateKafkaClusterTopicController {
  @Autowired
  private KafkaAdmin kafkaAdmin;
  private final String topicName = "hub-topic-city-info-001";
  @GetMapping("/f01_1")
  public Object f01_1() {
      try {
          //1.获取Kafka集群配置信息
          Map<String, Object> configs = kafkaAdmin.getConfigurationProperties();
          //2.创建客户端AdminClient
          AdminClient adminClient = KafkaAdminClient.create(configs);
          //3.获取Kafka集群中Topic清单
          Set<String> topicSet = adminClient.listTopics().names().get();
          log.info("在Kafka集群已建Topic数量: {} ,清单:", topicSet.size());
          topicSet.forEach((topic) -> {
              System.out.println("" + topic);
          });
          //4.在Kafka集群创建Topic
          if (!topicSet.contains(topicName)) {
              log.info("新建Topic: {}", topicName);
              // Topic名称,分区Partition数目,复制因子(replication Factor)
              NewTopic newTopic = new NewTopic(topicName, 1, (short) 1);
              Collection<NewTopic> newTopics = Lists.newArrayList(newTopic);
              adminClient.createTopics(newTopics);
              ThreadUtil.sleep(1000);
              topicSet = adminClient.listTopics().names().get();
              log.info("创建后,在Kafka集群已建Topic数量: {} ,清单:", topicSet.size());
              topicSet.forEach((topic) -> {
                  System.out.println(topic);
              });
          }
      } catch (Exception e) {
          log.info("创建Topic异常.");
          e.printStackTrace();
      }
      return "创建成功";
  }
}

(2) 解析コード

spring-kafka フレームワークに挿入された KafkaAdmin の主な目的は、構成コンテンツを取得することです。

Kafka クラスターのトピックを操作するには、まず AdminClient を作成し、AdminClient API を使用してトピックを作成する必要があります。

トピックを作成するには、トピック名、パーティションの数、レプリケーション係数を指定するだけです。

3. AdminClient を使用して Kafka クラスターのトピックを削除します

AdminClient全称：org.apache.kafka.clients.admin.AdminClient

spring-kafka は統合されていますが、Kafka クラスターのトピックの操作に関しては、主に kafka-clients の API が使用されます。

(1) サンプルコード

@RestController
@RequestMapping("/hub/example/cluster/topic")
@Slf4j
public class OperateKafkaClusterTopicController {
  @Autowired
  private KafkaAdmin kafkaAdmin;
  private final String topicName = "hub-topic-city-info-001";
  @GetMapping("/f01_2")
  public Object f01_2() {
      try {
          //1.获取Kafka集群配置信息
          Map<String, Object> configs = kafkaAdmin.getConfigurationProperties();
          //2.创建客户端AdminClient
          AdminClient adminClient = KafkaAdminClient.create(configs);
          //3.获取Kafka集群中Topic清单
          Set<String> topicSet = adminClient.listTopics().names().get();
          log.info("在Kafka集群已建Topic数量: {} ,清单:", topicSet.size());
          topicSet.forEach((topic) -> {
              System.out.println("" + topic);
          });
          //4.在Kafka集群删除Topic
          if (topicSet.contains(topicName)) {
              log.info("删除Topic: {}", topicName);
              Collection<String> topics = Lists.newArrayList(topicName);
              DeleteTopicsResult deleteTopicsResult = adminClient.deleteTopics(topics);
              deleteTopicsResult.all().get();
              ThreadUtil.sleep(1000);
              topicSet = adminClient.listTopics().names().get();
              log.info("删除后,在Kafka集群已建Topic数量: {} ,清单:", topicSet.size());
              topicSet.forEach((topic) -> {
                  System.out.println(topic);
              });
          }
      } catch (Exception e) {
          log.info("删除Topic异常.");
          e.printStackTrace();
      }
      return "删除成功";
  }
}

(2) 解析コード

spring-kafka フレームワークに挿入された KafkaAdmin の主な目的は、構成コンテンツを取得することです。

Kafka クラスターのトピックを操作するには、まず AdminClient を作成し、AdminClient の API を使用してトピックを削除する必要があります。

トピックを作成するには、トピック名を指定するだけです。

4. テスト

リクエスト RUL の作成: http://127.0.0.1:18208/hub-208-kafka/hub/example/cluster/topic/f01_1

削除リクエスト RUL: http://127.0.0.1:18208/hub-208-kafka/hub/example/cluster/topic/f01_2

以上、ありがとうございます。

2023 年 6 月 18 日

spring-kafkaのJava APIを使用してKafkaクラスタのトピックを操作する

おすすめ