第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）导入依赖

<dependencies>
  <dependency>
    <groupId>org.apache.kafka</groupId>
    <artifactId>kafka-clients</artifactId>
    <version>2.4.1</version>
  </dependency>
  <dependency>
    <groupId>org.apache.logging.log4j</groupId>
    <artifactId>log4j-slf4j-impl</artifactId>
    <version>2.12.0</version>
  </dependency>
</dependencies>

2）添加log4j配置文件

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="error" strict="true" name="XMLConfig">
    <Appenders>
        <!-- 类型名为Console，名称为必须属性 -->
        <Appender type="Console" name="STDOUT">
            <!-- 布局为PatternLayout的方式，
            输出样式为[INFO] [2018-01-22 17:34:01][org.test.Console]I'm here -->
            <Layout type="PatternLayout"
                    pattern="[%p] [%d{yyyy-MM-dd HH:mm:ss}][%c{10}]%m%n" />
        </Appender>

    </Appenders>

    <Loggers>
        <!-- 可加性为false -->
        <Logger name="test" level="info" additivity="false">
            <AppenderRef ref="STDOUT" />
        </Logger>

        <!--  loggerConfig设置 -->
        <wolffy level="info">
            <AppenderRef ref="STDOUT" />
        </wolffy>
    </Loggers>

</Configuration>

3）编写代码

需要用到的类：

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

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

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

（1）不带回调函数的API

package com.wolffy.kafka.producer;

import org.apache.kafka.clients.consumer.ConsumerConfig;
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;
import java.util.UUID;

/**
 * 生产者 - 异步发送 - 不带回调
 *
 * 配置类
 *   CommonClientConfigs : 通用的配置类
 *   ProducerConfig ： 生产者的配置类
 *   ConsumerConfig :  消费者的配置类
 */
public class KafkaProducerDemo {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props= new Properties();

        //kafka集群，broker-list
        props.put("bootstrap.servers", "hadoop102:9092");

        // ack的级别
        props.put("acks", "all");
        //重试次数
        props.put("retries", 3);

        //批次大小
        props.put("batch.size", 16384);

        //等待时间
        props.put("linger.ms", 1);

        //RecordAccumulator缓冲区大小
        props.put("buffer.memory", 33554432);  //32M

        // kv的序列化器
        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

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

        //2. 生产数据
        for (int i = 0; i < 20 ; i++) {
            //1. 指定partition
            //kafkaProducer.send(new ProducerRecord<String,String>("first",1,null,"wolffy" + i));
            //2. 指定key
            //kafkaProducer.send(new ProducerRecord<String,String>("first", UUID.randomUUID().toString(),"wolffy-->" + i));
            //3. 黏性
            kafkaProducer.send(new ProducerRecord<String,String>("first", "wolffy*****" + i));
        }

        //3. 关闭对象
        kafkaProducer.close();
    }
}

（2）带回调函数的API

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

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

package com.wolffy.kafka.producer;

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;

/**
 * 生产者 - 异步发送 - 带回调
 *
 * 配置类
 *   CommonClientConfigs : 通用的配置类
 *   ProducerConfig ： 生产者的配置类
 *   ConsumerConfig :  消费者的配置类
 *
 */
public class KafkaProducerDemo1 {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props= new Properties();

        //kafka集群，broker-list
        props.put("bootstrap.servers", "hadoop102:9092");

        // ack的级别
        props.put("acks", "all");

        //重试次数
        props.put("retries", 3);

        //批次大小
        props.put("batch.size", 16384);

        //等待时间
        props.put("linger.ms", 1);

        //RecordAccumulator缓冲区大小
        props.put("buffer.memory", 33554432);  //32M

        // kv的序列化器
        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

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

        //2. 生产数据
        for (int i = 0; i < 10; i++) {
            kafkaProducer.send(
                    new ProducerRecord<String, String>("first", "wolffy####" + i)
                    , new Callback() {
                        @Override
                        public void onCompletion(RecordMetadata metadata, Exception exception) {
                            if(exception != null){
                                System.out.println("消息发送失败: " + exception.getMessage());
                            }else{
                                System.out.println("消息发送成功: " + metadata.topic() +
                                        " : " + metadata.partition() +
                                        " : " + metadata.offset()
                                       );
                            }
                        }
                    });
        }

