kafka详解(03) - kafka JAVA API

kafka详解(03) - kafka JAVA API

Producer (生产者)API

消息发送流程

Kafka的Producer发送消息采用的是异步发送的方式。在消息发送的过程中，涉及到了两个线程——main线程和Sender线程，以及一个线程共享变量——RecordAccumulator。main线程将消息发送给RecordAccumulator，Sender线程不断从RecordAccumulator中拉取消息发送到Kafka broker。

相关参数：

batch.size：只有数据积累到batch.size之后，sender才会发送数据。

linger.ms：如果数据迟迟未达到batch.size，sender等待linger.time之后就会发送数据。

异步发送API

1）新建项目导入依赖

<dependencies>

<dependency>

<groupId>org.apache.kafka</groupId>

<artifactId>kafka-clients</artifactId>

<version>2.4.1</version>

</dependency>

<dependency>

<groupId>org.apache.logging.log4j</groupId>

<artifactId>log4j-slf4j-impl</artifactId>

<version>2.12.0</version>

</dependency>

</dependencies>

2）添加log4j配置文件

在项目src/main/resource目录下新建log4j2.xml文件，并在文件中添加如下内容

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="error" strict="true" name="XMLConfig">

<Appenders>

<!-- 类型名为Console，名称为必须属性 -->

<Appender type="Console" name="STDOUT">

<!-- 布局为PatternLayout的方式，

输出样式为[INFO] [2018-01-22 17:34:01][org.test.Console]I'm here -->

<Layout type="PatternLayout"

pattern="[%p] [%d{yyyy-MM-dd HH:mm:ss}][%c{10}]%m%n" />

</Appender>

</Appenders>

<Loggers>

<!-- 可加性为false -->

<Logger name="test" level="info" additivity="false">

<AppenderRef ref="STDOUT" />

</Logger>

<!-- root loggerConfig设置 -->

<Root level="info">

<AppenderRef ref="STDOUT" />

</Root>

</Loggers>

</Configuration>

3）编写代码

需要创建的类：

新建包名：com.zhangjk.kafka.producer

不带回调函数的API

package com.zhangjk.kafka.producer;

import org.apache.kafka.clients.producer.*;

import java.util.Properties;

