Kafka クライアント (spring-kafka) を統合して Spring Boot マイクロサービスで Kafka を操作する

記録: 457

シナリオ: Kafka クライアント spring-kafka-2.8.2 を統合して、Spring Boot マイクロサービスで Kafka を操作します。Spring によってカプセル化された KafkaTemplate を使用して、Kafka プロデューサーであるプロデューサーを操作します。Spring でカプセル化された @KafkaListener を使用して、Kafka のコンシューマー Consumer を操作します。

バージョン：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/129071395

1. 基本的な考え方

イベント：イベントは、世の中やあなたのビジネスで「何かが起こった」という事実を記録します。ドキュメントではレコードまたはメッセージとも呼ばれます。

ブローカー: Kafka ノードはブローカーであり、複数のブローカーで Kafka クラスターを形成できます。

トピック: Kafka はトピックに従ってメッセージを分類し、Kafka にパブリッシュされる各メッセージはトピックを指定する必要があります。

プロデューサー: メッセージプロデューサー、つまりブローカーにメッセージを送信するクライアント。

Consumer : メッセージコンシューマー、ブローカーからメッセージを読み取るクライアント。

ConsumerGroup : 各 Consumer は特定の ConsumerGroup に属しており、メッセージは複数の異なる ConsumerGroup によって消費できますが、ConsumerGroup 内の 1 つの Consumer のみがメッセージを消費できます。

パーティション: トピックは複数のパーティションに分割でき、各パーティションの内部メッセージは順序付けされます。

public : パブリッシュし、プロデューサーを使用してデータを Kafka に書き込みます。

submit : サブスクライブし、Consumer を使用して Kafka からデータを読み取ります。

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

(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 に対応します。

(2) application.ymlにKafka情報を設定する

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

(1) application.ymlの設定内容

spring:
  kafka:
    #kafka服务端的IP和端口,格式:(ip:port)
    bootstrap-servers: 192.168.19.203:29001
    #生产者
    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 です。

(3) ロードロジック

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

Spring の spring-kafka フレームワークは、KafkaProperties 構成情報を KafkaTemplate 操作プロデューサーのプロデューサーに挿入します。

Spring の spring-kafka フレームワークは、KafkaProperties と @KafkaListener を使用して、Kafka のコンシューマー Consumer を操作します。

3. KafkaTemplateを利用してKafkaプロデューサー・プロデューサーを操作する

spring-kafkaを統合すると、Kafkaを操作するProducerが非常に簡素化され、KafkaTemplateをインジェクトするだけで操作できるようになりました。その他の面倒なオブジェクト生成は、処理のために spring-kafka フレームワークに渡されます。

KafkaTemplate正式名称：org.springframework.kafka.core.KafkaTemplate。

(1) サンプルコード

@RestController
@RequestMapping("/hub/example/producer")
@Slf4j
public class OperateKafkaProducerController {
  @Autowired
  private KafkaTemplate<String, String> kafkaTemplate;
  private final String topicName = "hub-topic-city-01";
  @GetMapping("/f01_1")
  public Object f01_1() {
    try {
       //1.获取业务数据
       CityDTO cityDTO = CityDTO.buildDto(2023061501L, "杭州", "杭州是一个好城市");
       String cityStr = JSONObject.toJSONString(cityDTO);
       log.info("向Kafka的Topic: {} ,写入数据:", topicName);
       log.info(cityStr);
       //2.使用KafkaTemplate向Kafka写入数据
       kafkaTemplate.send(topicName, cityStr);
    } catch (Exception e) {
       log.info("Producer写入Topic异常.");
       e.printStackTrace();
    }
    return "写入成功";
  }
}

(2) 解析コード

KafkaTemplate の send メソッドを使用して、Kafka のトピック名と書き込むデータを指定すると、プロデューサーは Kafka の Broker ノードにデータを書き込むことができます。

4. @KafkaListener を使用して Kafka のコンシューマ Consumer を操作します

spring-kafka を統合した後は、Kafka のコンシューマー Consumer を操作するのが非常に簡単になり、指定されたメソッドで @KafkaListener アノテーションを使用するだけで、Kafka を使用するトピックのニュースを聞くことができます。他の面倒な操作は、処理のために spring-kafka フレームワークに渡されます。

アノテーション KafkaListener の完全名: org.springframework.kafka.annotation.KafkaListener。

(1) サンプルコード

@Component
@Slf4j
public class OperateKafkaConsumer {
  private final String topicName = "hub-topic-city-01";
  @KafkaListener(
        topics = {topicName},
        groupId = "hub-topic-city-01-group")
  public void consumeMsg(ConsumerRecord<?, ?> record) {
    try {
        //1.从ConsumerRecord中获取消费数据
        String originalMsg = (String) record.value();
        log.info("从Kafka中消费的原始数据: " + originalMsg);
        //2.把消费数据转换为DTO对象
        CityDTO cityDTO = JSONUtil.toBean(originalMsg, CityDTO.class);
        log.info("消费数据转换为DTO对象: " + cityDTO.toString());
    } catch (Exception e) {
        log.info("Consumer消费Topic异常.");
        e.printStackTrace();
    }
  }
}

(2) 解析コード

@KafkaListener アノテーションを使用して Kafka のトピック名とコンシューマグループ ID を指定し、ConsumerRecord をアノテーションのリスニングメソッドの関数入力パラメータとして使用します。spring-kafka フレームワークは、監視されたデータを ConsumerRecord に自動的に書き込みます。上記では、Kafka ノードから消費されるデータである ConsumerRecord のデータを取り出します。

5. テスト

(1) Postman テストを使用してプロデューサーを呼び出してデータを書き込む

RUL のリクエスト: http://127.0.0.1:18208/hub-208-kafka/hub/example/Producer/f01_1

(2) 消費者が自動的にデータを消費する

ログ情報:

向Kafka的Topic: hub-topic-city-01 ,写入数据:
{"cityDescribe":"杭州是一个好城市","cityId":2023061501,"cityName":"杭州","updateTime":"2023-06-17 11:29:58"}
从Kafka中消费的原始数据: {"cityDescribe":"杭州是一个好城市","cityId":2023061501,"cityName":"杭州","updateTime":"2023-06-17 11:29:58"}
消费数据转换为DTO对象: CityDTO(cityId=2023061501, cityName=杭州, cityDescribe=杭州是一个好城市, updateTime=Sat Jun 17 11:29:58 CST 2023)

6. 補助クラス

@Data
@Builder
public class CityDTO {
  private Long cityId;
  private String cityName;
  private String cityDescribe;
  @JsonFormat(
          pattern = "yyyy-MM-dd HH:mm:ss"
  )
  private Date updateTime;
  public static CityDTO buildDto(Long cityId, String cityName,
                                 String cityDescribe) {
      return builder().cityId(cityId)
              .cityName(cityName).cityDescribe(cityDescribe)
              .updateTime(new Date()).build();
  }
}

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

2023 年 6 月 17 日

Kafka クライアント (spring-kafka) を統合して Spring Boot マイクロサービスで Kafka を操作する

おすすめ