        //3. 关闭对象
        kafkaProducer.close();
    }
}

package com.wolffy.kafka.producer;

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;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;

/**
 * 生产者 - 同步发送 - 带回调
 *
 */
public class KafkaProducerDemo2 {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        //0. 创建配置对象
        Properties props= new Properties();

        //kafka集群，broker-list
        props.put("bootstrap.servers", "hadoop102:9092");

        // ack的级别
        props.put("acks", "all");

        //重试次数
        props.put("retries", 3);

        //批次大小
        props.put("batch.size", 16384);

        //等待时间
        props.put("linger.ms", 1);

        //RecordAccumulator缓冲区大小
        props.put("buffer.memory", 33554432);  //32M

        // kv的序列化器
        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

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

        //2. 生产数据
        for (int i = 0; i < 10; i++) {

            Future<RecordMetadata> future = kafkaProducer.send(
                    new ProducerRecord<String, String>("first", "wolffy####" + i)
                    , new Callback() {
                        /**
                         * 当消息发送完成后， 会调用该方法
                         * @param metadata  消息的元数据信息.
                         *
                         * @param exception 当消息发送过程中,如果抛出异常，会传入到该方法.
                         */
                        @Override
                        public void onCompletion(RecordMetadata metadata, Exception exception) {
                            if (exception != null) {
                                System.out.println("消息发送失败: " + exception.getMessage());
                            } else {
                                System.out.println("消息发送成功: " + metadata.topic() +
                                        " : " + metadata.partition() +
                                        " : " + metadata.offset()
                                );
                            }
                        }
                    });
            System.out.println("************** 消息发送出去 **************");

            //future.get(); // 阻塞当前线程。 一直等到该方法的结果返回为止.

            System.out.println("************** 消息发送完成 **************");

        }

        //3. 关闭对象
        kafkaProducer.close();
    }
}

4.1.3 分区器

1）默认的分区器 DefaultPartitioner

2）自定义分区器

package com.wolffy.kafka.partitioner;

import org.apache.kafka.clients.producer.*;

import java.util.Properties;
import java.util.UUID;

/**
 * 生产者 - 自定义分区
 */
public class KafkaProducerPartitioner {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props= new Properties();
        //kafka集群，broker-list
        props.put("bootstrap.servers", "hadoop102:9092");

        // ack的级别
        props.put("acks", "all");

        //重试次数
        props.put("retries", 3);

        //批次大小
        props.put("batch.size", 16384);

        //等待时间
        props.put("linger.ms", 1);

        //RecordAccumulator缓冲区大小
        props.put("buffer.memory", 33554432);  //32M

        // kv的序列化器
        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

        // 设置分区类
        props.put(ProducerConfig.PARTITIONER_CLASS_CONFIG,"com.wolffy.kafka.partitioner.MyPartitioner");

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

        //2. 生产数据
        for (int i = 0; i < 10; i++) {
            String value = "" ;
            if(i % 2 == 0){
                value = "wolffy==>" + i ;
            }else{
                value = UUID.randomUUID().toString() + "==>" + i ;
            }

            kafkaProducer.send(
                    new ProducerRecord<String, String>("first", value)
                    , new Callback() {
                        /**
                         * 当消息发送完成后， 会调用该方法
                         * @param metadata  消息的元数据信息.
                         *
                         * @param exception 当消息发送过程中,如果抛出异常，会传入到该方法.
                         */
                        @Override
                        public void onCompletion(RecordMetadata metadata, Exception exception) {
                            if(exception != null){
                                System.out.println("消息发送失败: " + exception.getMessage());
                            }else{
                                System.out.println("消息发送成功: " + metadata.topic() +
                                        " : " + metadata.partition() +
                                        " : " + metadata.offset()
                                       );
                            }
                        }
                    });
        }

        //3. 关闭对象
        kafkaProducer.close();
    }
}

package com.wolffy.kafka.partitioner;

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

import java.util.Map;

/**
 * 自定义分区器 需要实现Kafka提供的partitioner接口
 */
