SpringBoot整合kafka全面實戰

 

本文是SpringBoot+Kafka的實戰講解，如果對kafka的架構原理還不瞭解的讀者，建議先看一下《大白話kafka架構原理》、《秒懂kafka HA（高可用）》兩篇文章。

一、生產者實踐

• 普通生產者

• 帶回撥的生產者

• 自定義分割槽器

• kafka事務提交

二、消費者實踐

• 簡單消費

• 指定topic、partition、offset消費

• 批量消費

• 監聽異常處理器

• 訊息過濾器

• 訊息轉發

• 定時啟動/停止監聽器

一、前戲

1、在專案中連線kafka，因為是外網，首先要開放kafka配置檔案中的如下配置（其中IP為公網IP），

advertised.listeners=PLAINTEXT://112.126.74.249:9092

2、在開始前我們先建立兩個topic：topic1、topic2，其分割槽和副本數都設定為2，用來測試，

1. [root@iZ2zegzlkedbo3e64vkbefZ ~]# cd /usr/local/kafka-cluster/kafka1/bin/

2. [root@iZ2zegzlkedbo3e64vkbefZ bin]# ./kafka-topics.sh --create --zookeeper 172.17.80.219:2181 --replication-factor 2 --partitions 2 --topic topic1

3. Created topic topic1.

4. [root@iZ2zegzlkedbo3e64vkbefZ bin]# ./kafka-topics.sh --create --zookeeper 172.17.80.219:2181 --replication-factor 2 --partitions 2 --topic topic2

5. Created topic topic2.

當然我們也可以不手動建立topic，在執行程式碼kafkaTemplate.send("topic1", normalMessage)傳送訊息時，kafka會幫我們自動完成topic的建立工作，但這種情況下建立的topic預設只有一個分割槽，分割槽也沒有副本。所以，我們可以在專案中新建一個配置類專門用來初始化topic，如下，

1. @Configuration

2. public class KafkaInitialConfiguration {

3. // 建立一個名為testtopic的Topic並設定分割槽數為8，分割槽副本數為2

4. @Bean

5. public NewTopic initialTopic() {

6. return new NewTopic("testtopic",8, (short) 2 );

7. }

8. ​

9. // 如果要修改分割槽數，只需修改配置值重啟專案即可

10. // 修改分割槽數並不會導致資料的丟失，但是分割槽數只能增大不能減小

11. @Bean

12. public NewTopic updateTopic() {

13. return new NewTopic("testtopic",10, (short) 2 );

14. }

15. }

3、新建SpringBoot專案

① 引入pom依賴

1. <dependency>

2. <groupId>org.springframework.kafka</groupId>

3. <artifactId>spring-kafka</artifactId>

4. </dependency>

② application.propertise配置（本文用到的配置項這裡全列了出來）

1. ###########【Kafka叢集】###########

2. spring.kafka.bootstrap-servers=112.126.74.249:9092,112.126.74.249:9093

3. ###########【初始化生產者配置】###########

4. # 重試次數

5. spring.kafka.producer.retries=0

6. # 應答級別:多少個分割槽副本備份完成時向生產者傳送ack確認(可選0、1、all/-1)

7. spring.kafka.producer.acks=1

8. # 批量大小

9. spring.kafka.producer.batch-size=16384

10. # 提交延時

11. spring.kafka.producer.properties.linger.ms=0

12. # 當生產端積累的訊息達到batch-size或接收到訊息linger.ms後,生產者就會將訊息提交給kafka

13. # linger.ms為0表示每接收到一條訊息就提交給kafka,這時候batch-size其實就沒用了

14. ​

15. # 生產端緩衝區大小

16. spring.kafka.producer.buffer-memory = 33554432

17. # Kafka提供的序列化和反序列化類

18. spring.kafka.producer.key-serializer=org.apache.kafka.common.serialization.StringSerializer

19. spring.kafka.producer.value-serializer=org.apache.kafka.common.serialization.StringSerializer

20. # 自定義分割槽器

21. # spring.kafka.producer.properties.partitioner.class=com.felix.kafka.producer.CustomizePartitioner

22. ​