public
class CustomProducer {

public
static
void main(String[] args)
{

Properties props =
new Properties();

//配置信息

props.put("bootstrap.servers",
"hadoop102:9092");//kafka集群，broker-list

props.put("acks",
"all");

props.put("retries",
1);//重试次数

props.put("batch.size",
16384);//批次大小

props.put("linger.ms",
1);//等待时间

props.put("buffer.memory",
33554432);//RecordAccumulator缓冲区大小

props.put("key.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

props.put("value.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

Producer<String, String> producer =
new KafkaProducer<>(props);

for
(int i =
0; i <
100; i++)
{

producer.send(new ProducerRecord<String, String>("test", Integer.toString(i), Integer.toString(i)));

}

producer.close();

}

}

带回调函数的API

回调函数会在producer收到ack时调用，为异步调用，该方法有两个参数，分别是RecordMetadata和Exception，如果Exception为null，说明消息发送成功，如果Exception不为null，说明消息发送失败。

注意：消息发送失败会自动重试，不需要在回调函数中手动重试。

package com.zhangjk.kafka.producer;

import org.apache.kafka.clients.producer.*;

import java.util.Properties;

import java.util.concurrent.ExecutionException;

public
class CustomProducerCallback {

public
static
void main(String[] args){

//配置信息

Properties props =
new Properties();

props.put("bootstrap.servers",
"hadoop102:9092");//kafka集群，broker-list

props.put("acks",
"all");

props.put("retries",
1);//重试次数

props.put("batch.size",
16384);//批次大小

props.put("linger.ms",
1);//等待时间

props.put("buffer.memory",
33554432);//RecordAccumulator缓冲区大小

props.put("key.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

props.put("value.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

Producer<String, String> producer =
new KafkaProducer<>(props);

for
(int i =
0; i <
100; i++)
{

producer.send(new ProducerRecord<String, String>("test", Integer.toString(i), Integer.toString(i)),
new Callback()
{

//回调函数，该方法会在Producer收到ack时调用，为异步调用

@Override

public
void onCompletion(RecordMetadata metadata, Exception exception)
{

if
(exception ==
null)
{

System.out.println("success->"
+ metadata.offset());

}
else
{

exception.printStackTrace();

}

}

});

}

producer.close();

}

}

分区器

1. 默认的分区器 DefaultPartitioner
2. 自定义分区器

package com.zhangjk.kafka.producer;

import org.apache.kafka.clients.producer.Partitioner;

import org.apache.kafka.common.Cluster;

import java.util.Map;

public
class MyPartitioner implements Partitioner {

/**

* 计算某条消息要发送到哪个分区

* @param topic 主题

* @param key 消息的key

* @param keyBytes 消息的key序列化后的字节数组

* @param value 消息的value

* @param valueBytes 消息的value序列化后的字节数组

* @param cluster

* @return

*

* 需求: 以part_test主题为例，2个分区

* 消息的 value包含"hadoop"的
进入0号分区

* 其他的消息进入1号分区

*/

@Override

public
int partition(String topic, Object key,
byte[] keyBytes, Object value,
byte[] valueBytes, Cluster cluster)
{

String msgValue = value.toString();

int partition ;

if(msgValue.contains("hadoop")){

partition =
0;

}else{

partition =
1;

}

return partition;

}

//收尾工作

@Override

public
void close()
{

}

/**

* 读取配置

* @param configs

*/

@Override

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

}

}

同步发送API

同步发送的意思就是，一条消息发送之后，会阻塞当前线程，直至返回ack。

由于send方法返回的是一个Future对象，根据Futrue对象的特点，也可以实现同步发送的效果，只需在调用Future对象的get方发即可。

package com.zhangjk.kafka.producer;

import org.apache.kafka.clients.producer.KafkaProducer;

import org.apache.kafka.clients.producer.Producer;

import org.apache.kafka.clients.producer.ProducerRecord;

import java.util.Properties;

import java.util.concurrent.ExecutionException;

public
class CustomProducerSync {

public
static
void main(String[] args)
throws ExecutionException, InterruptedException {

Properties props =
new Properties();

props.put("bootstrap.servers",
"hadoop102:9092");//kafka集群，broker-list

props.put("acks",
"all");

props.put("retries",
1);//重试次数

props.put("batch.size",
16384);//批次大小

props.put("linger.ms",
1);//等待时间

props.put("buffer.memory",
33554432);//RecordAccumulator缓冲区大小

props.put("key.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

props.put("value.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

Producer<String, String> producer =
new KafkaProducer<>(props);

for
(int i =
0; i <
100; i++)
{

producer.send(new ProducerRecord<String, String>("test", Integer.toString(i), Integer.toString(i))).get();

}

producer.close();

}

}

Consumer (消费者)API

Consumer消费数据时的可靠性是很容易保证的，因为数据在Kafka中是持久化的，故不用担心数据丢失问题。

由于consumer在消费过程中可能会出现断电宕机等故障，consumer恢复后，需要从故障前的位置的继续消费，所以consumer需要实时记录自己消费到了哪个offset，以便故障恢复后继续消费。

所以offset的维护是Consumer消费数据是必须考虑的问题。

自动提交offset

编写代码

新建包名：com.zhangjk.kafka.consumer

为了使使用者能够专注于自己的业务逻辑，Kafka提供了自动提交offset的功能。

自动提交offset的相关参数：

enable.auto.commit：是否开启自动提交offset功能

auto.commit.interval.ms：自动提交offset的时间间隔

自动提交offset

package com.zhangjk.kafka.consumer;

import org.apache.kafka.clients.consumer.ConsumerRecord;

import org.apache.kafka.clients.consumer.ConsumerRecords;

import org.apache.kafka.clients.consumer.KafkaConsumer;

import java.util.Arrays;

import java.util.Properties;

public
class CustomConsumer {

public
static
void main(String[] args)
{

Properties props =
new Properties();

props.put("bootstrap.servers",
"hadoop102:9092");

props.put("group.id",
"test");

props.put("enable.auto.commit",
"true");

props.put("auto.commit.interval.ms",
"1000");

props.put("key.deserializer",
"org.apache.kafka.common.serialization.StringDeserializer");

props.put("value.deserializer",
"org.apache.kafka.common.serialization.StringDeserializer");

KafkaConsumer<String, String> consumer =
new KafkaConsumer<>(props);

consumer.subscribe(Arrays.asList("test"));

while
(true)
{

ConsumerRecords<String, String> records = consumer.poll(100);

for
(ConsumerRecord<String, String> record : records)

System.out.printf("offset = %d, key = %s, value = %s%n", record.offset(), record.key(), record.value());

}

}

}

重置Offset

auto.offset.rest = earliest | latest | none |

手动提交offset

虽然自动提交offset十分简介便利，但由于其是基于时间提交的，开发人员难以把握offset提交的时机。因此Kafka还提供了手动提交offset的API。

手动提交offset的方法有两种：分别是commitSync（同步提交）和commitAsync（异步提交）。两者的相同点是，都会将本次poll的一批数据最高的偏移量提交；不同点是，commitSync阻塞当前线程，一直到提交成功，并且会自动失败重试（由不可控因素导致，也会出现提交失败）；而commitAsync则没有失败重试机制，故有可能提交失败。

1）同步提交offset

由于同步提交offset有失败重试机制，故更加可靠，以下为同步提交offset的示例。

package com.zhangjk.kafka.producer;

import org.apache.kafka.clients.producer.*;

import java.util.Properties;

public
class CustomProducer {

public
static
void main(String[] args)
{

Properties props =
new Properties();

//配置信息

props.put("bootstrap.servers",
"hadoop102:9092");//kafka集群，broker-list

props.put("acks",
"all");

props.put("retries",
1);//重试次数

props.put("batch.size",
16384);//批次大小

props.put("linger.ms",
1);//等待时间

props.put("buffer.memory",
33554432);//RecordAccumulator缓冲区大小

props.put("key.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

props.put("value.serializer",
"org.apache.kafka.common.serialization.StringSerializer");

Producer<String, String> producer =
new KafkaProducer<>(props);

for
(int i =
0; i <
100; i++)
{

producer.send(new ProducerRecord<String, String>("test", Integer.toString(i), Integer.toString(i)));

}

producer.close();

}

}

2）异步提交offset

虽然同步提交offset更可靠一些，但是由于其会阻塞当前线程，直到提交成功。因此吞吐量会收到很大的影响。因此更多的情况下，会选用异步提交offset的方式。

以下为异步提交offset的示例：

package com.zhangjk.kafka.consumer;

import org.apache.kafka.clients.consumer.*;

import org.apache.kafka.common.TopicPartition;

import java.util.Arrays;

import java.util.Map;

import java.util.Properties;

public
class CustomConsumerManualAsyn {

public
static
void main(String[] args)
{

Properties props =
new Properties();

props.put("bootstrap.servers",
"hadoop102:9092");

//消费者组，只要group.id相同，就属于同一个消费者组

props.put("group.id",
"test");

//关闭自动提交offset

props.put("enable.auto.commit",
"false");

props.put("key.deserializer",
"org.apache.kafka.common.serialization.StringDeserializer");

props.put("value.deserializer",
"org.apache.kafka.common.serialization.StringDeserializer");

KafkaConsumer<String, String> consumer =
new KafkaConsumer<>(props);

consumer.subscribe(Arrays.asList("test"));//消费者订阅主题

while
(true)
{

ConsumerRecords<String, String> records = consumer.poll(100);//消费者拉取数据

for
(ConsumerRecord<String, String> record : records)
{

System.out.printf("offset = %d, key = %s, value = %s%n", record.offset(), record.key(), record.value());

}

//异步提交offset

consumer.commitAsync(new OffsetCommitCallback()
{

@Override

public
void onComplete(Map<TopicPartition, OffsetAndMetadata> offsets, Exception exception)
{

if
(exception !=
null)
{

System.err.println("Commit failed for"
+ offsets);

}

}

});

}

}

}

1. 数据漏消费和重复消费分析
   

无论是同步提交还是异步提交offset，都有可能会造成数据的漏消费或者重复消费。先提交offset后消费，有可能造成数据的漏消费；而先消费后提交offset，有可能会造成数据的重复消费。

自定义Interceptor(拦截器）

拦截器原理

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会在消息发送后更新成功发送消息数或失败发送消息数。

案例实操

新建包名：com.zhangjk.kafka.interceptor

增加时间戳拦截器

package com.zhangjk.kafka.interceptor;

import java.util.Map;

import org.apache.kafka.clients.producer.ProducerInterceptor;

import org.apache.kafka.clients.producer.ProducerRecord;

import org.apache.kafka.clients.producer.RecordMetadata;

public
class TimeInterceptor implements ProducerInterceptor<String, String>
{

@Override

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

}

@Override

public ProducerRecord<String, String> onSend(ProducerRecord<String, String> 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关闭时打印这两个计数器

package com.zhangjk.kafka.interceptor;

import java.util.Map;

import org.apache.kafka.clients.producer.ProducerInterceptor;

import org.apache.kafka.clients.producer.ProducerRecord;

import org.apache.kafka.clients.producer.RecordMetadata;

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

}

}

producer主程序

package com.zhangjk.kafka.interceptor;

import java.util.ArrayList;

import java.util.List;

import java.util.Properties;

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;

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<String> interceptors =
new ArrayList<>();

interceptors.add("com.zhangjk.kafka.interceptor.TimeInterceptor");

interceptors.add("com.zhangjk.kafka.interceptor.CounterInterceptor");

props.put(ProducerConfig.INTERCEPTOR_CLASSES_CONFIG, interceptors);

String topic =
"test";

Producer<String, String> producer =
new KafkaProducer<>(props);

// 3 发送消息

for
(int i =
0; i <
10; i++)
{

ProducerRecord<String, String> record =
new ProducerRecord<>(topic,
"message"
+ i);

producer.send(record);

}

// 4 一定要关闭producer，这样才会调用interceptor的close方法

producer.close();

}

}

测试

在kafka服务器上通过shell命令启动消费者，

[hadoop@hadoop102 kafka]$ bin/kafka-console-consumer.sh --bootstrap-server hadoop102:9092 --topic test

运行客户端java程序并查看测试结果。