SpringBoot入门建站全系列（二十八）整合Kafka做日志监控

2020-05-28 16:26:57

SpringBoot入门建站全系列（二十八）整合Kafka做日志监控

一、概述

Apache Kafka是一个分布式发布 - 订阅消息系统和一个强大的队列，可以处理大量的数据，并使您能够将消息从一个端点传递到另一个端点。 Kafka适合离线和在线消息消费。 Kafka消息保留在磁盘上，并在群集内复制以防止数据丢失。 Kafka构建在ZooKeeper同步服务之上。它与Apache Storm和Spark非常好地集成，用于实时流式数据分析。

所以说，Kafka还是一个MQ，这时候，你肯定会想到ActiveMQ、RabbitMQ、RocketMQ等，在《Web基础配置篇（十）: ActiveMQ与RabbitMQ的安装配置及使用》一篇中，已经大概讲述了他们之间的区别，这里还是要简单说明一下：

ActiveMQ是java写的消息队列，ActiveMq几个月才发一次版本，社区已经不活跃了；
RabbitMQ是基于erlang开发，国人很少学erlang的，但社区还是蛮活跃的，而且性能极其好，延时很低；
RocketMQ是java写的，阿里的，网上都说怕它哪天gg了，中小型公司用起来就麻烦了，但是性能蛮好的；
Kafka是基于scala的，主要是面向大数据的，大的优点，就是吞吐量高。

所以，网上一般的推荐就是，中小型公司可以选择RabbitMQ，因为怕阿里不维护RocketMQ了，就没有能力去维护RocketMQ；大型软件公司可以选择rocketMq，因为有钱，所以有人维护。至于kafka，根据业务场景选择，大数据领域中以及日志采集，肯定是kafka了。

前面文章已经有整合过ActiveMQ和RabbitMQ:

《SpringBoot入门建站全系列（十七）整合ActiveMq（JMS类消息队列）》和SpringBoot入门建站全系列（十八）整合RabbitMQ（AMQP类消息队列）

本篇整合kafka，使用Spring kafka对kafka进行操作，后续会使用spring-integration-kafka进行整合。

代码可以在SpringBoot组件化构建https://www.pomit.cn/java/spring/springboot.html中的Kafka组件中查看，并下载。

地址：品茗IT-同步发布

如果大家正在寻找一个java的学习环境，或者在开发中遇到困难，可以加入我们的java学习圈，点击即可加入，共同学习，节约学习时间，减少很多在学习中遇到的难题。

二、配置

本文假设你已经引入spring-boot-starter-web。已经是个SpringBoot项目了,如果不会搭建，可以打开这篇文章看一看《SpringBoot入门建站全系列（一）项目建立》。

需要提前搭好Kafka，Web基础配置篇（十四）: Kafka单机、集群的安装配置及使用这里有Kafka的安装方法。

2.1 Maven依赖

使用activemq可以使用spring-boot-starter-activemq，方便快捷，一般springboot对大多数开源项目都做了整合，提供了专用的stater。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.kafka</groupId>
    <artifactId>spring-kafka</artifactId>
</dependency>

2.2 配置文件

在application.properties 中需要配置kafka的信息，也可以配置自定义的配置，如：

spring.kafka.bootstrap-servers=10.247.63.210:9092,10.247.62.76:9092

# producer
spring.kafka.producer.retries=1
spring.kafka.producer.value-serializer=org.springframework.kafka.support.serializer.JsonSerializer
spring.kafka.producer.properties.spring.json.add.type.headers=false

kafka.topics.log=logCenter


# consumer
# group id
spring.kafka.consumer.group-id=log_center_group
spring.kafka.consumer.auto-offset-reset=earliest
spring.kafka.consumer.enable-auto-commit=true
spring.kafka.consumer.auto-commit-interval=100
spring.kafka.consumer.value-deserializer=org.apache.kafka.common.serialization.StringDeserializer

这里面，

