使用Kafka客户端(spring-kafka)的Java API操作Kafka的Topic

梦里梦外; 2024-04-23 02:20 7阅读 0赞

**记录**：458

**场景**：在Spring Boot微服务集成Kafka客户端spring-kafka-2.8.2操作Kafka的Topic的创建和删除。

**版本**：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信息**

**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-clients。本例对应版本：3.0.0。

**1.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。

**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的Topic**

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

尽管集成spring-kafka，但是在操作Kafka的Topic方面，主要还是以kafka-clients的API为主。

(1)示例代码

@RestController
    @RequestMapping("/hub/example/topic")
    @Slf4j
    public class OperateKafkaTopicController {
      @Autowired
      private KafkaAdmin kafkaAdmin;
      private String topicName = "hub-topic-city-01";
      @GetMapping("/f01_1")
      public Object f01_1() {
        try {
            //1.获取Kafka配置信息
            Map<String, Object> configs = kafkaAdmin.getConfigurationProperties();
            //2.创建客户端AdminClient
            AdminClient adminClient = KafkaAdminClient.create(configs);
            //3.获取Topic清单
            Set<String> topicSet = adminClient.listTopics().names().get();
            log.info("在Kafka已建Topic数量: {} ,清单:", topicSet.size());
            topicSet.forEach(System.out::println);
            //4.创建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);
            }
        } catch (Exception e) {
            log.info("创建Topic异常.");
            e.printStackTrace();
        }
        return "创建成功";
      }
    }

(2)解析代码

注入spring-kafka框架的KafkaAdmin主要目的是获取配置内容。

操作Kafka的Topic需要先创建AdminClient，使用AdminClient的API创建Topic。

创建Topic一般只需指定Topic名称,分区Partition数目,复制因子(replication Factor)就行。

**3.使用AdminClient删除Kafka的Topic**

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

尽管集成spring-kafka，但是在操作Kafka的Topic方面，主要还是以kafka-clients的API为主。

(1)示例代码

@RestController
    @RequestMapping("/hub/example/topic")
    @Slf4j
    public class OperateKafkaTopicController {
      @Autowired
      private KafkaAdmin kafkaAdmin;
      private String topicName = "hub-topic-city-01";
      @GetMapping("/f01_2")
      public Object f01_2() {
          try {
              //1.获取Kafka配置信息
              Map<String, Object> configs = kafkaAdmin.getConfigurationProperties();
              //2.创建客户端AdminClient
              AdminClient adminClient = KafkaAdminClient.create(configs);
              //3.获取Topic清单
              Set<String> topicSet = adminClient.listTopics().names().get();
              //4.删除Topic
              if (topicSet.contains(topicName)) {
                  log.info("删除Topic: {}", topicName);
                  Collection<String> topics = Lists.newArrayList(topicName);
                  DeleteTopicsResult deleteTopicsResult = adminClient.deleteTopics(topics);
                  deleteTopicsResult.all().get();
              }
          } catch (Exception e) {
              log.info("删除Topic异常.");
              e.printStackTrace();
          }
          return "删除成功";
      }
    }

(2)解析代码

注入spring-kafka框架的KafkaAdmin主要目的是获取配置内容。

操作Kafka的Topic需要先创建AdminClient，使用AdminClient的API删除Topic。

创建Topic一般只需指定Topic名称就行。

**4.测试**

创建请求RUL：http://127.0.0.1:18208/hub-208-kafka/hub/example/topic/f01\_1

删除请求RUL：http://127.0.0.1:18208/hub-208-kafka/hub/example/topic/f01\_2

以上，感谢。

2023年6月17日