public class MyPartitioner implements Partitioner {
    /**
     * 计算分区号
     * 以first主题为例， 有两个分区.
     * 包含wolffy的消息发送0号分区
     * 其他消息发送1号分区
     *
     *
     * @param topic  当前消息发往的主题
     * @param key    当前消息的key
     * @param keyBytes  当前消息的key序列化后字节数组
     * @param value  当前消息的值
     * @param valueBytes 当前消息的值序列化后的字节数组
     * @param cluster
     * @return
     */
    @Override
    public int partition(String topic, Object key, byte[] keyBytes, Object value, byte[] valueBytes, Cluster cluster) {

        if(value.toString().contains("wolffy")){
            return 0 ;
        }else{
            return 1 ;
        }
    }
    @Override
    public void close() {

    }

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

    }
}

4.1.4 同步发送API

同步发送的意思就是，一条消息发送之后，会阻塞当前线程，直至返回ack。

由于send方法返回的是一个Future对象，根据Futrue对象的特点，我们也可以实现同步发送的效果，只需在调用Future对象的get方发即可。

package com.wolffy.kafka;

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

import java.util.Properties;
import java.util.concurrent.ExecutionException;

public class CustomProducer {

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

        Properties props = new Properties();

        props.put("bootstrap.servers", "hadoop102:9092");//kafka集群，broker-list

        props.put("acks", "all");

        props.put("retries", 1);//重试次数

        props.put("batch.size", 16384);//批次大小

        props.put("linger.ms", 1);//等待时间

        props.put("buffer.memory", 33554432);//RecordAccumulator缓冲区大小

        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

        Producer<String, String> producer = new KafkaProducer<>(props);
        for (int i = 0; i < 100; i++) {
            producer.send(new ProducerRecord<String, String>("first", Integer.toString(i), Integer.toString(i))).get();
        }
        producer.close();
    }
}

4.2 Consumer API

Consumer消费数据时的可靠性是很容易保证的，因为数据在Kafka中是持久化的，故不用担心数据丢失问题。

由于consumer在消费过程中可能会出现断电宕机等故障，consumer恢复后，需要从故障前的位置的继续消费，所以consumer需要实时记录自己消费到了哪个offset，以便故障恢复后继续消费。

所以offset的维护是Consumer消费数据是必须考虑的问题。

4.2.1 自动提交offset

1）编写代码

需要用到的类：

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

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

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

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

自动提交offset的相关参数：

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

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

2）消费者自动提交offset

package com.wolffy.kafka.consumer;

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

import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

/**
 * Kafka消费者
 */
public class KafkaConsumerDemo {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props = new Properties() ;
        // Kafka集群位置
        props.put("bootstrap.servers", "hadoop102:9092");
        // 消费者组id
        props.put("group.id", "suibian");

        // 自动提交offset
        props.put("enable.auto.commit", "true");
        // offset提交的间隔
        props.put("auto.commit.interval.ms", "1000");

        // kv的反序列化器
        props.put("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        props.put("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");

        //1. 创建消费者对象
        KafkaConsumer<String, String> kafkaConsumer = new KafkaConsumer<String, String>(props);

        //2. 订阅主题
        List<String> topics = new ArrayList<>();
        topics.add("first");
        topics.add("hello");
        //topics.add("second");
        kafkaConsumer.subscribe(topics);

        //3. 持续消费数据
        while(true){
            ConsumerRecords<String, String> records = kafkaConsumer.poll(Duration.ofSeconds(2));
            for (ConsumerRecord<String, String> record : records) {
                System.out.println("消费到: " + record.topic() +
                        " : " + record.partition() +
                        " : " + record.offset() +
                        " : " + record.key() +
                        " : " + record.value());
            }
        }
        kafkaConsumer.close();
    }
}

4.2.2 重置Offset

auto.offset.rest = earliest | latest | none |

package com.wolffy.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.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

/**
 * Kafka消费者  offset重置问题
 *
 * auto.offset.reset = earliest | latest
 *
 * 重置的情况:
 *  1. 新的组 当前的消费者组在kafka中没有消费记录
 *  2. 要消费的offset对应的消息已经被删除
 *
 */
public class KafkaConsumerDemo1 {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props = new Properties() ;
        // Kafka集群位置
        props.put("bootstrap.servers", "hadoop102:9092");
        // 消费者组id
        props.put("group.id", "lisi");

