Kafka客户端API

创建项目,引入依赖:

        <!-- 引入Kafka依赖   -->
        <dependency>
            <groupId>org.apache.kafka</groupId>
            <artifactId>kafka-clients</artifactId>
            <version>2.8.1</version>
        </dependency>

针对生产者和消费者使用进行示例演示。前面了解了Kafa服务安装和基本概念,接下来直接敲代码。

一、快速入门

创建一个 Order实体类,作为消息数据发送。

public class Order {

    private Integer orderId;
    private String orderDesc;
    private Double orderAmount;
    ...
} 

1、生产者

生产者需要用到的几个类:

  • KafkaProducer: 需要一个生产者对象,用来发送数据。
  • ProducerConfig: 获取所需一系列配置参数。
  • ProducerRecord: 每条消息数据都要封装成一个 ProducerRecord对象。
public class Producer {

    private final static String TOPIC_NAME = "my-test-topic";
    private final static String KAFKA_SERVERS_CLUSTER_STR = "192.168.xxx.xxx:9092";//集群用逗号分隔

    public static void main(String[] args) throws InterruptedException, ExecutionException {
        // 1.设置生产者的配置信息
        Properties props = makeProducerProperties();

        // 2.创建生产者对象。通过配置信息
        KafkaProducer<String, String> producer = new KafkaProducer<String, String>(props);

        // 3.发送消息
        for (int i = 1; i <= 2; i++) {
            //3.1 构建消息数据
            Order order = new Order(i, "订单-" + i, 1000.00);
            //3.2 将消息数据封装成 ProducerRecord 对象
            //未指定发送分区
            ProducerRecord<String, String> producerRecord = new ProducerRecord<String, String>(TOPIC_NAME
                    , order.getOrderId().toString(), JSON.toJSONString(order));

            //3.3 同步方式发送消息
            Future<RecordMetadata> future = producer.send(producerRecord);
            RecordMetadata metadata = future.get();
            System.out.println("同步方式发送消息结果:" + "topic-" + metadata.topic() + "|partition-"
                    + metadata.partition() + "|offset-" + metadata.offset());
            
        }

        TimeUnit.SECONDS.sleep(10);//方便异步测试
        //4.关闭资源
        producer.close();
    }

    /**
     * 设置生产者配置信息
     * @return
     */
    private static Properties makeProducerProperties() {
        Properties props = new Properties();
        //指定连接的 kafka集群
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, KAFKA_SERVERS_CLUSTER_STR);

        //key,value的序列化:这里把 key和 value从字符串序列化为字节数组
        props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        return props;
    }
}

2、消费者

消费者需要用到的类:

  • KafkaConsumer: 需要创建一个消费者对象,用来消费数据。
  • ConsumerConfig: 获取所需的一系列配置参数。
  • ConsumerRecord: 每条消息数据都要封装成一个 ConsumerRecord对象。
public class Consumer {

    private final static String TOPIC_NAME = "my-test-topic";
    private final static String CONSUMER_GROUP_NAME = "myTestGroup";
    private final static String KAFKA_SERVERS_CLUSTER_STR = "192.168.xxx.xxx:9092";//集群用逗号分隔

    public static void main(String[] args) {

        // 1.设置消费者的配置信息
        Properties props = makeConsumerProperties();

        // 2.创建消费者对象。通过配置信息
        KafkaConsumer<String, String> consumer = new KafkaConsumer<String, String>(props);

        // 3.消费者对象订阅主题
        // 直接订阅主题
        consumer.subscribe(Arrays.asList(TOPIC_NAME));

        //4. 获取/消费消息
        while (true) {
            /**4.1 获取消费消息
             * poll():表示拉取消息的长轮询
             */
            ConsumerRecords<String, String> records = consumer.poll(Duration.ofMillis(1000));

            //4.2 处理消息
            for (ConsumerRecord<String, String> record : records) {
                // 打印consumerRecords
                System.out.printf("收到消息:partition = %d,offset = %d, key = %s, value = %s%n", record.partition(),
                        record.offset(), record.key(), record.value());
            }
        }
    }

    /**
     * 设置消费者配置信息
     * @return
     */
    private static Properties makeConsumerProperties() {
        Properties props = new Properties();
        //指定连接的 kafka集群
        props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, KAFKA_SERVERS_CLUSTER_STR);
        // 消费分组名
        props.put(ConsumerConfig.GROUP_ID_CONFIG, CONSUMER_GROUP_NAME);

        //key,value的序列化:这里把 key和 value从字符串序列化为字节数组
        props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class.getName());
        props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class.getName());
        return props;
    }
}

