关于SpringKafka消费者的几个监听器:[一次处理单条消息和一次处理一批消息]以及[自动提交offset和手动提交offset]

自己在使用Spring Kafka 的消费者消费消息的时候的实践总结：

接口 KafkaDataListener 是spring-kafka提供的一个供消费者接受消息的顶层接口,也是一个空接口;
public interface KafkaDataListener<T> {}

对于消费端接收消息的时候,spring-kafka的设计思路是,提供一个顶层接口,提供两个子类,一个子类是自动提交offset的,另一个子类是手动提交offset的.
无论是自动提交offset还是手动提交offset,又各分为两种,一种是一次只处理一条消息,另一种是一次可以处理一批消息.

该 KafkaDataListener 顶层接口有两个实现类:GenericMessageListener 和 GenericAcknowledgingMessageListener,
二者的区别是，前者是自动提交offset，后者是手动提交offset。

1、 GenericMessageListener 
    该接口是自动提交offset,它的onMessage方法的参数只有一个,就是传递过来的一条消息;
    public interface GenericMessageListener<T> extends KafkaDataListener<T> {void onMessage(T data);}
    这个接口又有两个子接口:MessageListener 和 BatchMessageListener
    这两个接口也都是空接口,二者的区别是,前者一次只处理一条消息,后者一次处理一批消息.
    
    //一次处理一条消息
    //消费者如果实现该接口的话,如果配置中设置max.poll.records参数大于1的话是无效的,因为它一次只处理一条消息
    public interface MessageListener<K, V> extends GenericMessageListener<ConsumerRecord<K, V>> {}
    //一次可以处理一批消息,每一批次的消息总条数是随机的,但可以在消费者的配置中设置一个最大值（max.poll.records,
    //比如设置了最大拉取的消息条数为100,那么onMessage方法每次接受到的消息条数是随机的,但最大不会超过100）
    public interface BatchMessageListener<K, V> extends GenericMessageListener<List<ConsumerRecord<K, V>>> {}
    
2、 GenericAcknowledgingMessageListener
    该接口是手动提交offset,它的onMessage方法的参数有两个,第一个是传递过来的一条消息,第二个参数是用于提交offset的对象
    public interface GenericAcknowledgingMessageListener<T> extends KafkaDataListener<T> {void onMessage(T data, Acknowledgment acknowledgment);}
    
    这个接口也有两个子接口:AcknowledgingMessageListener 和 BatchAcknowledgingMessageListener,这两个接口也都是空接口.
    //一次只处理一条消息,并手动提交offset,需要在消费者的配置中设置<property name="ackMode" value="MANUAL_IMMEDIATE"/>
    public interface AcknowledgingMessageListener<K, V> extends GenericAcknowledgingMessageListener<ConsumerRecord<K, V>> {}
    //一次处理一批消息,处理完这一批消息之后，在批量提交offset,需要在消费者的配置中设置<property name="ackMode" value="MANUAL"/>
    public interface BatchAcknowledgingMessageListener<K, V> extends GenericAcknowledgingMessageListener<List<ConsumerRecord<K, V>>> {}

下面的消费者继承的是MessageListener这个监听器，就是一次处理一条消息，而且是自动提交offset：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;
import com.xxxxxx.consumer.dto.FriendRelationDto;
import com.xxxxxx.consumer.dto.MessageDto;
import com.xxxxxx.consumer.service.FriendRelationService;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.kafka.listener.MessageListener;
import org.springframework.stereotype.Service;
import java.io.IOException;

/**
 * Created by SYJ on 2017/3/21.
 */
@Service
public class ConsumerService implements MessageListener<Integer, String> {

    private static final Logger logger = LoggerFactory.getLogger(ConsumerService.class);
    @Autowired
    private FriendRelationService friendRelationService;