        // 自动提交offset
        props.put("enable.auto.commit", "true");
        // offset提交的间隔
        props.put("auto.commit.interval.ms", "1000");

        // kv的反序列化器
        props.put("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        props.put("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");

        // 重置offset
        props.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG,"earliest");

        //1. 创建消费者对象
        KafkaConsumer<String, String> kafkaConsumer = new KafkaConsumer<String, String>(props);

        //2. 订阅主题
        List<String> topics = new ArrayList<>();
        topics.add("first");
        topics.add("hello");
        //topics.add("second");
        kafkaConsumer.subscribe(topics);

        //3. 持续消费数据
        while(true){
            ConsumerRecords<String, String> records = kafkaConsumer.poll(Duration.ofSeconds(2));
            for (ConsumerRecord<String, String> record : records) {
                System.out.println("消费到: " + record.topic() +
                        " : " + record.partition() +
                        " : " + record.offset() +
                        " : " + record.key() +
                        " : " + record.value());
            }
        }
        kafkaConsumer.close();
    }
}

4.2.3 手动提交offset

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

手动提交offset的方法有两种：分别是commitSync（同步提交）和commitAsync（异步提交）。两者的相同点是，都会将本次poll的一批数据最高的偏移量提交；不同点是，commitSync阻塞当前线程，一直到提交成功，并且会自动失败重试（由不可控因素导致，也会出现提交失败）；而commitAsync则没有失败重试机制，故有可能提交失败。

1）同步提交offset

由于同步提交offset有失败重试机制，故更加可靠，以下为同步提交offset的示例。

package com.wolffy.kafka.consumer;

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

import java.time.Duration;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Properties;

/**
 * Kafka消费者  offset提交问题
 *  1. 自动提交
 *      enable.auto.commit = true
 *      auto.commit.interval.ms = 1000
 *  2. 手动提交
       enable.auto.commit = false
       1) 同步提交

       2) 异步提交

 */
public class KafkaConsumerDemo2 {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props = new Properties() ;
        // Kafka集群位置
        props.put("bootstrap.servers", "hadoop102:9092");
        // 消费者组id
        props.put("group.id", "lisi");

        // 自动提交offset
        props.put("enable.auto.commit", "false");
        // offset提交的间隔
        props.put("auto.commit.interval.ms", "1000");

        // kv的反序列化器
        props.put("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        props.put("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");

        // 重置offset
        props.put(ConsumerConfig.AUTO_OFFSET_RESET_CONFIG,"earliest");

        //1. 创建消费者对象
        KafkaConsumer<String, String> kafkaConsumer = new KafkaConsumer<String, String>(props);

        //2. 订阅主题
        List<String> topics = new ArrayList<>();
        topics.add("first");
        topics.add("hello");
        //topics.add("second");
        kafkaConsumer.subscribe(topics);

        //3. 持续消费数据
        while(true){
            System.out.println("进行下一次的消费");
            ConsumerRecords<String, String> records = kafkaConsumer.poll(Duration.ofSeconds(2));
            for (ConsumerRecord<String, String> record : records) {
                System.out.println("消费到: " + record.topic() +
                        " : " + record.partition() +
                        " : " + record.offset() +
                        " : " + record.key() +
                        " : " + record.value());
            }

            // 同步提交offset
            //System.out.println("同步提交offset");
            //kafkaConsumer.commitSync();

            // 异步提交offset
            kafkaConsumer.commitAsync(new OffsetCommitCallback() {
                //当offset提交完成后会调用该方法
                @Override
                public void onComplete(Map<TopicPartition, OffsetAndMetadata> offsets, Exception exception) {
                    if(exception !=null){
                        System.out.println("offset提交失败");
                    }else{
                        System.out.println("提交后的结果: " + offsets);
                    }
                }
            });
            System.out.println();
        }

        // 关闭生产者对象
        //kafkaConsumer.close();
    }
}

2）异步提交offset

虽然同步提交offset更可靠一些，但是由于其会阻塞当前线程，直到提交成功。因此吞吐量会收到很大的影响。因此更多的情况下，会选用异步提交offset的方式。

以下为异步提交offset的示例：

package com.wolffy.kafka.consumer;

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

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

public class CustomConsumer {

