基于Springboot的Kafka消费者动态操作
1. 问题
在基于Springboot开发Kafka相关业务时，遇到如下业务场景：
- 执行部分操作时，如停止服务替换镜像、执行特殊业务处理等，需要先停止Consumer接收Kafka消息，待处理完成后再开启Consumer接续接收Kafka消息
- 为并发消费Kafka消息，可通过配置
spring.kakfa.listener.concurency来设置Consumer的并发数；但spring.kakfa.listener.concurency是一个全局配置，当一个服务需要同时监听多个Topic，并且不同的Topic的Consumer需要设置不同的并发数时，这种方法就不适用
2. 解决思路
2.1 源码分析
在Springboot项目中，一般通过方法上的@KafkaListener注解来注册Consumer，在Springboot服务启动过程中，通过实现了Springboot的扩展点的KafkaListenerAnnotationBeanPostProcessor类，在postProcessAfterInitialization方法中识别含有@KafkaListener注解的方法，并注册至KafkaListenerEndpointRegistry中（详细的源码在此不展开描述，有兴趣的可以自行翻阅源码或查询资料）。因此，后续的操作也将围绕着Listener容器MessageListenerContainer和注册表KafkaListenerEndpointRegistry展开。
2.2 动态启停Consumer
Listener容器MessageListenerContainer接口扩展了SmartLifecycle接口，在Lifecycle接口的start()方法基础上，扩展了pause()方法和resume()方法。通过注释可以知道，这三个方法分别对应了Listener的启动、暂停和恢复。
在KafkaListenerEndpointRegistry类中，提供了根据ID获取MessageListenerContainer的方法。
因此，只要通过ID在KafkaListenerEndpointRegistry中获取了Listener容器MessageListenerContainer后，即可进行对应的开始、暂停和恢复Consumer的操作。
2.3 动态修改参数
要想为不同的Listener配置不同的concurrency参数，首先得知道concurrency参数是在哪里被设置至Listener中的。通过Debug分析源码可知，在实现了MessageListenerContainer接口的ConcurrentMessageListenerContainer类中有一个setConcurrency(int)方法，可以设置容器的并发数。同时，Listener的注册表KafkaListenerEndpointRegistry类同样实现了SmartLifecycle接口，并在start()方法中实际启动Listener容器，因此想要动态修改参数，必须在容器启动前，即KafkaListenerEndpointRegistry执行start()方法前进行处理。
3. 动态启停Consumer
首先，定义一个公共的抽象类AbstractScheduledConsumer。
public abstract class AbstractScheduledConsumer<T> {
@Resource
private KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry;
public abstract void onMessage(T data);
protected abstract String getId();
protected MessageListenerContainer getListenerContainer() {
String containerId = this.getId();
MessageListenerContainer container = this.kafkaListenerEndpointRegistry.getListenerContainer(containerId);
Assert.notNull(container, String.format("MessageListenerContainer [%s] 获取失败", containerId));
return container;
}
/**
* 启动
*/
public void start() {
MessageListenerContainer container = getListenerContainer();
if (!container.isRunning()) {
container.start();
} else {
container.resume();
}
}
/**
* 暂停
*/
public void pause() {
getListenerContainer().pause();
}
/**
* 恢复
*/
public void resume() {
getListenerContainer().resume();
}
}
业务处理的Consumer类只需要继承AbstractScheduledConsumer类即可实现Consumer的动态启停。变量ID即为Listener的ID，需要为每个Consumer定义不同的ID。
@Component
public class BusinessConsumer extends AbstractScheduledConsumer<ConsumerRecord<String, byte[]>> {
/**
* 自定义ID
*/
private static final String ID = "business-consumer-id";
@Override
@KafkaListener(id = ID, topics = "")
public void onMessage(ConsumerRecord<String, byte[]> data) {
// 业务处理
}
@Override
protected String getId() {
return ID;
}
}
至此，BusinessConsumer类已具备动态启停的Kafka Consumer的功能，只需要在Service和Controller增加代码即可通过接口实时启动、暂停和恢复Consumer。
4. 动态修改Consumer参数
首先，定义一个配置项，用于配置需要修改的Consumer参数，此处的ID和上文的Listener的ID一致。
public class CustomizedKafkaConfig {
/**
* 是否启用Consumer拦截器
*/
private boolean consumerInterceptorAutoStart = true;
/**
* 全局Consumer配置
*/
private ConsumerInfo globalConsumerInfo;
/**
* 独立Consumer配置
*/
private Map<String, ConsumerInfo> customizedConsumerInfos = new HashMap<>();
// 省略 get/set 方法
/**
* 根据ID获取配置
*/
public ConsumerInfo getConsumerInfo(String id) {
return customizedConsumerInfos.get(id);
}
public static class ConsumerInfo {
private Boolean autoStart;
private Integer concurrency;
public Boolean getAutoStart() {
return autoStart;
}
public void setAutoStart(Boolean autoStart) {
this.autoStart = autoStart;
}
public Integer getConcurrency() {
return concurrency;
}
public void setConcurrency(Integer concurrency) {
this.concurrency = concurrency;
}
}
}
接着定义Consumer拦截器，同样实现SmartLifecycle接口，通过getPhase()返回值保证优先于KafkaListenerEndpointRegistry执行。
@Slf4j
public class KafkaListenerContainerInterceptor implements SmartLifecycle {
private final CustomizedKafkaConfig config;
private final KafkaListenerEndpointRegistry registry;
private volatile boolean running = false;
public KafkaListenerContainerInterceptor(CustomizedKafkaConfig customizedKafkaConfig, KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry) {
this.config = customizedKafkaConfig;
this.registry = kafkaListenerEndpointRegistry;
}
@Override
public void start() {
Collection<MessageListenerContainer> listenerContainers = registry.getAllListenerContainers();
ConsumerInfo globalConsumerInfo = config.getGlobalConsumerInfo();
// 存在全局设置
if (globalConsumerInfo != null) {
log.info("已设置全局ConsumerInfo [autoStartup = {}, concurrency = {}]", globalConsumerInfo.getAutoStart(), globalConsumerInfo.getConcurrency());
listenerContainers.forEach(c -> resetMessageListenerContainer(c, globalConsumerInfo));
}
// 自定义消费者设置
for (MessageListenerContainer container : listenerContainers) {
String id = container.getListenerId();
ConsumerInfo consumerInfo;
// 未自定义消费者设置，跳过拦截
if ((consumerInfo = config.getConsumerInfo(id)) == null) {
continue;
}
// 拦截设置
resetMessageListenerContainer(container, consumerInfo);
}
}
@Override
public void stop() {
this.running = false;
}
@Override
public boolean isRunning() {
return running;
}
@Override
public boolean isAutoStartup() {
return config.isConsumerInterceptorAutoStart();
}
@Override
public int getPhase() {
return 0;
}
private void resetMessageListenerContainer(MessageListenerContainer container, ConsumerInfo consumerInfo) {
String id = container.getListenerId();
// 设置AutoStartup属性
Optional.ofNullable(consumerInfo.getAutoStart()).ifPresent(v -> {
container.setAutoStartup(v);
log.info("MessageListenerContainer [{}] [autoStartup] 属性设置为 [{}]", id, v);
});
// 设置concurrency属性
if (container instanceof ConcurrentMessageListenerContainer<?,?>) {
Optional.ofNullable(consumerInfo.getConcurrency()).ifPresent(v -> {
((ConcurrentMessageListenerContainer<?,?>) container).setConcurrency(v);
log.info("MessageListenerContainer [{}] [concurrency] 属性设置为 [{}]", id, v);
});
} else {
log.warn("MessageListenerContainer [{}] 不是 [ConcurrentMessageListenerContainer]，无法修改 [concurrency] 属性", id);
}
}
}
最后定义Configuration类，用户注册KafkaListenerContainerInterceptor类。
@Configuration
public class CustomizedKafkaConfiguration {
@Resource
private CustomizedKafkaConfig customizedKafkaConfig;
@Resource
private KafkaListenerEndpointRegistry kafkaListenerEndpointRegistry;
@Bean
@ConditionalOnMissingBean
public KafkaListenerContainerInterceptor kafkaListenerContainerInterceptor() {
return new KafkaListenerContainerInterceptor(customizedKafkaConfig, kafkaListenerEndpointRegistry);
}
}