3、测试

运行消费者和生产者,消息发送和消息消费ok。
在这里插入图片描述

注意:

  • 主题和消费组不存在时,Kafka会自动创建。
  • 关于 消费者和生产者配置参数信息,如果你不设置,Kafka都有默认值。

关于API使用和配置参数详情可查看官方文档:还是很详细的

在这里插入图片描述

二、生产者

send()方法:其实是异步执行,返回一个 Future对象。
这个生产者写一条消息的时候,先是写到某个缓冲区, 这个缓冲区里的数据还没写到broker集群里的某个分区的时候,它就返回到client了。

1、同步发送

同步方式:根据 Future对象的特点,我们也可以实现同步发送的效果,只需在调用 Future对象的 get()方法即可。

			Future<RecordMetadata> future = producer.send(producerRecord);
			RecordMetadata metadata = future.get();

2、异步发送

异步方式:带回调函数的 API,回调函数会在 producer 收到 ack 时调用 onCompletion()方法。

            producer.send(producerRecord, new Callback() {
                /**
                 * onCompletion()方法有两个参数,分别是 RecordMetadata 和 Exception,
                 * @param metadata - RecordMetadata元数据
                 * @param exception - 如果 Exception为 null,说明消息发送成功,如果 Exception不为 null,说明消息发送失败。
                 */
                @Override
                public void onCompletion(RecordMetadata metadata, Exception exception) {
                    if (exception != null) {
                        System.err.println("异步方式发送消息失败:" + exception.getStackTrace());

                    }
                    if (metadata != null) {
                        System.out.println("异步方式发送消息结果:" + "topic-" + metadata.topic() + "|partition-"
                                + metadata.partition() + "|offset-" + metadata.offset());
                    }
                }
            });

3、指定分区发送

将消息数据封装成 ProducerRecord 对象时,有多种构造方法使用,比如:

  • 指定发送分区
  • 未指定发送分区
            //3.2 将消息数据封装成 ProducerRecord 对象
            //指定发送分区
            /*ProducerRecord<String, String> producerRecord = new ProducerRecord<String, String>(TOPIC_NAME, 0, order.getOrderId().toString(), JSON.toJSONString(order));*/
            //未指定发送分区,具体发送的分区计算公式:hash(key)%partitionNum
            ProducerRecord<String, String> producerRecord = new ProducerRecord<String, String>(TOPIC_NAME, order.getOrderId().toString(), JSON.toJSONString(order));

4、配置参数

部分参数说明:

    private static Properties makeProducerProperties() {
        Properties props = new Properties();
        //指定连接的 kafka集群
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, KAFKA_SERVERS_CLUSTER_STR);

        /*
            发出消息持久化机制参数
            (1)acks=0: 表示producer不需要等待任何broker确认收到消息的回复,就可以继续发送下一条消息。性能最高,但是最容易丢消息。
            (2)acks=1: 至少要等待leader已经成功将数据写入本地log,但是不需要等待所有follower是否成功写入。就可以继续发送下一
                 条消息。这种情况下,如果follower没有成功备份数据,而此时leader又挂掉,则消息会丢失。
            (3)acks=-1或all: 需要等待 min.insync.replicas(默认为1,推荐配置大于等于2) 这个参数配置的副本个数都成功写入日志,这种策略
                会保证只要有一个备份存活就不会丢失数据。这是最强的数据保证。一般除非是金融级别,或跟钱打交道的场景才会使用这种配置。
         */
        props.put(ProducerConfig.ACKS_CONFIG, "1");
        
        /*
            发送失败会重试,默认重试间隔100ms,重试能保证消息发送的可靠性,但是也可能造成消息重复发送,比如网络抖动,
            所以需要在接收者那边做好消息接收的幂等性处理
        */
        props.put(ProducerConfig.RETRIES_CONFIG, 3);        
        //重试间隔设置,单位毫秒
        props.put(ProducerConfig.RETRY_BACKOFF_MS_CONFIG, 300);
        
        //设置发送消息的本地缓冲区,如果设置了该缓冲区,消息会先发送到本地缓冲区,可以提高消息发送性能,默认值是33554432,即32MB
        props.put(ProducerConfig.BUFFER_MEMORY_CONFIG, 33554432);        
        /*
            kafka本地线程会从缓冲区取数据,批量发送到broker,
            设置批量发送消息的大小,默认值是16384,即16kb,就是说一个batch满了16kb就发送出去
        */
        props.put(ProducerConfig.BATCH_SIZE_CONFIG, 16384);
        
        /*
            默认值是0,意思就是消息必须立即被发送,但这样会影响性能
            一般设置10毫秒左右,就是说这个消息发送完后会进入本地的一个batch,如果10毫秒内,这个batch满了16kb就会随batch一起被发送出去
            如果10毫秒内,batch没满,那么也必须把消息发送出去,不能让消息的发送延迟时间太长
        */
        props.put(ProducerConfig.LINGER_MS_CONFIG, 10);

        //key,value的序列化:这里把 key和 value从字符串序列化为字节数组
        props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        return props;
    }

