在Spring Boot微服务集成Kafka客户端(kafka-clients)操作Kafka

记录：459

场景：在Spring Boot微服务集成Kafka客户端kafka-clients-3.0.0操作Kafka。使用kafka-clients的原生KafkaProducer操作Kafka生产者Producer。使用kafka-clients的原生KafkaConsumer操作Kafka的消费者Consumer。

版本：JDK 1.8,Spring Boot 2.6.3,kafka_2.12-2.8.0,kafka-clients-3.0.0。

Kafka安装：https://blog.csdn.net/zhangbeizhen18/article/details/129071395

1.基础概念

Event：An event records the fact that "something happened" in the world or in your business. It is also called record or message in the documentation.

Broker：一个Kafka节点就是一个broker；多个Broker可以组成一个Kafka集群。

Topic：Kafka根据Topic对消息进行归类，发布到Kafka的每条消息都需要指定一个Topic。

Producer：消息生产者，向Broker发送消息的客户端。

Consumer：消息消费者，从Broker读取消息的客户端。

ConsumerGroup：每个Consumer属于一个特定的ConsumerGroup，一条消息可以被多个不同的ConsumerGroup消费；但是一个ConsumerGroup中只能有一个Consumer能够消费该消息。

Partition：一个topic可以分为多个partition，每个partition内部消息是有序的。

publish：发布，使用Producer向Kafka写入数据。

subscribe：订阅，使用Consumer从Kafka读取数据。

2.微服务中配置Kafka信息

(1)在pom.xml添加依赖

pom.xml文件：

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

解析：使用原生的kafka-clients，版本：3.0.0。操作kafka的生产者、消费、Topic。

3.配置Kafka生产者和消费者

使用原生的kafka-clients，需配置KafkaProducer和KafkaConsumer，把Kafka的配置信息注入到这两个对象，便可以操作了生产者和消费者。

配置细节在官网的configuration：https://kafka.apache.org/documentation/

3.1配置KafkaProducer生产者

(1)示例代码

@Configuration
public class KafkaConfig {
  @Bean
  public KafkaProducer kafkaProducer() {
    Map<String, Object> configs = new HashMap<>();
    //#kafka服务端的IP和端口,格式:(ip:port)
    configs.put("bootstrap.servers", "192.168.19.203:29001");
    //客户端发送服务端失败的重试次数
    configs.put("retries", 2);
    //多个记录被发送到同一个分区时,生产者将尝试将记录一起批处理成更少的请求.
    //此设置有助于提高客户端和服务器的性能,配置控制默认批量大小(以字节为单位)
    configs.put("batch.size", 16384);
    //生产者可用于缓冲等待发送到服务器的记录的总内存字节数(以字节为单位)
    configs.put("buffer-memory", 33554432);
    //生产者producer要求leader节点在考虑完成请求之前收到的确认数,用于控制发送记录在服务端的持久化
    //acks=0,设置为0,则生产者producer将不会等待来自服务器的任何确认.该记录将立即添加到套接字(socket)缓冲区并视为已发送.在这种情况下,无法保证服务器已收到记录,并且重试配置(retries)将不会生效(因为客户端通常不会知道任何故障),每条记录返回的偏移量始终设置为-1.
    //acks=1,设置为1,leader节点会把记录写入本地日志,不需要等待所有follower节点完全确认就会立即应答producer.在这种情况下,在follower节点复制前,leader节点确认记录后立即失败的话,记录将会丢失.
    //acks=all,acks=-1,leader节点将等待所有同步复制副本完成再确认记录,这保证了只要至少有一个同步复制副本存活,记录就不会丢失.
    configs.put("acks", "-1");
    //指定key使用的序列化类
    Serializer keySerializer = new StringSerializer();
    //指定value使用的序列化类
    Serializer valueSerializer = new StringSerializer();
    //创建Kafka生产者
    KafkaProducer kafkaProducer = new KafkaProducer(configs, keySerializer, valueSerializer);
    return kafkaProducer;
  }
}

(2)解析代码

把Kafka的配置信息注入到KafkaProducer，并创建KafkaProducer对象。

使用@Configuration和@Bean注解把KafkaProducer对象注入到Spring的IOC容器，在Spring环境就可以使用KafkaProducer了。

KafkaProducer的底层使用配置类是ProducerConfig，在配置时可以参考。

全称：org.apache.kafka.clients.producer.ProducerConfig。

3.2配置KafkaConsumer消费者

(1)示例代码

