Kafka producer拦截器(interceptor)

　　Producer拦截器(interceptor)是个相当新的功能，它和consumer端interceptor是在Kafka 0.10版本被引入的，主要用于实现clients端的定制化控制逻辑。

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

onSend(ProducerRecord)：该方法封装进KafkaProducer.send方法中，即它运行在用户主线程中的。Producer确保在消息被序列化以计算分区前调用该方法。用户可以在该方法中对消息做任何操作，但最好保证不要修改消息所属的topic和分区，否则会影响目标分区的计算

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

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

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

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

TimeStampPrependerInterceptor类

public class TimeStampPrependerInterceptor implements ProducerInterceptor<String, String> {
@Override
public void configure(Map<String, ?> configs) {

}

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

上面代码关键的部分在于onSend方法中我们会创建一个新的record，把时间戳写入消息体的最前部。下面我们定义第二个interceptor：CounterInterceptor，该interceptor会在消息发送后更新"发送成功消息数"和"发送失败消息数"两个计数器，并在producer关闭时打印这两个计数器。完整代码如下所示：

CounterInterceptor类

public class CounterInterceptor implements ProducerInterceptor<String, String> {

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

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

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

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

Properties props = new Properties();
props.put(...);
// 构建拦截链
List<String> interceptors = new ArrayList<>();
interceptors.add("huxi.test.producer.TimeStampPrependerInterceptor"); // interceptor 1
interceptors.add("huxi.test.producer.CounterInterceptor"); // interceptor 2
props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);
...

String topic = "test-topic";
Producer<String, String> producer = new KafkaProducer<>(props);
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();

上面代码发送10条消息到Kafka，我们利用kafka-console-consumer工具来测试下两个interceptor是否工作正常。输出如下所示：



可见所有消息的value前面都被加上了发送时的时间戳，这就说明TimeStampPrependerInterceptor是正常工作的。而运行producer之后的输出如下：

Successful sent: 10

Failed sent: 0

此输出说明了CounterInterceptor也是能够正常工作的。我们的双interceptor构成的连接链生效了。