三、消费者

1、自动提交

默认就是自动提交,也可以通过配置参数修改值:

        // 是否自动提交offset,默认就是true,推荐使用手动提交
        props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "true");
        // 自动提交offset的间隔时间
        props.put(ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG, "1000");

2、手动提交

虽然自动提交 offset 十分简便,但由于其是基于时间提交的,开发人员难以把握 offset 提交的时机。因此 Kafka 提供了手动提交 offset 的 API。

手动提交 offset 的方法有两种:

  • commitSync(同步提交)
  • commitAsync(异步提交)

两者的相同点是:都会将本次拉取的一批数据最高的偏移量提交。
不同点是:commitSync 阻塞当前线程,一直到提交成功,并且会自动失败重试;而 commitAsync 则没有失败重试机制,故有可能提交失败。

操作如下:

首先,关闭自动提交配置参数:

//关闭自动提交,即手动提交 
props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "false");

然后,我们手动提交消费消息:

            ConsumerRecords<String, String> records = consumer.poll(Duration.ofMillis(1000));

            //4.2 处理消息
            if (records.count() > 0) {
                // 手动同步提交offset,当前线程会阻塞直到offset提交成功
                // 一般使用同步提交,因为提交之后一般也没有什么逻辑代码了
                //consumer.commitSync();

                // 手动异步提交offset,当前线程提交offset不会阻塞,可以继续处理后面的程序逻辑
                consumer.commitAsync(new OffsetCommitCallback() {
                    @Override
                    public void onComplete(Map<TopicPartition, OffsetAndMetadata> offsets, Exception exception) {
                        if (exception != null) {
                            System.err.println("Commit failed for " + offsets);
                            System.err.println("Commit failed exception: " + exception.getStackTrace());
                        }
                    }
                });
            }

2.1 数据漏消费和重复消费分析:

无论是同步提交还是异步提交 offset,都有可能会造成数据漏消费或重复消费。

  • 先提交 offset 后消费,有可能造成数据的漏消费;
  • 先消费后提交 offset,有可能造成数据的重复消费。

3、消费者订阅主题

消费者对象订阅主题有多种方式:

  • 直接订阅主题
  • 指定分区订阅
  • 消息回溯消费订阅
  • 指定offset消费
  • 从指定时间点开始消费等等
        // 3.消费者对象订阅主题
        // 直接订阅主题
        consumer.subscribe(Arrays.asList(TOPIC_NAME));
        // 消费指定分区
        //consumer.assign(Arrays.asList(new TopicPartition(TOPIC_NAME, 0)));

        //消息回溯消费
        /*consumer.assign(Arrays.asList(new TopicPartition(TOPIC_NAME, 0)));
        consumer.seekToBeginning(Arrays.asList(new TopicPartition(TOPIC_NAME, 0)));*/

        //指定offset消费
        /*consumer.assign(Arrays.asList(new TopicPartition(TOPIC_NAME, 0)));
        consumer.seek(new TopicPartition(TOPIC_NAME, 0), 10);*/

        //从指定时间点开始消费

        /*List<PartitionInfo> topicPartitions = consumer.partitionsFor(TOPIC_NAME);
        //从1小时前开始消费
        long fetchDataTime = new Date().getTime() - 1000 * 60 * 60;
        Map<TopicPartition, Long> map = new HashMap<>();
        for (PartitionInfo par : topicPartitions) {
            map.put(new TopicPartition(TOPIC_NAME, par.partition()), fetchDataTime);
        }
        Map<TopicPartition, OffsetAndTimestamp> parMap = consumer.offsetsForTimes(map);
        for (Map.Entry<TopicPartition, OffsetAndTimestamp> entry : parMap.entrySet()) {
            TopicPartition key = entry.getKey();
            OffsetAndTimestamp value = entry.getValue();
            if (key == null || value == null) continue;
            Long offset = value.offset();
            System.out.println("partition-" + key.partition() + "|offset-" + offset);
            System.out.println();
            //根据消费里的timestamp确定offset
            if (value != null) {
                consumer.assign(Arrays.asList(key));
                consumer.seek(key, offset);
            }
        }*/