    /**
     * 消息监听方法
     * @param record
     */
    @Override
    public void onMessage(ConsumerRecord<Integer, String> record) {
        logger.info("Before receiving:" + record.toString());
        String value = record.value();
        MessageDto<FriendRelationDto> message = JSON.parseObject(value, new TypeReference<MessageDto<FriendRelationDto>>(){});
        try {
            friendRelationService.process(message.getData());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

下面的消费者实现的BatchMessageListener这个监听器，就是一次接受一批消息,消息的数量是随机的，但最大不会超过"max.poll.records"参数配置的数量：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;
import com.xxxxxx.consumer.dto.FriendRelationDto;
import com.xxxxxx.consumer.dto.MessageDto;
import com.xxxxxx.consumer.service.FriendRelationService;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.kafka.listener.BatchMessageListener;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.util.List;

/**
 * Created by SYJ on 2017/3/21.
 */
@Service
public class ConsumerService implements BatchMessageListener<Integer, String> {

    private static final Logger logger = LoggerFactory.getLogger(ConsumerService.class);
    @Autowired
    private FriendRelationService friendRelationService;

    @Override
    public void onMessage(List<ConsumerRecord<Integer, String>> recordList) {
        for (ConsumerRecord<Integer, String> record : recordList) {
            logger.info("Before receiving:" + record.toString());
            String value = record.value();
            MessageDto<FriendRelationDto> message = JSON.parseObject(value, new TypeReference<MessageDto<FriendRelationDto>>(){});
            try {
                friendRelationService.process(message.getData());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

    }
}

下面的消费者实现的是AcknowledgingMessageListener这个监听器，它的特点是一次接收一条消息，可以通过acknowledgment来手动提交offset，需要在消费者的配置中指定<property name="ackMode" value="MANUAL_IMMEDIATE"/>：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;
import com.xxxxxx.consumer.dto.FriendRelationDto;
import com.xxxxxx.consumer.dto.MessageDto;
import com.xxxxxx.consumer.service.FriendRelationService;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.kafka.listener.AcknowledgingMessageListener;
import org.springframework.kafka.support.Acknowledgment;
import org.springframework.stereotype.Service;

import java.io.IOException;

/**
 * Created by SYJ on 2017/3/21.
 */
@Service
public class ConsumerService implements AcknowledgingMessageListener<Integer, String> {

    private static final Logger logger = LoggerFactory.getLogger(ConsumerService.class);
    @Autowired
    private FriendRelationService friendRelationService;

    @Override
    public void onMessage(ConsumerRecord<Integer, String> record, Acknowledgment acknowledgment) {
        logger.info("Before receiving:" + record.toString());
        String value = record.value();
        MessageDto<FriendRelationDto> message = JSON.parseObject(value, new TypeReference<MessageDto<FriendRelationDto>>(){});
        try {
            friendRelationService.process(message.getData());
            logger.info("===========开始提交offset=============");
            acknowledgment.acknowledge();//提交offset
            logger.info("===========已经提交offset=============");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

下面的消费者实现的是BatchAcknowledgingMessageListener这个监听器，它的特点是一次可以处理一批消息，并且可以在处理完这一批消息之后提交offset，需要在消费者的配置文件中配置"max.poll.records"参数指定本批消息可以达到的最大值，并指定<property name="ackMode" value="MANUAL"/>：

import com.alibaba.fastjson.JSON;
import com.alibaba.fastjson.TypeReference;
import com.xxxxxx.consumer.dto.FriendRelationDto;
import com.xxxxxx.consumer.dto.MessageDto;
import com.xxxxxx.consumer.service.FriendRelationService;
import org.apache.kafka.clients.consumer.ConsumerRecord;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.kafka.listener.BatchAcknowledgingMessageListener;
import org.springframework.kafka.support.Acknowledgment;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.util.List;

/**
 * Created by SYJ on 2017/3/21.
 */
@Service
public class ConsumerService implements BatchAcknowledgingMessageListener<Integer, String> {

    private static final Logger logger = LoggerFactory.getLogger(ConsumerService.class);
    @Autowired
    private FriendRelationService friendRelationService;
    

    @Override
    public void onMessage(List<ConsumerRecord<Integer, String>> recordList, Acknowledgment acknowledgment) {
        logger.info("Before receiving:" + recordList.toString());
        logger.info("本次消息总数:" + recordList.size());
        for (ConsumerRecord<Integer, String> record : recordList) {
            String value = record.value();
            MessageDto<FriendRelationDto> message = JSON.parseObject(value, new TypeReference<MessageDto<FriendRelationDto>>() {
            });
            try {
                friendRelationService.process(message.getData());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        logger.info("===========开始提交offset=============");
        acknowledgment.acknowledge();//提交offset
        logger.info("===========已经提交offset=============");
    }
}

下面是spring-kafka消费端的配置文件示例：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
         http://www.springframework.org/schema/beans/spring-beans.xsd">
    
    <bean id="consumerProperties" class="java.util.HashMap">
        <constructor-arg>
            <map>
                <entry key="bootstrap.servers" value="${bootstrap.servers}"/>
                <!-- 指定消费组名 -->
                <entry key="group.id" value="friend-group"/>
                <entry key="enable.auto.commit" value="false"/>
                <entry key="auto.commit.interval.ms" value="1000"/>
                <entry key="session.timeout.ms" value="15000"/>
                <!-- 当使用批量处理消息的时候,每次onMessage方法获取到的消息总条数虽然是随机的,但是不会超过此最大值 -->
                <entry key="max.poll.records" value="50"/>
                <entry key="key.deserializer" value="org.apache.kafka.common.serialization.IntegerDeserializer"/>
                <!--<entry key="key.deserializer" value="org.apache.kafka.common.serialization.StringDeserializer"/>-->
                <entry key="value.deserializer" value="org.apache.kafka.common.serialization.StringDeserializer"/>
            </map>
        </constructor-arg>
    </bean>

    <bean id="consumerFactory" class="org.springframework.kafka.core.DefaultKafkaConsumerFactory">
        <constructor-arg>
            <ref bean="consumerProperties"/>
        </constructor-arg>
    </bean>

    <!-- 消费消息的服务类 -->
    <bean id="messageListernerConsumerService" class="com.xxxxxxx.consumer.ConsumerService"/>

    <!-- 消费者容器配置信息 -->
    <bean id="containerProperties" class="org.springframework.kafka.listener.config.ContainerProperties">
        <constructor-arg value="friend"/>
        <!--<constructor-arg>
            <list>
                <value>zptopic</value>
                <value>ssmk</value>
                <value>friend</value>
            </list>
        </constructor-arg>-->
        <property name="messageListener" ref="messageListernerConsumerService"/>

        <!-- 提交offset,批量提交 -->
        <property name="ackMode" value="MANUAL"/>
        <!-- 提交offset的方式,处理完一条消息就立即提交 -->
        <!--<property name="ackMode" value="MANUAL_IMMEDIATE"/>-->
    </bean>

    <!-- 单线程消息监听容器,每启动一个消费者客户端,只会开启一个线程来消费 -->
    <!--<bean id="messageListenerContainer" class="org.springframework.kafka.listener.KafkaMessageListenerContainer" init-method="doStart">
        <constructor-arg ref="consumerFactory"/>
        <constructor-arg ref="containerProperties"/>
    </bean>-->

    <!-- 多线程消息监听容器,每启动一个消费者客户端,可以开启多个线程,开启多少个线程自己可以通过concurrency来指定 -->
    <bean id="messageListenerContainer" class="org.springframework.kafka.listener.ConcurrentMessageListenerContainer" init-method="doStart">
        <constructor-arg ref="consumerFactory"/>
        <constructor-arg ref="containerProperties"/>
        <property name="concurrency" value="5"/>
    </bean>

</beans>