spring.kafka.bootstrap-servers是kafka的集群地址，必须配置。
spring.kafka.producer.retries是生产者重试次数
spring.kafka.producer.value-serializer是发送数据转换，这里配置的是转成成json数据。
kafka.topics.log，这是我自己定义的一个kafka的topics。
spring.kafka.consumer.group-id是kafka的消费group-id，带group-id能避免重复消费
spring.kafka.consumer.auto-offset-reset是消费开始时机
spring.kafka.consumer.enable-auto-commit是自动提交offset
spring.kafka.consumer.value-deserializer是数据解码方式；这个地方如果设置为JsonDeserializer，会提示No type information in headers and no default type provided，需要额外配置，https://stackoverflow.com/questions/55109508/spring-kafka-no-type-information-in-headers-and-no-default-type-provided 这里有人说可以使用StringDeserializer接收，然后使用StringJsonMessageConverter做转换，经试验单独消费使用StringJsonMessageConverter是的，所以自己用json工具转一下简单了。

注意：

只要不更改group.id，每次重新消费kafka，都是从上次消费结束的地方继续开始，不论auto.offset.reset属性设置的是什么
如果Kafka上积累了数据，想从新的地方开始消费，则可以更改group.id，auto.offset.reset设置为latest。
如果Kafka上积累了数据，想从开始的地方开始消费，则可以更改group.id，auto.offset.reset设置为earliest。

三、Kafka的使用

3.1 Topics的建立

可以使用脚本来建立，也可以使用代码建立。

Web基础配置篇（十四）: Kafka单机、集群的安装配置及使用这里有使用脚本建立topics的方式。

下面的config会建立新的topics，如果已经存在，这个bean会被忽略。

KafkaTopicsConfig :

package com.cff.springbootwork.kafka;

import org.apache.kafka.clients.admin.NewTopic;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

//如果不存topics，通过NewTopic新建
@Configuration
public class KafkaTopicsConfig {

    @Bean
    public NewTopic logCenter() {
        return new NewTopic("logCenter", 2, (short) 2);
    }

    @Bean
    public NewTopic logTest() {
        return new NewTopic("logCenter_test", 2, (short) 2);
    }
}

3.2 生产者（切面做日志监控）

kafka一般用来做日志分析，我们假设kafka会对应用的请求数据、业务处理数据搜集并提交给日志中心（可以是elk等）。

这里，我们用切面来对Controller层和Service层记录日志：

3.2.1 Controller层

KafkaTestRest：

package com.cff.springbootwork.kafka.web;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.cff.springbootwork.kafka.model.TransDataModel;
import com.cff.springbootwork.kafka.service.BusinessSerivce;

@RestController
@RequestMapping("/kafkaTest")
public class KafkaTestRest {
    @Autowired
    BusinessSerivce businessSerivce;

    @RequestMapping(value = "/test")
    public TransDataModel test(TransDataModel defaultMqModel) {
        return businessSerivce.doTrans(defaultMqModel);
    }

    @RequestMapping(value = "/test2")
    public TransDataModel test2(TransDataModel seccondMqModel) {
        return businessSerivce.doTrans(seccondMqModel);
    }
}

3.2.2 Service层

BusinessSerivce ：

package com.cff.springbootwork.kafka.service;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Service;

import com.cff.springbootwork.kafka.model.TransDataModel;

@Service
public class BusinessSerivce {
    private final Logger log = LoggerFactory.getLogger(this.getClass());

    public TransDataModel doTrans(TransDataModel defaultMqModel) {
        log.info("处理消息{}", defaultMqModel);

        defaultMqModel.setType("1111");

        return defaultMqModel;
    }
}

3.2.3 日志切面

KafkaLogAspect：

package com.cff.springbootwork.kafka.log;

import org.apache.kafka.clients.producer.ProducerRecord;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.kafka.core.KafkaTemplate;
import org.springframework.kafka.support.SendResult;
import org.springframework.stereotype.Component;
import org.springframework.util.concurrent.ListenableFuture;
import org.springframework.util.concurrent.ListenableFutureCallback;

import com.cff.springbootwork.kafka.model.KafkaLogModel;

@Aspect
@Component
public class KafkaLogAspect {
    @Autowired
    private KafkaTemplate<String, KafkaLogModel> kafkaTemplate;

