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

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

（ 4 ） close ：

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

拦截器案例：

需求：

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

1、时间拦截器

package tyh.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;

/**
 * 时间拦截器
 * 在消息发送前将时间戳信息加到消息 value 的最前部
 */
public class TimeInterceptor implements ProducerInterceptor<String, String> {

    //对消息进行操作
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> record) {
        //在key前加时间戳
        return new ProducerRecord<String, String>(record.topic(), record.partition(), record.timestamp(),
                record.key(), System.currentTimeMillis() + "," + record.value(), record.headers());
    }

    //会在发送成功后调用或发送失败后调用
    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {

    }

    //关闭Interceptor
    public void close() {

    }

    //获取配置信息和初始化数据
    public void configure(Map<String, ?> configs) {

    }
}

2、统计拦截器

package tyh.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<String, String> {
    public static int success;
    public static int error;

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

    public void onAcknowledgement(RecordMetadata metadata, Exception exception) {
        //如果没有错误，则说明消息发送成功
        if (exception != null) {
            success++;
        } else {
            error++;
        }
    }

    //关闭前打印成功发送消息数和失败发送消息数
    public void close() {
        System.out.println("success:" + success);
        System.out.println("error:" + error);
    }

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

    }
}

3、producer

package tyh.Producer;

import org.apache.kafka.clients.producer.KafkaProducer;
import org.apache.kafka.clients.producer.ProducerConfig;
import org.apache.kafka.clients.producer.ProducerRecord;
import org.apache.kafka.common.serialization.StringSerializer;
import tyh.Interceptor.CounterInterceptor;
import tyh.Interceptor.TimeInterceptor;

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

public class InterceptorProducer {
    public static void main(String[] args) {

        //创建properties对象存储配置信息
        Properties properties = new Properties();

        //kafka集群配置信息
        properties.put(ProducerConfig.BOOTSTRAP_SERVERS_CONFIG, "hadoop100:9092");

        //key,Value的序列化器
        properties.put(ProducerConfig.KEY_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());
        properties.put(ProducerConfig.VALUE_SERIALIZER_CLASS_CONFIG, StringSerializer.class.getName());

        //自定义序列化器配置
        ArrayList<String> InterceptorList = new ArrayList<String>();
        InterceptorList.add(TimeInterceptor.class.getName());
        InterceptorList.add(CounterInterceptor.class.getName());
        properties.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, InterceptorList);

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

        //发送数据
        for (int i = 0; i < 10; i++) {
            producer.send(new ProducerRecord<String, String>("first", "message_" + i));
        }

        //关闭生产者
        producer.close();
    }
}