Kafka10——自定义Interceptor

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

public interface ProducerInterceptor extends Configurable {
    //Producer 确保在消息被序列化以及计算分区前调用该方法
    public ProducerRecord onSend(ProducerRecord record);
	//在消息从 RecordAccumulator 成功发送到 Kafka Broker 之后，或者在发送过程中失败时调用
    public void onAcknowledgement(Recordmetadata metadata, Exception exception);
    //关闭 interceptor，主要用于执行一些资源清理工作
    public void close();
}

 其父接口 Configurable 的定义如下：

public interface Configurable {
	// 获取配置信息和初始化数据时调用
    void configure(Map configs);
}

 这四个方法的调用时机和作用如下：
 1、configure()
  获取配置信息和初始化数据时调用
 2、onSend()
  该方法的调用被封装进 KafkaProducer.send 方法中，即它运行在用户主线程中。KafkaProducer.send()的代码如下：

@Override
public Future send(ProducerRecord record, Callback callback) {
    // intercept the record, which can be potentially modified; this method does not throw exceptions
    ProducerRecord interceptedRecord = this.interceptors == null ? record : this.interceptors.onSend(record);
    return doSend(interceptedRecord, callback);
}

  onSend()的源码如下：

public ProducerRecord onSend(ProducerRecord record) {
    ProducerRecord interceptRecord = record;
    for (ProducerInterceptor interceptor : this.interceptors) {
        try {
            interceptRecord = interceptor.onSend(interceptRecord);
        } catch (Exception e) {
            // do not propagate interceptor exception, log and continue calling other interceptors
            // be careful not to throw exception from here
            if (record != null)
                log.warn("Error executing interceptor onSend callback for topic: {}, partition: {}", record.topic(), record.partition(), e);
            else
                log.warn("Error executing interceptor onSend callback", e);
        }
    }
    return interceptRecord;
}

  Producer 确保在消息被序列化以及计算分区前调用拦截器的onSend()方法。用户可以在该方法中对消息做任何操作，但最好保证不要修改消息所属的 topic 和分区，否则会影响目标分区的计算。
 3、onAcknowledgement()
  该方法会在消息从 RecordAccumulator 成功发送到 Kafka Broker 之后，或者在发送过程中失败时调用，并且通常都是在 producer 回调逻辑触发之前。onAcknowledgement 运行在 producer 的 IO 线程中，因此不要在该方法中放入很重的逻辑，否则会拖慢 producer 的消息发送效率。
 4、close()
  关闭 interceptor，主要用于执行一些资源清理工作。
  如前所述，interceptor 可能被运行在多个线程中，因此在具体实现时用户需要自行确保线程安全。另外，倘若指定了多个 interceptor，则 producer 将按照指定顺序调用它们，调用这些 intercepor 出现异常时 producer 仅仅是捕获这些抛出的异常并将错误日志记录到 warn 级别的log文件中而非继续向上抛出，这在使用过程中要特别留意。

二、拦截器案例
 实现一个简单的双 interceptor 组成的拦截链。第一个 interceptor 会在消息发送前将时间戳信息加到消息 value 的最前部；第二个 interceptor 会在消息发送后更新成功发送消息数或失败发送消息数。
  ①时间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 TimeInterceptor implements ProducerInterceptor {

    @Override
    public void configure(Map configs) {

    }

    @Override
    public ProducerRecord onSend(ProducerRecord 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() {

    }
}

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

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 CounterInterceptor implements ProducerInterceptor {

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

    @Override
    public void configure(Map configs) {

    }

    @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);
    }
}

  ③producer 主程序

import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.Producer;
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 InterceptorProducer {

    public static void main(String[] args) throws Exception {
        // 1 设置配置信息
        Properties props = new Properties();
        props.put("bootstrap.servers", "hadoop102:9092");
        props.put("acks", "all");
        props.put("retries", 3);
        props.put("batch.size", 16384);
        props.put("linger.ms", 1);
        props.put("buffer.memory", 33554432);
        props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        // 2 构建拦截链
        List interceptors = new ArrayList<>();
        interceptors.add("com.boom.toolbox.kafka.interceptor.TimeInterceptor");
        interceptors.add("com.boom.toolbox.kafka.interceptor.CounterInterceptor");
        props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);
        String topic = "first";
        Producer producer = new KafkaProducer<>(props);
        // 3 发送消息
        for (int i = 0; i < 10; i++) {
            ProducerRecord record = new ProducerRecord<>(topic, "message" + i);
            producer.send(record);
        }
        // 4 一定要关闭 producer，这样才会调用 interceptor 的 close 方法
        producer.close();
    }
}