@Configuration
public class KafkaConfig {
  @Bean
  public KafkaConsumer kafkaConsumer() {
    Map<String, Object> configs = new HashMap<>();
    //kafka服务端的IP和端口,格式:(ip:port)
    configs.put("bootstrap.servers", "192.168.19.203:29001");
    //开启consumer的偏移量(offset)自动提交到Kafka
    configs.put("enable.auto.commit", true);
    //consumer的偏移量(offset) 自动提交的时间间隔,单位毫秒
    configs.put("auto.commit.interval", 5000);
    //在Kafka中没有初始化偏移量或者当前偏移量不存在情况
    //earliest, 在偏移量无效的情况下, 自动重置为最早的偏移量
    //latest, 在偏移量无效的情况下, 自动重置为最新的偏移量
    //none, 在偏移量无效的情况下, 抛出异常.
    configs.put("auto.offset.reset", "latest");
    //请求阻塞的最大时间(毫秒)
    configs.put("fetch.max.wait", 500);
    //请求应答的最小字节数
    configs.put("fetch.min.size", 1);
    //心跳间隔时间(毫秒)
    configs.put("heartbeat-interval", 3000);
    //一次调用poll返回的最大记录条数
    configs.put("max.poll.records", 500);
    //指定消费组
    configs.put("group.id", "hub-topic-city-01-group");
    //指定key使用的反序列化类
    Deserializer keyDeserializer = new StringDeserializer();
    //指定value使用的反序列化类
    Deserializer valueDeserializer = new StringDeserializer();
    //创建Kafka消费者
    KafkaConsumer kafkaConsumer = new KafkaConsumer(configs, keyDeserializer, valueDeserializer);
    return kafkaConsumer;
  }
}

(2)解析代码

把Kafka的配置信息注入到KafkaConsumer，并创建KafkaConsumer对象。

使用@Configuration和@Bean注解把KafkaConsumer对象注入到Spring的IOC容器，在Spring环境就可以使用KafkaConsumer了。

KafkaConsumer的底层使用配置类是ConsumerConfig，在配置时可以参考。

全称：org.apache.kafka.clients.consumer.ConsumerConfig。

4.使用KafkaProducer操作Kafka生产者Producer

使用原生kafka-clients的KafkaProducer操作Kafka生产者Producer。

KafkaProducer全称：org.apache.kafka.clients.producer.KafkaProducer。

(1)示例代码

@RestController
@RequestMapping("/hub/example/producer")
@Slf4j
public class UseKafkaProducerController {
  @Autowired
  private KafkaProducer kafkaProducer;
  private final String topicName = "hub-topic-city-02";
  @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.使用KafkaProducer向Kafka写入数据
        ProducerRecord<String, String> producerRecord = new ProducerRecord<>(topicName, cityStr);
        kafkaProducer.send(producerRecord);
    } catch (Exception e) {
        log.info("Producer写入Topic异常.");
        e.printStackTrace();
    }
    return "写入成功";
  }
}

(2)解析代码

创建ProducerRecord对象，指定指定Kafka的Topic名称和需要写入的数据。ProducerRecord就是需要写入Kafka中的一条数据，

使用KafkaProducer 的send方法，传入ProducerRecord，就能完成Producer向Kafka的Broker节点写入数据。

5.使用KafkaConsumer操作Kafka的消费者Consumer

使用原生kafka-clients的KafkaConsumer操作Kafka生产者Consumer。

KafkaConsumer全称：org.apache.kafka.clients.consumer.KafkaConsumer。

(1)示例代码

@Component
@Slf4j
public class UseKafkaConsumer implements InitializingBean {
  @Autowired
  private KafkaConsumer kafkaConsumer;
  private final String topicName = "hub-topic-city-02";
  @Override
  public void afterPropertiesSet() throws Exception {
    Thread thread = new Thread(() -> {
        log.info("启动线程监听Topic: {}", topicName);
        ThreadUtil.sleep(1000);
        Collection<String> topics = Lists.newArrayList(topicName);
        kafkaConsumer.subscribe(topics);
        while (true) {
            ConsumerRecords<String, String> consumerRecords = kafkaConsumer.poll(Duration.ofMillis(1000));
            for (ConsumerRecord consumerRecord : consumerRecords) {
                //1.从ConsumerRecord中获取消费数据
                String originalMsg = (String) consumerRecord.value();
                log.info("从Kafka中消费的原始数据: " + originalMsg);
                //2.把消费数据转换为DTO对象
                CityDTO cityDTO = JSONUtil.toBean(originalMsg, CityDTO.class);
                log.info("消费数据转换为DTO对象: " + cityDTO.toString());
            }
        }
    });
    thread.start();
  }
}

(2)解析代码

使用 while (true)实时遍历KafkaConsumer消费者，实质即使实时监听Kafka消费者。

使用KafkaConsumer的subscribe方法订阅需要监听的Kafka的Topic。

使用KafkaConsumer的poll方法轮询消费者获取消费消息ConsumerRecord。

从ConsumerRecord中获取具体消费的业务数据。

6.测试

(1)使用Postman测试，调用生产者写入数据

请求RUL：http://127.0.0.1:18209/hub-209-kafka/hub/example/producer/f01_1

(2)消费者自动消费数据

日志信息：

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

7.辅助类

@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日