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

向右看齐 2024-04-23 02:19 5阅读 0赞

**记录**：457

**场景**：在Spring Boot微服务集成Kafka客户端spring-kafka-2.8.2操作Kafka。使用Spring封装的KafkaTemplate操作Kafka生产者Producer。使用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.基础概念**

**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.springframework.kafka</groupId>
      <artifactId>spring-kafka</artifactId>
      <version>2.8.2</version>
    </dependency>

解析：spring-kafka选择一般是使用spring-boot集成的对应版本。

**请知悉**：spring-kafka框架底层使用了原生的kafka-clients。本例对应版本：3.0.0。

**(2)在application.yml中配置Kafka信息**

配置细节在官网的configuration：**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操作生产者Producer。

Spring的spring-kafka框架使用KafkaProperties和@KafkaListener操作Kafka的消费者Consumer

**3.使用KafkaTemplate操作Kafka生产者Producer**

在集成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的Topic名称和需要写入的数据，就能完成Producer向Kafka的Broker节点写入数据。

**4.使用@KafkaListener操作Kafka的消费者Consumer**

在集成spring-kafka后，操作Kafka的消费者Consumer相当容易，只需在指定方法上使用@KafkaListener注解，就能监听消费Kafka的Topic的消息。其它繁琐操作均交给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的Topic名称和消费者group Id，在注解作用的监听方法上使用ConsumerRecord作为函数入参，spring-kafka框架会自动把监听到的数据写入的ConsumerRecord中，在监听方法中，取出ConsumerRecord的数据，就是从Kafka节点消费的数据。

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