23. ###########【初始化消費者配置】###########

24. # 預設的消費組ID

25. spring.kafka.consumer.properties.group.id=defaultConsumerGroup

26. # 是否自動提交offset

27. spring.kafka.consumer.enable-auto-commit=true

28. # 提交offset延時(接收到訊息後多久提交offset)

29. spring.kafka.consumer.auto.commit.interval.ms=1000

30. # 當kafka中沒有初始offset或offset超出範圍時將自動重置offset

31. # earliest:重置為分割槽中最小的offset;

32. # latest:重置為分割槽中最新的offset(消費分割槽中新產生的資料);

33. # none:只要有一個分割槽不存在已提交的offset,就丟擲異常;

34. spring.kafka.consumer.auto-offset-reset=latest

35. # 消費會話超時時間(超過這個時間consumer沒有傳送心跳,就會觸發rebalance操作)

36. spring.kafka.consumer.properties.session.timeout.ms=120000

37. # 消費請求超時時間

38. spring.kafka.consumer.properties.request.timeout.ms=180000

39. # Kafka提供的序列化和反序列化類

40. spring.kafka.consumer.key-deserializer=org.apache.kafka.common.serialization.StringDeserializer

41. spring.kafka.consumer.value-deserializer=org.apache.kafka.common.serialization.StringDeserializer

42. # 消費端監聽的topic不存在時，專案啟動會報錯(關掉)

43. spring.kafka.listener.missing-topics-fatal=false

44. # 設定批量消費

45. # spring.kafka.listener.type=batch

46. # 批量消費每次最多消費多少條訊息

47. # spring.kafka.consumer.max-poll-records=50

二、Hello Kafka

1、簡單生產者

1. @RestController

2. public class KafkaProducer {

3. @Autowired

4. private KafkaTemplate<String, Object> kafkaTemplate;

5. ​

6. // 傳送訊息

7. @GetMapping("/kafka/normal/{message}")

8. public void sendMessage1(@PathVariable("message") String normalMessage) {

9. kafkaTemplate.send("topic1", normalMessage);

10. }

11. }

 2、簡單消費

1. @Component

2. public class KafkaConsumer {

3. // 消費監聽

4. @KafkaListener(topics = {"topic1"})

5. public void onMessage1(ConsumerRecord<?, ?> record){

6. // 消費的哪個topic、partition的訊息,列印出訊息內容

7. System.out.println("簡單消費："+record.topic()+"-"+record.partition()+"-"+record.value());

8. }

9. }

上面示例建立了一個生產者，傳送訊息到topic1，消費者監聽topic1消費訊息。監聽器用@KafkaListener註解，topics表示監聽的topic，支援同時監聽多個，用英文逗號分隔。啟動專案，postman調介面觸發生產者傳送訊息，

可以看到監聽器消費成功，

三、生產者

1、帶回撥的生產者

kafkaTemplate提供了一個回撥方法addCallback，我們可以在回撥方法中監控訊息是否傳送成功 或 失敗時做補償處理，有兩種寫法，

1. @GetMapping("/kafka/callbackOne/{message}")

2. public void sendMessage2(@PathVariable("message") String callbackMessage) {

3. kafkaTemplate.send("topic1", callbackMessage).addCallback(success -> {

4. // 訊息傳送到的topic

5. String topic = success.getRecordMetadata().topic();

6. // 訊息傳送到的分割槽

7. int partition = success.getRecordMetadata().partition();

8. // 訊息在分割槽內的offset

9. long offset = success.getRecordMetadata().offset();

10. System.out.println("傳送訊息成功:" + topic + "-" + partition + "-" + offset);

11. }, failure -> {

12. System.out.println("傳送訊息失敗:" + failure.getMessage());

13. });

14. }

1. @GetMapping("/kafka/callbackTwo/{message}")

2. public void sendMessage3(@PathVariable("message") String callbackMessage) {

3. kafkaTemplate.send("topic1", callbackMessage).addCallback(new ListenableFutureCallback<SendResult<String, Object>>() {

4. @Override

5. public void onFailure(Throwable ex) {

6. System.out.println("傳送訊息失敗："+ex.getMessage());

7. }

8.  

9. @Override

10. public void onSuccess(SendResult<String, Object> result) {

11. System.out.println("傳送訊息成功：" + result.getRecordMetadata().topic() + "-"

12. + result.getRecordMetadata().partition() + "-" + result.getRecordMetadata().offset());

13. }

14. });

15. }

