【Kafka】Kafka API 的使用

一、引入kafka-clients依赖

　　要在普通Maven项目中是用Kafka API需要引入Kafka的客户端依赖

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

　　完整依赖如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>test-kafka-client1</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

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

        <dependency>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
            <version>2.10.2</version>
        </dependency>

        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.21</version>
        </dependency>
    </dependencies>

</project>

二、Producer API

1、消息发送流程

　　Kafka 的 Producer 发送消息采用的是异步发送的方式。在消息发送的过程中，涉及到了 两个线程——main 线程和 Sender 线程，以及一个线程共享变量——RecordAccumulator。 main 线程将消息发送给 RecordAccumulator，Sender 线程不断从 RecordAccumulator 中拉取 消息发送到 Kafka broker。

2、生产者编写代码需要用到的类

　　KafkaProducer:需要创建一个生产者对象，用来发送数据

　　ProducerConfig:获取所需的一系列配置参数

　　ProducerRecord:每条数据都要封装成一个 ProducerRecord 对象

3、不带回调函数的Producer API

package com.test.kafka.producer;

import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;

import java.util.Properties;

public class FirstProducer {
    public static void main(String[] args) throws InterruptedException {

        // 创建生产者配置信息
        Properties props = new Properties();

        // kafka 集群，broker-list
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, "127.0.0.1:9092");
        // ACK应答级别
        props.put(ProducerConfig.ACKS_CONFIG, "all");
        // 重试次数
        props.put(ProducerConfig.RETRIES_CONFIG, 1);
        // 批次大小 16k
        props.put(ProducerConfig.BATCH_SIZE_CONFIG, 16384);
        // 等待时间 1ms
        props.put(ProducerConfig.LINGER_MS_CONFIG, 1);
        // RecordAccumulator 缓冲区大小  32m
        props.put(ProducerConfig.BUFFER_MEMORY_CONFIG, 33554432);
        // 序列化器
        props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer");
        props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer");

        // 创建生产者对象
        KafkaProducer<String, String> producer = new KafkaProducer<>(props);

        // 发送数据
        for (int i = 0; i < 1000; i++) {
            producer.send(new ProducerRecord<>("first", "~~value~~~~" + i));
            Thread.sleep(500);
        }

        // 关闭连接
        producer.close();
    }
}

4、带回调函数的Producer API

　　回调函数会在 producer 收到 ack 时调用，为异步调用，该方法有两个参数，分别是RecordMetadata 和 Exception，如果 Exception 为 null，说明消息发送成功，如果 Exception 不为 null，说明消息发送失败。

　　注意:消息发送失败会自动重试，不需要我们在回调函数中手动重试。

package com.test.kafka.producer;

import com.test.kafka.partitioner.MyPartitioner;
import org.apache.kafka.clients.producer.*;

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;

public class CallBackProducer {
    public static void main(String[] args) throws ExecutionException, InterruptedException {

        // 创建生产者配置信息
        Properties props = new Properties();

        // kafka 集群，broker-list
        props.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, "127.0.0.1:9092");
        // ACK应答级别
        props.put(ProducerConfig.ACKS_CONFIG, "all");
        // 重试次数
        props.put(ProducerConfig.RETRIES_CONFIG, 1);
        // 批次大小 16k
        props.put(ProducerConfig.BATCH_SIZE_CONFIG, 16384);
        // 等待时间 1ms
        props.put(ProducerConfig.LINGER_MS_CONFIG, 1);
        // RecordAccumulator 缓冲区大小  32m
        props.put(ProducerConfig.BUFFER_MEMORY_CONFIG, 33554432);
        // 序列化器
        props.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer");
        props.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringSerializer");

//        // 添加分区器
//        props.put(ProducerConfig.PARTITIONER_CLASS_CONFIG, "com.test.kafka.partitioner.MyPartitioner");
//
//        // 拦截器链
//        List<String> interceptors = new ArrayList<>();
//        interceptors.add("com.test.kafka.interceptor.TimeInterceptor");
//        interceptors.add("com.test.kafka.interceptor.CounterInterceptor");
//        props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);

