diff --git a/code/Kafka/kafka-basis/src/main/java/com/heibaiying/producers/SimpleProducer.java b/code/Kafka/kafka-basis/src/main/java/com/heibaiying/producers/SimpleProducer.java index 8987206..3f0a75d 100644 --- a/code/Kafka/kafka-basis/src/main/java/com/heibaiying/producers/SimpleProducer.java +++ b/code/Kafka/kafka-basis/src/main/java/com/heibaiying/producers/SimpleProducer.java @@ -1,6 +1,7 @@ package com.heibaiying.producers; 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; @@ -20,7 +21,7 @@ public class SimpleProducer { props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer"); props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer"); /*创建生产者*/ - org.apache.kafka.clients.producer.Producer producer = new KafkaProducer<>(props); + Producer producer = new KafkaProducer<>(props); for (int i = 0; i < 10; i++) { ProducerRecord record = new ProducerRecord<>(topicName, "hello" + i, "world" + i); diff --git a/notes/Kafka生产者详解.md b/notes/Kafka生产者详解.md index f5cfd19..6f658bb 100644 --- a/notes/Kafka生产者详解.md +++ b/notes/Kafka生产者详解.md @@ -1,3 +1,80 @@ +# Kafka生产者详解 + + + + +## 一、生产者发送消息的过程 + +首先介绍一下Kakfa生产者发送消息的过程： + ++ Kakfa 会将发送消息包装为ProducerRecord对象， ProducerRecord对象包含了目标主题和要发送的内容，同时还可以指定键或分区。在发送ProducerRecord对象前，生产者会先把键和值对象序列化成字节数组，这样它们才能够在网络上传输。 ++ 接下来，数据被传给分区器。如果之前已经在ProducerRecord对象里指定了分区，那么分区器就不会再做任何事情。如果没有指定分区 ，那么分区器会根据ProducerRecord对象的键来选择一个分区，紧接着，这条记录被添加到一个记录批次里，这个批次里的所有消息会被发送到相同的主题和分区上。有一个独立的线程负责把这些记录批次发送到相应的broker上。 ++ 服务器在收到这些消息时会返回一个响应。如果消息成功写入Kafka，就返回一个RecordMetaData对象，它包含了主题和分区信息，以及记录在分区里的偏移量。如果写入失败，则会返回一个错误。生产者在收到错误之后会尝试重新发送消息，如果达到指定的重试次数后还没有成功，则直接抛出异常，不再重试。 + +
+ +## 二、创建生产者 + +### 2.1 项目依赖 + +本项目采用Maven构建，想要调用Kafka生产者API，需要导入`kafka-clients`依赖，如下： + +```xml + + org.apache.kafka + kafka-clients + 2.2.0 + +``` + +### 2.2 创建生产者 + +创建Kafka时，以下三个属性是必须指定的： + ++ **bootstrap.servers** ：指定broker的地址清单，清单里不需要包含所有的broker地址，生产者会从给定的broker里查找broker的信息。不过建议至少要提供两个broker的信息作为容错； + ++ **key.serializer** ：指定键的序列化器； + ++ **value.serializer** ：指定值的序列化器。 + +创建的示例代码如下： + +```scala +public class SimpleProducer { + + public static void main(String[] args) { + + String topicName = "Hello-Kafka"; + + Properties props = new Properties(); + props.put("bootstrap.servers", "hadoop001:9092"); + props.put("key.serializer", "org.apache.kafka.common.serialization.StringSerializer"); + props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer"); + /*创建生产者*/ + Producer producer = new KafkaProducer<>(props); + + for (int i = 0; i < 10; i++) { + ProducerRecord record = new ProducerRecord<>(topicName, "hello" + i, + "world" + i); + /* 发送消息*/ + producer.send(record); + } + /*关闭生产者*/ + producer.close(); + } +} +``` + +### 2.3 测试 + #### 1. 启动Kakfa Kafka的运行依赖于zookeeper，需要预先启动，可以启动Kafka内置的zookeeper,也可以启动自己安装的。 @@ -37,7 +114,37 @@ bin/kafka-topics.sh --create \ # bin/kafka-console-consumer.sh --bootstrap-server hadoop001:9092 --topic Hello-Kafka --from-beginning ``` +#### 4. 运行项目 +此时可以看到消费者控制台，输出如下，这里`kafka-console-consumer`只会打印出值信息，不会打印出键信息。 + +
+ + + +## 二、发送消息 + +上面的示例程序调用了`send`方法发送消息后没有做任何操作，在这种情况下，我们是没有办法知道消息发送的结果。想要知道消息发送的结果，可以使用同步发送或者异步发送来实现。 + +### 2.1 同步发送 + +在调用`send`方法后可以接着调用`get()`方法，`send`方法的返回值是一个Future\对象，RecordMetadata里面包含了发送消息的主题、分区、偏移量等信息。改写后的代码如下： + +```scala +for (int i = 0; i < 10; i++) { + try { + ProducerRecord record = new ProducerRecord<>(topicName, "k" + i, "world" + i); + /*同步发送消息*/ + RecordMetadata metadata = producer.send(record).get(); + System.out.printf("topic=%s, partition=%d, offset=%s \n", + metadata.topic(), metadata.partition(), metadata.offset()); + } catch (InterruptedException | ExecutionException e) { + e.printStackTrace(); + } +} +``` + +此时得到的输出如下：偏移量和调用次数有关，所有记录都分配到了0分区，这是因为在创建`Hello-Kafka`主题时候，使用`--partitions`指定其分区数为1，即只有一个分区。 ```shell topic=Hello-Kafka, partition=0, offset=40 @@ -52,9 +159,106 @@ topic=Hello-Kafka, partition=0, offset=48 topic=Hello-Kafka, partition=0, offset=49 ``` +### 2.2 异步发送 + +通常情况下，我们并不关心发送成功的情况，更多关注的是失败的情况，基于这种需求，Kafka提供了异步发送和回调函数。 代码如下： + +```scala +for (int i = 0; i < 10; i++) { + ProducerRecord record = new ProducerRecord<>(topicName, "k" + i, "world" + i); + /*异步发送消息，并监听回调*/ + producer.send(record, new Callback() { + @Override + public void onCompletion(RecordMetadata metadata, Exception exception) { + if (exception != null) { + System.out.println("进行异常处理"); + } else { + System.out.printf("topic=%s, partition=%d, offset=%s \n", + metadata.topic(), metadata.partition(), metadata.offset()); + } + } + }); +} +``` +## 三、自定义分区器 + +Kafka有着默认的分区机制： + ++ 如果键值为 null ， 则使用轮询(Round Robin)算法将消息均衡地分布到各个分区上； ++ 如果键值不为null，那么Kafka会使用内置的散列算法对键进行散列，然后分布到各个分区上。 + +某些情况下，你可能有着自己的分区需求，这时候可以采用自定义分区器实现。这里给出一个自定义分区器的示例： + +### 3.1 自定义分区器 + +```java +/** + * 自定义分区器 + */ +public class CustomPartitioner implements Partitioner { + + private int passLine; + + @Override + public void configure(Map configs) { + /*从生产者配置中获取分数线*/ + passLine = (Integer) configs.get("pass.line"); + } + + @Override + public int partition(String topic, Object key, byte[] keyBytes, Object value, + byte[] valueBytes, Cluster cluster) { + /*key值为分数，当分数大于分数线时候，分配到1分区，否则分配到0分区*/ + return (Integer) key >= passLine ? 1 : 0; + } + + @Override + public void close() { + System.out.println("分区器关闭"); + } +} +``` + +需要在创建生产者时指定分区器，和分区器所需要的配置参数： + +```java +public class ProducerWithPartitioner { + + public static void main(String[] args) { + + String topicName = "Kafka-Partitioner-Test"; + + Properties props = new Properties(); + props.put("bootstrap.servers", "hadoop001:9092"); + props.put("key.serializer", "org.apache.kafka.common.serialization.IntegerSerializer"); + props.put("value.serializer", "org.apache.kafka.common.serialization.StringSerializer"); + + /*传递自定义分区器*/ + props.put("partitioner.class", "com.heibaiying.producers.partitioners.CustomPartitioner"); + /*传递分区器所需的参数*/ + props.put("pass.line", 6); + + Producer producer = new KafkaProducer<>(props); + + for (int i = 0; i <= 10; i++) { + String score = "score:" + i; + ProducerRecord record = new ProducerRecord<>(topicName, i, score); + /*异步发送消息*/ + producer.send(record, (metadata, exception) -> + System.out.printf("%s, partition=%d, \n", score, metadata.partition())); + } + + producer.close(); + } +} +``` + +### 3.2 测试 + +需要创建一个至少有两个分区的主题： ```shell bin/kafka-topics.sh --create \ @@ -63,7 +267,7 @@ topic=Hello-Kafka, partition=0, offset=49 --topic Kafka-Partitioner-Test ``` - +此时输入如下，可以看到分数大于等于6分的都被分到1分区，而小于6分的都被分到了0分区。 ```shell score:6, partition=1, @@ -80,3 +284,70 @@ score:5, partition=0, 分区器关闭 ``` + + +## 四、生产者其他属性 + +在上面生产者的创建中，我们都仅指定了服务地址，键序列化器、值序列化器，实际上Kafka生产者还很多可配置属性，如下： + +### 1. acks + +acks 参数指定了必须要有多少个分区副本收到消息，生产者才会认为消息写入是成功的： + +- acks=0 ： 生产者在成功写入消息之前不会等待任何来自服务器的响应； +- acks=1 ： 只要集群的首领节点收到消息，生产者就会收到一个来自服务器成功响应； +- acks=all ：只有当所有参与复制的节点全部收到消息时，生产者才会收到一个来自服务器的成功响应。 + +### 2. buffer.memory + +设置生产者内存缓冲区的大小。 + +### 3. compression.type + +默认情况下，发送的消息不会被压缩。如果想要进行压缩，可以配置此参数，可选值有snappy，gzip，lz4。 + +### 4. retries + +发生错误后，消息重发的次数。如果达到设定值，生产者就会放弃重试并返回错误。 + +### 5. batch.size + +当有多个消息需要被发送到同一个分区时，生产者会把它们放在同一个批次里。该参数指定了一个批次可以使用的内存大小，按照字节数计算。 + +### 6. linger.ms + +该参数制定了生产者在发送批次之前等待更多消息加入批次的时间。 + +### 7. clent.id + +客户端id,服务器用来识别消息的来源。 + +### 8. max.in.flight.requests.per.connection + +指定了生产者在收到服务器响应之前可以发送多少个消息。它的值越高，就会占用越多的内存，不过也会提升吞吐量，**把它设置为1可以保证消息是按照发送的顺序写入服务器，即使发生了重试**。 + +### 9. timeout.ms, request.timeout.ms和metadata.fetch.timeout.ms + +- timeout.ms 指定了borker等待同步副本返回消息的确认时间； +- request.timeout.ms 指定了生产者在发送数据时等待服务器返回响应的时间； +- metadata.fetch.timeout.ms 指定了生产者在获取元数据（比如分区首领是谁）时等待服务器返回响应的时间。 + +### 10. max.block.ms + +指定了在调用`send()`方法或使用`partitionsFor()`方法获取元数据时生产者的阻塞时间。当生产者的发送缓冲区已满，或者没有可用的元数据时，这些方法会阻塞。在阻塞时间达到max.block.ms 时，生产者会抛出超时异常。 + +### 11. max.request.size + +该参数用于控制生产者发送的请求大小。它可以指发送的单个消息的最大值，也可以指单个请求里所有消息总的大小。例如，假设这个值为1000K ，那么可以发送的单个最大消息为1000K ，或者生产者可以在单个请求里发送一个批次，该批次包含了 1000 个消息，每个消息大小为1K。 + +### 12. receive.buffer.bytes 和 send.buffer.byte + +这两个参数分别指定TCP socket 接收和发送数据包缓冲区的大小，-1代表使用操作系统的默认值。 + + + + + +## 参考资料 + +1. Neha Narkhede, Gwen Shapira ,Todd Palino(著) , 薛命灯(译) . Kafka权威指南 . 人民邮电出版社 . 2017-12-26 \ No newline at end of file