2、自定義分割槽器

我們知道，kafka中每個topic被劃分為多個分割槽，那麼生產者將訊息傳送到topic時，具體追加到哪個分割槽呢？這就是所謂的分割槽策略，Kafka 為我們提供了預設的分割槽策略，同時它也支援自定義分割槽策略。其路由機制為：

① 若傳送訊息時指定了分割槽（即自定義分割槽策略），則直接將訊息append到指定分割槽；

② 若傳送訊息時未指定 patition，但指定了 key（kafka允許為每條訊息設定一個key），則對key值進行hash計算，根據計算結果路由到指定分割槽，這種情況下可以保證同一個 Key 的所有訊息都進入到相同的分割槽；

③  patition 和 key 都未指定，則使用kafka預設的分割槽策略，輪詢選出一個 patition；

※ 我們來自定義一個分割槽策略，將訊息傳送到我們指定的partition，首先新建一個分割槽器類實現Partitioner介面，重寫方法，其中partition方法的返回值就表示將訊息傳送到幾號分割槽，

1. public class CustomizePartitioner implements Partitioner {

2. @Override

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

4. // 自定義分割槽規則(這裡假設全部發到0號分割槽)

5. // ......

6. return 0;

7. }

8. ​

9. @Override

10. public void close() {

11. ​

12. }

13. ​

14. @Override

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

16. ​

17. }

18. }

在application.propertise中配置自定義分割槽器，配置的值就是分割槽器類的全路徑名，

1. # 自定義分割槽器

2. spring.kafka.producer.properties.partitioner.class=com.felix.kafka.producer.CustomizePartitioner

3、kafka事務提交

如果在傳送訊息時需要建立事務，可以使用 KafkaTemplate 的 executeInTransaction 方法來宣告事務，

1. @GetMapping("/kafka/transaction")

2. public void sendMessage7(){

3. // 宣告事務：後面報錯訊息不會發出去

4. kafkaTemplate.executeInTransaction(operations -> {

5. operations.send("topic1","test executeInTransaction");

6. throw new RuntimeException("fail");

7. });

8. ​

9. // 不宣告事務：後面報錯但前面訊息已經傳送成功了

10. kafkaTemplate.send("topic1","test executeInTransaction");

11. throw new RuntimeException("fail");

12. }

四、消費者

1、指定topic、partition、offset消費

前面我們在監聽消費topic1的時候，監聽的是topic1上所有的訊息，如果我們想指定topic、指定partition、指定offset來消費呢？也很簡單，@KafkaListener註解已全部為我們提供，

1. /**

2. * @Title 指定topic、partition、offset消費

3. * @Description 同時監聽topic1和topic2，監聽topic1的0號分割槽、topic2的 "0號和1號" 分割槽，指向1號分割槽的offset初始值為8

4. * @Author long.yuan

5. * @Date 2020/3/22 13:38

6. * @Param [record]

7. * @return void

8. **/

9. @KafkaListener(id = "consumer1",groupId = "felix-group",topicPartitions = {

10. @TopicPartition(topic = "topic1", partitions = { "0" }),

11. @TopicPartition(topic = "topic2", partitions = "0", partitionOffsets = @PartitionOffset(partition = "1", initialOffset = "8"))

12. })

13. public void onMessage2(ConsumerRecord<?, ?> record) {

14. System.out.println("topic:"+record.topic()+"|partition:"+record.partition()+"|offset:"+record.offset()+"|value:"+record.value());

15. }

屬性解釋：

① id：消費者ID；

② groupId：消費組ID；

③ topics：監聽的topic，可監聽多個；

④ topicPartitions：可配置更加詳細的監聽資訊，可指定topic、parition、offset監聽。

上面onMessage2監聽的含義：監聽topic1的0號分割槽，同時監聽topic2的0號分割槽和topic2的1號分割槽裡面offset從8開始的訊息。