        // 创建生产者对象
        KafkaProducer<String, String> producer = new KafkaProducer<>(props);

        // 发送数据
        for (int i = 0; i < 10; i++) {
//            producer.send(new ProducerRecord<>("second", "value~~~~" + i), (metadata, exception) -> {
            Future<RecordMetadata> future = producer.send(new ProducerRecord<String, String>("second", String.valueOf(i), "value~~~~" + i), (metadata, exception) -> {
                // 正常返回 exception 为空
                if (exception == null) {
                    System.out.println("partition:" + metadata.partition() + "	offset:" + metadata.offset());
                } else {
                    exception.printStackTrace();
                }
            });

            // 同步发送策略
            RecordMetadata metadata = future.get();
            System.out.println(metadata);
        }
        // 关闭连接
        producer.close();

    }
}

三、Consumer API

　　Consumer 消费数据时的可靠性是很容易保证的，因为数据在 Kafka 中是持久化的，故 不用担心数据丢失问题。由于 consumer 在消费过程中可能会出现断电宕机等故障，consumer 恢复后，需要从故 障前的位置的继续消费，所以 consumer 需要实时记录自己消费到了哪个 offset，以便故障恢 复后继续消费。所以 offset 的维护是 Consumer 消费数据是必须考虑的问题。

1、消费者编写代码需要用到的类　　

　　 KafkaConsumer:需要创建一个消费者对象，用来消费数据 

　　ConsumerConfig:获取所需的一系列配置参数

　　ConsuemrRecord:每条数据都要封装成一个 ConsumerRecord 对象

　　为了使我们能够专注于自己的业务逻辑，Kafka 提供了自动提交 offset 的功能。　　

　　自动提交 offset 的相关参数:

• enable.auto.commit:是否开启自动提交 offset 功能 

• auto.commit.interval.ms:自动提交 offset 的时间间隔

2、手动提交 offset 的代码

package com.test.kafka.consumer;

import org.apache.kafka.clients.consumer.ConsumerConfig;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.apache.kafka.clients.consumer.ConsumerRecords;
import org.apache.kafka.clients.consumer.KafkaConsumer;


import java.util.Arrays;
import java.util.Properties;

public class FirstConsumer {

    public static void main(String[] args) {
        // 创建配置信息
        Properties props = new Properties();

        // kafka 集群，broker-list
        props.put(ConsumerConfig.BOOTSTRAP_SERVERS_CONFIG, "127.0.0.1:9092");
        // 开启自动提交
//        props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, true);
        // 开启手动提交
        props.put(ConsumerConfig.ENABLE_AUTO_COMMIT_CONFIG, false);

        // 自动提交延迟
        props.put(ConsumerConfig.AUTO_COMMIT_INTERVAL_MS_CONFIG, "1000");
        // 反序列化
        props.put(ConsumerConfig.KEY_DESERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringDeserializer");
        props.put(ConsumerConfig.VALUE_DESERIALIZER_CLASS_CONFIG, "org.apache.kafka.common.serialization.StringDeserializer");
        // 重置offset，满足条件下，可以重置重置offset，从最早的消息开始消费
        props.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG, "earliest");
        // 消费者组
        props.put(ConsumerConfig.GROUP_ID_CONFIG, "test-my-group");

        // 创建消费者
        KafkaConsumer<String, String> consumer = new KafkaConsumer<String, String>(props);

        // 订阅主题
        consumer.subscribe(Arrays.asList("first", "second"));

        while (true) {
            // 拉取消息
            ConsumerRecords<String, String> consumerRecords = consumer.poll(100);
            System.out.println("数量：" + consumerRecords.count());
            // 遍历
            for (ConsumerRecord<String, String> consumerRecord : consumerRecords) {
                System.out.println(consumerRecord.key() + "----" + consumerRecord.value());
            }

            // 手动同步提交，当前线程会阻塞直到 offset 提交成功
            consumer.commitSync();
        }

//        // 关闭
//        consumer.close();
    }
}

三、自定义分区器

1、分区器代码

package com.test.kafka.partitioner;

import org.apache.kafka.clients.producer.Partitioner;
import org.apache.kafka.common.Cluster;

