4.Kafka API

4.1 Producer API

4.1.1 消息发送流程

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

相关参数：
batch.size：只有数据积累到batch.size之后，sender才会发送数据。
linger.ms：如果数据迟迟未达到batch.size，sender等待linger.time之后就会发送数据。

4.1.2 异步发送API

1）导入依赖

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

2）代码
Producer.java
需要用到的类：
KafkaProducer：需要创建一个生产者对象，用来发送数据
ProducerConfig：获取所需的一系列配置参数
ProducerRecord：每条数据都要封装成一个ProducerRecord对象
回调函数会在producer收到ack时调用，为异步调用，该方法有两个参数，分别是RecordMetadata和Exception，如果Exception为null，说明消息发送成功，如果Exception不为null，说明消息发送失败。

import org.apache.kafka.clients.producer.Callback;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.RecordMetadata;
import java.util.Properties;

public class Producer {
    public static void main(String[] args) {
        //1.实例化kafka集群
        Properties properties = new Properties();
        properties.setProperty("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        properties.setProperty("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        properties.setProperty("acks", "all");
        properties.setProperty("bootstrap.servers", "hadoop102:9092");
        KafkaProducer<String, String> producer = new KafkaProducer<String, String>(properties);
        //2.用集群对象发送数据
        for (int i = 0; i < 10; i++) {
            producer.send(new ProducerRecord<String, String>(
                    "first",
                    Integer.toString(i),
                    "Value" + i
            ), new Callback() {
                @Override
                public void onCompletion(RecordMetadata recordMetadata, Exception e) {
                    if (e == null) {
                        System.out.println(recordMetadata);
                    }
                }
            });
            System.out.println("发送完毕" + i + "条");

        }
        //3.关闭资源
        producer.close();
    }
}

4.1.3 同步发送API

同步发送的意思就是，一条消息发送之后，会阻塞当前线程，直至返回ack。
由于send方法返回的是一个Future对象，根据Futrue对象的特点，我们也可以实现同步发送的效果，只需在调用Future对象的get方发即可。

public class Producer {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        //1.实例化kafka集群
        Properties properties = new Properties();
        properties.setProperty("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        properties.setProperty("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        properties.setProperty("acks", "all");
        properties.setProperty("bootstrap.servers", "hadoop102:9092");
        KafkaProducer<String, String> producer = new KafkaProducer<String, String>(properties);
        //2.用集群对象发送数据
        for (int i = 0; i < 10; i++) {

            Future<RecordMetadata> future = producer.send(new ProducerRecord<String, String>(
                    "first",
                    Integer.toString(i),
                    "Value" + i
            ), new Callback() {
                @Override
                public void onCompletion(RecordMetadata recordMetadata, Exception e) {
                    if (e == null) {
                        System.out.println(recordMetadata);
                    }
                }
            });
            RecordMetadata recordMetadata = future.get();//等待发送完毕
            System.out.println("发送完毕" + i + "条");
        }
        //3.关闭资源
        producer.close();
    }
}

4.2 Consumer API

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

4.2.1 自动提交offset

需要用到的类：
KafkaConsumer：需要创建一个消费者对象，用来消费数据
ConsumerConfig：获取所需的一系列配置参数
ConsuemrRecord：每条数据都要封装成一个ConsumerRecord对象
为了使我们能够专注于自己的业务逻辑，Kafka提供了自动提交offset的功能。
自动提交offset的相关参数：

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

import java.util.Collections;
import java.util.Properties;

public class Consumer {
    public static void main(String[] args) {
        //1.实例化Consumer对象
        Properties properties = new Properties();
        properties.setProperty("bootstrap.servers", "hadoop102:9092");
        properties.setProperty("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        properties.setProperty("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        properties.setProperty("enable.auto.commit", "true");//自动提交
        properties.setProperty("group.id", "test");
        properties.setProperty("auto.offset.reset", "earliest");//从消息的最开头拉取数据
        KafkaConsumer<String, String> consumer = new KafkaConsumer<>(properties);
        //2.用这个对象接收消息
        consumer.subscribe(Collections.singleton("first"));//返回一个单例集合，consumer订阅了一个topic
        ConsumerRecords<String, String> poll = consumer.poll(2000);//从订阅的话题中拉取数据
        //消费数据
        for (ConsumerRecord<String, String> record : poll) {
            System.out.println(record);
        }
        //3.关闭Consumer
        consumer.close();
    }
}

4.2.2 手动提交offset

虽然自动提交offset十分简介便利，但由于其是基于时间提交的，开发人员难以把握offset提交的时机。因此Kafka还提供了手动提交offset的API。
手动提交offset的方法有两种：分别是commitSync（同步提交）和commitAsync（异步提交）。两者的相同点是，都会将本次poll的一批数据最高的偏移量提交；不同点是，commitSync阻塞当前线程，一直到提交成功，并且会自动失败重试（由不可控因素导致，也会出现提交失败）；而commitAsync则没有失败重试机制，故有可能提交失败。
1）同步提交offset
由于同步提交offset有失败重试机制，故更加可靠。
2）异步提交offset
虽然同步提交offset更可靠一些，但是由于其会阻塞当前线程，直到提交成功。因此吞吐量会收到很大的影响。因此更多的情况下，会选用异步提交offset的方式。

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

import java.util.Collections;
import java.util.Properties;

public class Consumer {
    public static void main(String[] args) throws InterruptedException {
        //1.实例化Consumer对象
        Properties properties = new Properties();
        properties.setProperty("bootstrap.servers", "hadoop102:9092");
        properties.setProperty("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        properties.setProperty("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        properties.setProperty("enable.auto.commit", "false");//关闭自动提交
        properties.setProperty("group.id", "test");
        properties.setProperty("auto.offset.reset", "earliest");//从消息的最开头拉取数据
        KafkaConsumer<String, String> consumer = new KafkaConsumer<>(properties);
        //2.用这个对象接收消息
        while (true) {
            //从订阅的话题中拉去数据
            consumer.subscribe(Collections.singleton("first"));//返回一个单例集合 consumer订阅了一个topic
            ConsumerRecords<String, String> poll = consumer.poll(2000);//2s拉不到数据视为失败
            if (poll.count() == 0) {
                Thread.sleep(100);
            }
            for (ConsumerRecord<String, String> record : poll) {
                System.out.println(record);
            }
            //consumer.commitSync();//同步提交
            consumer.commitAsync();//异步提交
        }
        //消费数据

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

使用Produce重新发送10条数据，使用Consumer接收消费。

4.2.3 自定义保存offset

无论是同步提交还是异步提交offset，都有可能会造成数据的漏消费或者重复消费。先提交offset后消费，有可能造成数据的漏消费；而先消费后提交offset，有可能会造成数据的重复消费。

当有新的消费者加入消费者组、已有的消费者推出消费者组 或者所订阅的主题的分区发生变化 ，就会触发到分区的重新分配，重新分配的过程叫做 Rebalance。消费者发生Rebalance之后，每个消费者消费的分区就会发生变 化。 因此消费者要首先获取到自己被重新分配到的分区，并且定位到每个分区最近提交的offset位置继续消费。

要实现自定义存储offset，需要借助 ConsumerRebalanceListener 以 下为 示例代码 ，其中提交和获取 offset的方法，需要根据所选的 offset存储系统自行实现。为了避免这种情况，需要将消费与提交分区操作进行原子绑定，即消费数据与提交是一体的操作。自定义保存offset将offset保存在本地文件中。在订阅topic时先获取旧的offset（从本地文件中读取，以HashMap的形式），在消费结束之后再将新的offset提交进行保存。

代码实现：

import org.apache.kafka.clients.consumer.*;
import org.apache.kafka.common.TopicPartition;

import java.io.*;
import java.util.*;

/**
 * 自定义保存offset
 */

public class ConsumerManual {
    private static Map<TopicPartition, Long> offset = new HashMap<TopicPartition, Long>();//高速缓存
    private static String file = "e:/offset";

    public static void main(String[] args) {
        //1.实例化Consumer对象
        Properties properties = new Properties();
        properties.setProperty("bootstrap.servers", "hadoop102:9092");
        properties.setProperty("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        properties.setProperty("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        properties.setProperty("enable.auto.commit", "false");//自动提交
        properties.setProperty("group.id", "test");//自动提交
        properties.setProperty("auto.offset.reset", "earliest");//从消息的最开头拉取数据
        KafkaConsumer<String, String> consumer = new KafkaConsumer<>(properties);
        //订阅话题，拉取消息
        consumer.subscribe(Collections.singleton("first"), new ConsumerRebalanceListener() {
            @Override
            //分区分配之前事情
            public void onPartitionsRevoked(Collection<TopicPartition> collection) {
                //提交旧的offset
                commit();
            }

            @Override
            //分区分配之后做的事情
            public void onPartitionsAssigned(Collection<TopicPartition> collection) {
                //获取新的offset
                readOffset(collection);
                for (TopicPartition partition : collection) {
                    //遍历所有分区，读出每个分区对应的offset
                    Long os = offset.get(partition);
                    if (os == null) {
                        //之前没有消费过，从0开始消费
                        consumer.seek(partition, 0);
                    } else {
                        consumer.seek(partition, os);
                    }
                }

            }
        });
        while (true) {
            ConsumerRecords<String, String> records = consumer.poll(2000);
            //原子绑定
            {
                for (ConsumerRecord<String, String> record : records) {
                    //消费
                    System.out.println(record);
                    offset.put(new TopicPartition(record.topic(), record.partition()), record.offset());//消费完了放入高速缓存中
                }
                commit();//提交分区
            }
        }
    }

    /**
     * 将缓存中的offset提交到自定义介质中
     *
     * @param
     */
    private static void commit() {
        //1.先从文件中读取旧的offset
        ObjectInputStream objectInputStream = null;
        Map<TopicPartition, Long> temp;
        try {
            objectInputStream = new ObjectInputStream(new FileInputStream(file));
            temp = (Map<TopicPartition, Long>) objectInputStream.readObject();
        } catch (Exception e) {
            temp = new HashMap<TopicPartition, Long>();
        } finally {
            if (objectInputStream != null) {
                try {
                    objectInputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        //2.合并我们的offset
        temp.putAll(offset);

        //3.将新的offset写出去
        ObjectOutputStream objectOutputStream = null;
        try {
            objectOutputStream = new ObjectOutputStream(new FileOutputStream(file));
            objectOutputStream.writeObject(temp);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (objectInputStream != null) {
                try {
                    objectOutputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }

    }

    /**
     * 从自定义介质中读取offset到缓存
     *
     * @param
     * @param collection
     */
    private static void readOffset(Collection<TopicPartition> collection) {
        ObjectInputStream objectInputStream = null;
        Map<TopicPartition, Long> temp;
        try {
            objectInputStream = new ObjectInputStream(new FileInputStream(file));
            temp = (Map<TopicPartition, Long>) objectInputStream.readObject();
        } catch (Exception e) {
            temp = new HashMap<TopicPartition, Long>();
        } finally {
            if (objectInputStream != null) {
                try {
                    objectInputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        //从全部分区中读取到我们分配到的分区offset
        for (TopicPartition partition : collection) {
            offset.put(partition, temp.get(partition));
        }
    }
}

由Producer再产生10条数据消费。

4.3 自定义Interceptor

4.3.1 拦截器原理

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线程中，因此不要在该方法中放入很重的逻辑，否则会拖慢peoducer的消息发送速率。
4）close：
关闭interceptor，主要用于执行一些资源清理工作。
如前所述，interceptor可能被运行在多个线程中，因此在具体实现时用户需要自行确保线程安全。另外倘若指定了多个interceptor，则producer将按照指定顺序调用他们，并仅仅是捕获每个interceptor可能抛出的异常记录到错误日志中而非向上传递。这在使用过程中要特别留意。

4.3.2 拦截器案例

1）需求：
实现一个简单的双interceptor组成的拦截链。第一个interceptor会在消息发送时间前将时间戳信息加到消息value的最前部，第二个interceptor会在消息发送后更新成功发送消息数或失败发送数。

4.3.3 实现

1）增加时间拦截器
TimeInterceptor.java

import org.apache.kafka.clients.producer.ProducerInterceptor;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.RecordMetadata;

import java.util.Map;

public class TimeInterceptor implements ProducerInterceptor<String, String> {
    /**
     * 自定义Record 修改时间戳
     *
     * @param producerRecord 原始Record
     * @return 修改后的Record
     */
    @Override
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> producerRecord) {
        Long timestamp = producerRecord.timestamp();
        return new ProducerRecord<String, String>(
                producerRecord.topic(),
                producerRecord.partition(),
                producerRecord.timestamp(),
                producerRecord.key(),
                System.currentTimeMillis() + producerRecord.value(),
                producerRecord.headers()
        );
    }

    /**
     * 收到ACK以后调用
     *
     * @param recordMetadata
     * @param e
     */
    @Override
    public void onAcknowledgement(RecordMetadata recordMetadata, Exception e) {

    }

    /**
     * 关闭Producer时候调用
     */
    @Override
    public void close() {

    }

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

    }
}

2）增加计数器拦截器
CountInterceptor.java

package com.atguigu.interceptor;

import org.apache.kafka.clients.producer.ProducerInterceptor;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.clients.producer.RecordMetadata;

import java.util.Map;

/**
 * 记录消息发送成败数量
 */
public class CountInterceptor implements ProducerInterceptor<String, String> {
    private long success = 0;
    private long fail = 0;

    @Override
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> producerRecord) {
        return producerRecord;
    }

    /**
     * 收到ACK后做计数
     *
     * @param recordMetadata
     * @param e
     */
    @Override
    public void onAcknowledgement(RecordMetadata recordMetadata, Exception e) {
        if (e == null) {
            success++;
        } else {
            fail++;
        }
    }

    /**
     * 发送完成后输出结果
     */
    @Override
    public void close() {
        System.out.println("成功了" + success + "条");
        System.out.println("失败了" + fail + "条");
    }

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

    }
}

3）Producer中添加拦截器
Producer.java

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 Producer {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        //1.实例化kafka集群
        Properties properties = new Properties();
        properties.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        properties.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        properties.put("acks", "all");
        properties.put("bootstrap.servers", "hadoop102:9092");
        //添加拦截器
        List<String> interceptors = new ArrayList<>();
        interceptors.add("com.atguigu.interceptor.TimeInterceptor");
        interceptors.add("com.atguigu.interceptor.CountInterceptor");
        properties.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);
        KafkaProducer<String, String> producer = new KafkaProducer<String, String>(properties);

        //2.用集群对象发送数据
        for (int i = 0; i < 10; i++) {
            Future<RecordMetadata> future = producer.send(new ProducerRecord<String, String>(
                    "first",
                    Integer.toString(i),
                    "Value" + i
            ), new Callback() {
                @Override
                public void onCompletion(RecordMetadata recordMetadata, Exception e) {
                    if (e == null) {
                        System.out.println(recordMetadata);
                    }
                }
            });
            RecordMetadata recordMetadata = future.get();
            System.out.println("发送完毕" + i + "条");
        }
        //3.关闭资源
        producer.close();
    }
}

4）发送消息测试
实现在value中添加时间戳。

实现发送结束之后计数功能。