Kafka 拦截器实践

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)：

  该方法会在消息被应答或消息发送失败时调用，并且通常都是在 producer 回调逻辑触
  发之前。onAcknowledgement 运行在 producer 的 IO 线程中，因此不要在该方法中放入很重的逻辑，否则会拖慢 producer 的消息发送效率

• （4）close：

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

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

时间拦截器：

package com.myStudy.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 TimerInterceptor implements ProducerInterceptor {
    /**
     * 该方法封装进 KafkaProducer.send 方法中，即它运行在用户主线程中。Producer 确保在
     * 消息被序列化以及计算分区前调用该方法
     * 用户可以在该方法中对消息做任何操作，但最好保证不要修改消息所属的 topic 和分区，否则会影响目标分区的计算
     *
     * @param record
     * @return
     */
    public ProducerRecord onSend(ProducerRecord record) {
        // 创建一个新的record，将时间戳写入记录的最前面,一个record就是一个记录
        return new ProducerRecord(
                record.topic(),
                record.partition(),
                record.timestamp(),
                record.key(),
                System.currentTimeMillis() + "---  " + record.value().toString());
    }
    /**
     * 该方法会在消息被应答或消息发送失败时调用，并且通常都是在 producer 回调逻辑触
     * 发之前。onAcknowledgement 运行在 producer 的 IO 线程中，因此不要在该方法中放入很重的逻辑，
     * 否则会拖慢 producer 的消息发送效率
     *
     * @param metadata
     * @param exception
     */
    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {
    }
    /**
     * 关闭 interceptor，主要用于执行一些资源清理工作
     */
    public void close() {
    }

    /**
     * 获取配置信息和初始化数据时调用
     *
     * @param configs
     */
    public void configure(Map<String, ?> configs) {
    }
}

计数拦截器：

package com.myStudy.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;
/**
 * 统计发送消息成功和发送失败消息数，并在 producer 关闭时打印这两个计数器
 */
public class CounterInterceptor implements ProducerInterceptor {

    private int successCount = 0;
    private int errorCount = 0;

    public ProducerRecord onSend(ProducerRecord record) {
        return null;
    }

    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {
        // 统计失败和成功的次数
        if (exception == null) {
            successCount++;
        } else {
            errorCount++;
        }
    }
    /**
     * 在关闭的时候保留结果
     */
    public void close() {
        System.out.println("success sent: " + successCount);
        System.out.println("error sent: " + errorCount);
    }
    public void configure(Map<String, ?> configs) {
    }
}

Producer程序：

package com.myStudy.interceptor;
import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerRecord;
import java.util.ArrayList;
import java.util.Properties;

/**
 * 主程序
 * 需求：实现一个简单的双 interceptor 组成的拦截链。
 * 第一个 interceptor 会在消息发送前将时间戳信息加到消息 value 的最前部；
 * 第二个 interceptor 会在消息发送后更新成功发送消息数
 */
public class ProduceInterceptor {
    public static void main(String[] args) {
        // 1.设置配置信息
        Properties props = new Properties();
        props.put("bootstrap.servers", "hadoop102:9092");
        props.put("acks", "all");
        props.put("retries", 0);
        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.构建拦截器
        ArrayList<String> interceptors = new ArrayList<String>();
        interceptors.add("com.myStudy.interceptor.TimerInterceptor");
        interceptors.add("com.myStudy.interceptor.CounterInterceptor");

        String topic = "first";

        KafkaProducer<String, String> producer = new KafkaProducer<String, String>(props);
        props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors); 

        // 3.发送消息
        for (int i = 0; i < 10; i++) {
            ProducerRecord<String, String> record = new ProducerRecord<String, String>(topic, "messsage" + i);
            producer.send(record);
        }
        // 4. 一定要关闭producer，这样才会调用interceptor的close方法
        producer.close();
    }
}

在Kafka上面启动消费者，然后运行程序生产数据进行测试。