    @Value("${kafka.topics.log}")
    private String logTopics;

    private Logger log = LoggerFactory.getLogger(KafkaLogAspect.class);

    @Around("execution(public * com.cff.springbootwork.kafka.service.BusinessSerivce.doTrans(..))")
    public Object doAroundService(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        KafkaLogModel kafkaLogModel = new KafkaLogModel();
        kafkaLogModel.setLogType("SERVICE");
        Object[] objs = proceedingJoinPoint.getArgs();
        kafkaLogModel.setReqContent(objs);
        Object obj = proceedingJoinPoint.proceed();
        kafkaLogModel.setResContent(obj);

        log.info("开始发送给kafka，数据{}", kafkaLogModel.toString());
        ProducerRecord<String, KafkaLogModel> record = new ProducerRecord<String, KafkaLogModel>(logTopics,
                kafkaLogModel);
        ListenableFuture<SendResult<String, KafkaLogModel>> future = kafkaTemplate.send(record);
        future.addCallback(new ListenableFutureCallback<SendResult<String, KafkaLogModel>>() {
            @Override
            public void onSuccess(SendResult<String, KafkaLogModel> result) {
                int partition = result.getRecordMetadata().partition();
                log.info("kafka存储partition为{}", partition);
            }

            @Override
            public void onFailure(Throwable ex) {

            }
        });

        log.info("开始发送给kafka，数据{}", kafkaLogModel.toString());
        return obj;
    }

    @Around("execution(public * com.cff.springbootwork.kafka.web.KafkaTestRest.*(..))")
    public Object doAroundController(ProceedingJoinPoint proceedingJoinPoint) throws Throwable {
        KafkaLogModel kafkaLogModel = new KafkaLogModel();
        kafkaLogModel.setLogType("CONTROLLER");
        Object[] objs = proceedingJoinPoint.getArgs();
        kafkaLogModel.setReqContent(objs);
        Object obj = proceedingJoinPoint.proceed();
        kafkaLogModel.setResContent(obj);

        log.info("开始发送给kafka，数据{}", kafkaLogModel.toString());
        ProducerRecord<String, KafkaLogModel> record = new ProducerRecord<String, KafkaLogModel>(logTopics,
                kafkaLogModel);
        kafkaTemplate.send(record);

        log.info("开始发送给kafka，数据{}", kafkaLogModel.toString());
        return obj;
    }
}

这里，

分别对doAroundController和doAroundService对Controller、Service做切面。
组建日志对象KafkaLogModel，并组建ProducerRecord对象，补全topics信息，也可以指定分区、key等信息。
kafkaTemplate发送消息。可以使用ListenableFuture对发送结果进行处理。

3.3 消费者

消费者一般和生产者是不在一起的，这里为了测试，就写在一起了。

消费者只需要使用@KafkaListener注解相应的方法即可。参数是字符串，接收消息。

这个地方如果设置为JsonDeserializer，会提示No type information in headers and no default type provided，需要额外配置，https://stackoverflow.com/questions/55109508/spring-kafka-no-type-information-in-headers-and-no-default-type-provided 这里有人说可以使用StringDeserializer接收，然后使用StringJsonMessageConverter做转换，经试验单独消费使用StringJsonMessageConverter是的，所以自己用json工具转一下简单了。

KafkaLogConsumer :

package com.cff.springbootwork.kafka.consumer;

import java.io.IOException;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.kafka.annotation.KafkaListener;
import org.springframework.stereotype.Component;

import com.cff.springbootwork.kafka.model.KafkaLogModel;
import com.fasterxml.jackson.databind.ObjectMapper;

@Component
public class KafkaLogConsumer {
    private Logger log = LoggerFactory.getLogger(this.getClass());

    @KafkaListener(topics = { "${kafka.topics.log}" })
    public void consumer(String message) {
        ObjectMapper mapper = new ObjectMapper();
        KafkaLogModel kafkaLogModel;
        try {
            kafkaLogModel = mapper.readValue(message, KafkaLogModel.class);
            log.info("收到消息：{}", kafkaLogModel.toString());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}