注意:消息回溯消费订阅,每次都会从头消费。理解它与 ConsumerConfig.AUTO_OFFSET_RESET_CONFIG = "earliest" 配置参数的区别。

4、配置参数

部分参数说明:

    private static Properties makeConsumerProperties() {
        Properties props = new Properties();
        //指定连接的 kafka集群
        props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, KAFKA_SERVERS_CLUSTER_STR);
        // 消费分组名
        props.put(ConsumerConfig.GROUP_ID_CONFIG, CONSUMER_GROUP_NAME);

       /* // 是否自动提交offset,默认就是true,推荐使用手动提交
        props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "true");
        // 自动提交offset的间隔时间
        props.put(ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG, "1000");*/
        props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, "false");

        /*
            当消费主题的是一个新的消费组,或者指定offset的消费方式,offset不存在,那么应该如何消费
            latest(默认) :只消费自己启动之后发送到主题的消息
            earliest:第一次从头开始消费,以后按照消费offset记录继续消费,这个需要区别于consumer.seekToBeginning(每次都从头开始消费)
        */
        //props.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");

        /*
            consumer给broker发送心跳的间隔时间,broker接收到心跳,如果此时有rebalance发生会通过心跳响应将
            rebalance方案下发给consumer,这个时间可以稍微短一点
		*/
        props.put(ConsumerConfig.HEARTBEAT_INTERVAL_MS_CONFIG, 1000);
        /*
            服务端broker多久感知不到一个consumer心跳就认为他故障了,会将其踢出消费组,
            对应的Partition也会被重新分配给其他consumer,默认是10秒
        */
        props.put(ConsumerConfig.SESSION_TIMEOUT_MS_CONFIG, 10 * 1000);

        //一次poll最大拉取消息的条数,如果消费者处理速度很快,可以设置大点,如果处理速度一般,可以设置小点
        props.put(ConsumerConfig.MAX_POLL_RECORDS_CONFIG, 50);
        /*
            如果两次poll操作间隔超过了这个时间,broker就会认为这个consumer处理能力太弱,
            会将其踢出消费组,将分区分配给别的consumer消费
        */
        props.put(ConsumerConfig.MAX_POLL_INTERVAL_MS_CONFIG, 30 * 1000);

        //key,value的序列化:这里把 key和 value从字符串序列化为字节数组
        props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class.getName());
        props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, StringDeserializer.class.getName());
        return props;
    }

关于 Kafka客户端:

通过使用 Properties来创建连接 kafka server的客户端AdminClient,它是一个抽象类,只有一个 KafkaAdminClient实现类。通过客户端AdminClient ,我们可以进行 Topic的CRUD等操作。

使用比较简单,可查看参考文章,博主写的很详细。

参考文章:

– 求知若饥,虚心若愚。

  • 2
    点赞
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Kafka 客户端工具是一种用于与 Kafka 消息队列进行通信和交互的工具。它提供了一系列命令行接口 (CLI) 和 API,可用于在 Kafka 集群中发布、订阅和使用消息。 Kafka 客户端工具具有以下主要功能: 1. 发布消息:可以使用 Kafka 客户端工具将消息发布到 Kafka 集群中的指定主题。可以通过命令行或程序化方式指定消息的内容、主题和其他属性。 2. 订阅消息:可以使用 Kafka 客户端工具从 Kafka 集群中的指定主题订阅消息。可以通过指定消费者组、分区和其他属性来灵活控制订阅行为。 3. 检查主题和分区:可以使用 Kafka 客户端工具查看 Kafka 集群中的所有主题和相应的分区信息。可以检查每个分区的偏移量、副本分布和其他有关分区的元数据。 4. 控制消费者组:可以使用 Kafka 客户端工具管理消费者组。可以列出当前活动的消费者组、查看组内消费者的偏移量以及重置偏移量等操作。 5. 监控和性能测试:Kafka 客户端工具还提供了一些监控工具和性能测试工具,用于监测和调优 Kafka 集群的性能。可以使用这些工具检查消息的产生和消费速率、分区偏移量的变化等。 总之,Kafka 客户端工具是一种便捷的工具,可以帮助开发人员和管理员与 Kafka 集群进行交互,并用于操作和管理消息的发布和订阅。无论是通过命令行还是API,它们都为处理 Kafka 数据流提供了强大的功能和灵活性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值