Kafka——producer拦截器

producer拦截器

producer拦截器(interceptor)是一个相当新的功能，它和consumer端interceptor是在Kafka0.l0.0.0版本中被引入的，主要用于实现clients端的定制化控制逻辑。

对于producer而言，interceptor使得用户在消息发送前以及producer回调逻辑前有机会对消息做一些定制化需求，比如修改消息等。同时，producer允许用户指定多个interceptor按序作用于同一条消息从而形成一个拦截链(interceptor chain)。

intercetpor的实现接口是
org.apache.kafka..clients.producer.ProducerInterceptor,其定义的方法如下:

• onSend(ProducerRecord):该方法封装进KafkaProducer.send方法中，即它运行在用户主线程中。producer确保在消息被序列化以计算分区前调用该方法。用户可以在该方法中对消息做任何操作，但最好保证不要修改消息所属的toc和分区，否则会影响目标分区的计算。
• onAcknowledgement(RecordMetadata, Exception):该方法会在消息被应答之前或消息发送失败时调用，并且通常都是在producer回调逻辑触发之前。onAcknowledgement运行在producer的I/O线程中，因此不要在该方法中放入很“重”的逻辑，否则会拖慢producer的消息发送效率。
• close:关闭interceptor,主要用于执行一些资源清理工作。

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

为了更好地说明interceptor的使用，下面实现一个简单的双interceptor组成的拦截链。第一个interceptor会在消息发送前将时间戳信息加到消息value的最前部；第二个interceptor会在消息发送后更新成功发送消息数或失败发送消息数。这两个interceptor实现的逻辑其实都很简单，特别是第一个interceptor做的事情实际上并无太大的实际意义。这里只是为了演示如何使用interceptor以及连接链。

首先，创建第一个interceptor——TimeStampPrependerInterceptor,关键代码如下：

public class TimeStampPrependerInterceptor implements ProducerInterceptor<String, String> {
    @Override
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> 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() {

    }

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

    }
}

上面代码的关键部分在于，在onSend方法中会创建一个新的record,把时间戳写入消息体的最前部。

下面定义第二个interceptor——CounterInterceptor,该interceptor会在消息发送后更新“发送成功消息数”和“发送失败消息数”两个计数器，并在producer关闭时打印这两个
计数器。完整代码如下：

public class CounterInterceptor implements ProducerInterceptor<String, String> {
    
    private int errorCounter = 0;
    private int successCounter = 0;
    
    @Override
    public ProducerRecord<String, String> onSend(ProducerRecord<String, String> 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);
    }

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

    }
}

定义好interceptor之后，需要在producer主程序中指定它们，代码如下：

public class InterceptorProducer {
    public static void main(String[] args) throws ExecutionException, InterruptedException {
        Properties properties = new Properties();
        properties.put("bootstrap.servers", "localhost:9092");
        properties.put("client.id", "DemoProducer");
        properties.put("key.serializer", "org.apache.kafka.common.serialization.IntegerSerializer");
        properties.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer");
        //构建拦截器链
        List<String> interceptors = new ArrayList<>();
        interceptors.add("book.interceptors.TimeStampPrependerInterceptor");
        interceptors.add("book.interceptors.CounterInterceptor");
        properties.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);

        String topic = "testTopic";
        Producer<String, String> producer = new KafkaProducer<String, String>(properties);
        for (int i = 0; i < 10; i++) {
            ProducerRecord<String, String> record = new ProducerRecord<>(topic, "message" + i);
            producer.send(record).get();
        }
        //一定要关闭producer，这样才会调用interceptor的close方法
        producer.close();
    }

程序输出：

Successful sent: 10
Failed sent: 0

利用kafka-console-consumer工具测试interceptor是否正常工作：

./kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic testTopic

如图所示，所有消息的value前面都被加上了发送时的时间戳。最终说明两个intercceptor都生效了。