注意：topics和topicPartitions不能同時使用；

2、批量消費

設定application.prpertise開啟批量消費即可，

1. # 設定批量消費

2. spring.kafka.listener.type=batch

3. # 批量消費每次最多消費多少條訊息

4. spring.kafka.consumer.max-poll-records=50

接收訊息時用List來接收，監聽程式碼如下，

1. @KafkaListener(id = "consumer2",groupId = "felix-group", topics = "topic1")

2. public void onMessage3(List<ConsumerRecord<?, ?>> records) {

3. System.out.println(">>>批量消費一次，records.size()="+records.size());

4. for (ConsumerRecord<?, ?> record : records) {

5. System.out.println(record.value());

6. }

7. }

3、ConsumerAwareListenerErrorHandler 異常處理器

通過異常處理器，我們可以處理consumer在消費時發生的異常。

新建一個 ConsumerAwareListenerErrorHandler 型別的異常處理方法，用@Bean注入，BeanName預設就是方法名，然後我們將這個異常處理器的BeanName放到@KafkaListener註解的errorHandler屬性裡面，當監聽丟擲異常的時候，則會自動呼叫異常處理器，

1. // 新建一個異常處理器，用@Bean注入

2. @Bean

3. public ConsumerAwareListenerErrorHandler consumerAwareErrorHandler() {

4. return (message, exception, consumer) -> {

5. System.out.println("消費異常："+message.getPayload());

6. return null;

7. };

8. }

9. ​

10. // 將這個異常處理器的BeanName放到@KafkaListener註解的errorHandler屬性裡面

11. @KafkaListener(topics = {"topic1"},errorHandler = "consumerAwareErrorHandler")

12. public void onMessage4(ConsumerRecord<?, ?> record) throws Exception {

13. throw new Exception("簡單消費-模擬異常");

14. }

15. ​

16. // 批量消費也一樣，異常處理器的message.getPayload()也可以拿到各條訊息的資訊

17. @KafkaListener(topics = "topic1",errorHandler="consumerAwareErrorHandler")

18. public void onMessage5(List<ConsumerRecord<?, ?>> records) throws Exception {

19. System.out.println("批量消費一次...");

20. throw new Exception("批量消費-模擬異常");

21. }

執行看一下效果，

4、訊息過濾器

訊息過濾器可以在訊息抵達consumer之前被攔截，在實際應用中，我們可以根據自己的業務邏輯，篩選出需要的資訊再交由KafkaListener處理，不需要的訊息則過濾掉。

配置訊息過濾只需要為 監聽器工廠 配置一個RecordFilterStrategy（訊息過濾策略），返回true的時候訊息將會被拋棄，返回false時，訊息能正常抵達監聽容器。

1. @Component

2. public class KafkaConsumer {

3. @Autowired

4. ConsumerFactory consumerFactory;

5. ​

6. // 訊息過濾器

7. @Bean

8. public ConcurrentKafkaListenerContainerFactory filterContainerFactory() {

9. ConcurrentKafkaListenerContainerFactory factory = new ConcurrentKafkaListenerContainerFactory();

10. factory.setConsumerFactory(consumerFactory);

11. // 被過濾的訊息將被丟棄

12. factory.setAckDiscarded(true);

13. // 訊息過濾策略

14. factory.setRecordFilterStrategy(consumerRecord -> {

15. if (Integer.parseInt(consumerRecord.value().toString()) % 2 == 0) {

16. return false;

17. }

18. //返回true訊息則被過濾

19. return true;

20. });

21. return factory;

22. }

23. ​

24. // 訊息過濾監聽

25. @KafkaListener(topics = {"topic1"},containerFactory = "filterContainerFactory")

26. public void onMessage6(ConsumerRecord<?, ?> record) {

27. System.out.println(record.value());

28. }

29. }

上面實現了一個"過濾奇數、接收偶數"的過濾策略，我們向topic1傳送0-99總共100條訊息，看一下監聽器的消費情況，可以看到監聽器只消費了偶數，

5、訊息轉發