import java.util.Map;

/**
 * 自定义分区器
 */
public class MyPartitioner implements Partitioner {
    @Override
    public int partition(String topic, Object key, byte[] keyBytes, Object value, byte[] valueBytes, Cluster cluster) {
        cluster.partitionsForTopic(topic).size();
        return 1;
    }

    @Override
    public void close() {

    }

    @Override
    public void configure(Map<String, ?> configs) {

    }

    public static void main(String[] args) {
        System.out.println(Math.abs("test-my-group".hashCode()) % 50);
    }
}

2、分区器注入Producer

// 添加分区器
props.put(ProducerConfig.PARTITIONER_CLASS_CONFIG, "com.test.kafka.partitioner.MyPartitioner");

四、自定义 Interceptor

　　Producer 拦截器(interceptor)是在 Kafka 0.10 版本被引入的，主要用于实现 clients 端的定 制化控制逻辑。

　　对于 producer 而言，interceptor 使得用户在消息发送前以及 producer 回调逻辑前有机会 对消息做一些定制化需求，比如修改消息等。同时，producer 允许用户指定多个 interceptor 按序作用于同一条消息从而形成一个拦截链(interceptor chain)。Intercetpor 的实现接口是 org.apache.kafka.clients.producer.ProducerInterceptor，其定义的方法包括:　　

　　(1) configure(configs)：获取配置信息和初始化数据时调用。

　　(2) onSend(ProducerRecord): 该方法封装进 KafkaProducer.send 方法中，即它运行在用户主线程中。Producer 确保在消息被序列化以及计算分区前调用该方法。用户可以在该方法中对消息做任何操作，但最好 保证不要修改消息所属的 topic 和分区，否则会影响目标分区的计算。

　　(3) onAcknowledgement(RecordMetadata, Exception): 该方法会在消息从 RecordAccumulator 成功发送到 Kafka Broker 之后，或者在发送过程 中失败时调用。并且通常都是在 producer 回调逻辑触发之前。onAcknowledgement 运行在 producer 的 IO 线程中，因此不要在该方法中放入很重的逻辑，否则会拖慢 producer 的消息 发送效率。　　

　　(4) close:关闭 interceptor，主要用于执行一些资源清理工作如前所述，interceptor 可能被运行在多个线程中，因此在具体实现时用户需要自行确保线程安全。另外倘若指定了多个 interceptor，则 producer 将按照指定顺序调用它们，并仅仅 是捕获每个 interceptor 可能抛出的异常记录到错误日志中而非在向上传递。这在使用过程中 要特别留意

1、拦截器案例

　　(1) 增加时间戳拦截器 

public class TimeInterceptor implements ProducerInterceptor<String, String> {
    @Override
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> record) {
        // 创建一个新的 record，把时间戳写入消息体的最前部
        return new ProducerRecord(record.topic(), record.partition(), record.timestamp(), record.key(),
                System.currentTimeMillis() + "," + record.value().toString());
    }

    @Override
    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {

    }

    @Override
    public void close() {

    }

    @Override
    public void configure(Map<String, ?> configs) {

    }
}

　　(2)统计发送消息成功和发送失败消息数，并在 producer 关闭时打印这两个计数器

public class CounterInterceptor implements ProducerInterceptor {

    private int errorCounter = 0;
    private int successCounter = 0;


    @Override
    public ProducerRecord onSend(ProducerRecord record) {
        return record;
    }

    @Override
    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {

        // 统计成功和失败的次数
        if (exception == null) {
            successCounter++;
        } else {
            errorCounter++;
        }
    }

    @Override
    public void close() {
        // 保存结果
        System.out.println("Successful sent: " + successCounter);
        System.out.println("Failed sent: " + errorCounter);
    }

    @Override
    public void configure(Map<String, ?> configs) {

    }
}

2、拦截器注入Producer

// 拦截器链
List<String> interceptors = new ArrayList<>();
interceptors.add("com.test.kafka.interceptor.TimeInterceptor");
interceptors.add("com.test.kafka.interceptor.CounterInterceptor");
props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);