    public static void main(String[] args) {

        Properties props = new Properties();

        //Kafka集群
        props.put("bootstrap.servers", "hadoop102:9092"); 

        //消费者组，只要group.id相同，就属于同一个消费者组
        props.put("group.id", "test"); 

        //关闭自动提交offset
        props.put("enable.auto.commit", "false");

        props.put("key.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");
        props.put("value.deserializer", "org.apache.kafka.common.serialization.StringDeserializer");

        KafkaConsumer<String, String> consumer = new KafkaConsumer<>(props);
        consumer.subscribe(Arrays.asList("first"));//消费者订阅主题

        while (true) {
            ConsumerRecords<String, String> records = consumer.poll(100);//消费者拉取数据
            for (ConsumerRecord<String, String> record : records) {
                System.out.printf("offset = %d, key = %s, value = %s%n", record.offset(), record.key(), record.value());
            }

//异步提交
            consumer.commitAsync(new OffsetCommitCallback() {
                @Override
                public void onComplete(Map<TopicPartition, OffsetAndMetadata> offsets, Exception exception) {
                    if (exception != null) {
                        System.err.println("Commit failed for" + offsets);
                    }
                }
            }); 
        }
    }
}

3） 数据漏消费和重复消费分析

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

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线程中，因此不要在该方法中放入很重的逻辑，否则会拖慢producer的消息发送效率。

（4）close：

关闭interceptor，主要用于执行一些资源清理工作

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

4.3.2 拦截器案例

1）需求：

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

2）案例实操

（1）增加时间戳拦截器

package com.wolffy.kafka.interceptor;

import com.sun.org.apache.regexp.internal.RE;
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 TimeStampInterceptor implements ProducerInterceptor<String,String> {

    /**
     * 拦截器的核心处理方法
     * @param record  被拦截处理的消息
     * @return
     */
    @Override
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> record) {
        // 1. 获取消息的value
        String value = record.value();
        String result = System.currentTimeMillis() + "->" + value ;

        //2. 重新构建新的消息对象
        ProducerRecord<String, String> newRecord =
                new ProducerRecord<>(record.topic(), record.partition(), record.key(), result);

        return newRecord;
    }

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

    }

    @Override
    public void close() {

    }

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

    }
}

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

package com.wolffy.kafka.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 int success ;
    private int fail ;

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

    @Override
    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {
        if(exception != null){
            fail ++ ;
        }else{
            success ++ ;
        }
    }

    @Override
    public void close() {
        System.out.println("SUCCESS: " + success);
        System.out.println("FAIL: " + fail);
    }

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

    }
}

（3）producer主程序

package com.wolffy.kafka.interceptor;

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

import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

/**
 * 生产者 - 拦截器
 */
public class KafkaProducerInterceptor {
    public static void main(String[] args) {
        //0. 创建配置对象
        Properties props= new Properties();

        //kafka集群，broker-list
        props.put("bootstrap.servers", "hadoop102:9092");
        // ack的级别
        props.put("acks", "all");
        //重试次数
        props.put("retries", 3);
        //批次大小
        props.put("batch.size", 16384);
        //等待时间
        props.put("linger.ms", 1);
        //RecordAccumulator缓冲区大小
        props.put("buffer.memory", 33554432);  //32M
        // kv的序列化器
        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");

        // 配置拦截器
        List<String> interceptors = new ArrayList<String>();
        interceptors.add("com.wolffy.kafka.interceptor.TimeStampInterceptor");
        interceptors.add("com.wolffy.kafka.interceptor.CountInterceptor") ;
        props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG,interceptors);

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

        //2. 生产数据
        for (int i = 0; i < 20 ; i++) {
            kafkaProducer.send(new ProducerRecord<String,String>("first", "wolffy" + i));
        }

        //3. 关闭对象
        kafkaProducer.close();
    }
}

3）测试

（1）在kafka上启动消费者，然后运行客户端java程序。

[wolffy@hadoop102 kafka]$ bin/kafka-console-consumer.sh --bootstrap-server hadoop102:9092 --from-beginning --topic first
1501904047034,message0
1501904047225,message1
1501904047230,message2
1501904047234,message3
1501904047236,message4
1501904047240,message5
1501904047243,message6
1501904047246,message7
1501904047249,message8
1501904047252,message9

IT学习网站

牛牛IT网站