在實際開發中，我們可能有這樣的需求，應用A從TopicA獲取到訊息，經過處理後轉發到TopicB，再由應用B監聽處理訊息，即一個應用處理完成後將該訊息轉發至其他應用，完成訊息的轉發。

在SpringBoot整合Kafka實現訊息的轉發也很簡單，只需要通過一個@SendTo註解，被註解方法的return值即轉發的訊息內容，如下，

1. /**

2. * @Title 訊息轉發

3. * @Description 從topic1接收到的訊息經過處理後轉發到topic2

4. * @Author long.yuan

5. * @Date 2020/3/23 22:15

6. * @Param [record]

7. * @return void

8. **/

9. @KafkaListener(topics = {"topic1"})

10. @SendTo("topic2")

11. public String onMessage7(ConsumerRecord<?, ?> record) {

12. return record.value()+"-forward message";

13. }

6、定時啟動、停止監聽器

預設情況下，當消費者專案啟動的時候，監聽器就開始工作，監聽消費傳送到指定topic的訊息，那如果我們不想讓監聽器立即工作，想讓它在我們指定的時間點開始工作，或者在我們指定的時間點停止工作，該怎麼處理呢——使用KafkaListenerEndpointRegistry，下面我們就來實現：

① 禁止監聽器自啟動；

② 建立兩個定時任務，一個用來在指定時間點啟動定時器，另一個在指定時間點停止定時器；

新建一個定時任務類，用註解@EnableScheduling宣告，KafkaListenerEndpointRegistry 在SpringIO中已經被註冊為Bean，直接注入，設定禁止KafkaListener自啟動，

1. @EnableScheduling

2. @Component

3. public class CronTimer {

4. ​

5. /**

6. * @KafkaListener註解所標註的方法並不會在IOC容器中被註冊為Bean，

7. * 而是會被註冊在KafkaListenerEndpointRegistry中，

8. * 而KafkaListenerEndpointRegistry在SpringIOC中已經被註冊為Bean

9. **/

10. @Autowired

11. private KafkaListenerEndpointRegistry registry;

12. ​

13. @Autowired

14. private ConsumerFactory consumerFactory;

15. ​

16. // 監聽器容器工廠(設定禁止KafkaListener自啟動)

17. @Bean

18. public ConcurrentKafkaListenerContainerFactory delayContainerFactory() {

19. ConcurrentKafkaListenerContainerFactory container = new ConcurrentKafkaListenerContainerFactory();

20. container.setConsumerFactory(consumerFactory);

21. //禁止KafkaListener自啟動

22. container.setAutoStartup(false);

23. return container;

24. }

25. ​

26. // 監聽器

27. @KafkaListener(id="timingConsumer",topics = "topic1",containerFactory = "delayContainerFactory")

28. public void onMessage1(ConsumerRecord<?, ?> record){

29. System.out.println("消費成功："+record.topic()+"-"+record.partition()+"-"+record.value());

30. }

31. ​

32. // 定時啟動監聽器

33. @Scheduled(cron = "0 42 11 * * ? ")

34. public void startListener() {

35. System.out.println("啟動監聽器...");

36. // "timingConsumer"是@KafkaListener註解後面設定的監聽器ID,標識這個監聽器

37. if (!registry.getListenerContainer("timingConsumer").isRunning()) {

38. registry.getListenerContainer("timingConsumer").start();

39. }

40. //registry.getListenerContainer("timingConsumer").resume();

41. }

42. ​

43. // 定時停止監聽器

44. @Scheduled(cron = "0 45 11 * * ? ")

45. public void shutDownListener() {

46. System.out.println("關閉監聽器...");

47. registry.getListenerContainer("timingConsumer").pause();

48. }

49. }

啟動專案，觸發生產者向topic1傳送訊息，可以看到consumer沒有消費，因為這時監聽器還沒有開始工作，

11:42分監聽器啟動開始工作，消費訊息，

11：45分監聽器停止工作，

 

感興趣的可以關注一下博主的公眾號，1W+技術人的選擇，致力於原創技術乾貨，包含Redis、RabbitMQ、Kafka、SpringBoot、SpringCloud、ELK等熱門技術的學習&資料。