Kafka封装之—方法参数解析器，用起来真香！

2023-02-28

方法参数 body

大家好，我是Jensen。一个想和大家一起打怪升级的程序员朋友。咱们在写Kafka消费者的时候，有没有发现一个很麻烦的事：消费消息前每次都要手动解析Kafka消息，转换成自己想要的类型，再进行业务操作，比如：复制/***订单支付成功通知*@Author公众号：架构师修行录*/@KafkaListen

大家好，我是Jensen。一个想和大家一起打怪升级的程序员朋友。

咱们在写Kafka消费者的时候，有没有发现一个很麻烦的事：消费消息前每次都要手动解析Kafka消息，转换成自己想要的类型，再进行业务操作，比如：

/**
 * 订单支付成功通知
 * @Author 公众号：架构师修行录
 */
@KafkaListener(topics = "oms.orderPaySuccess", groupId = "fms")
public void orderPaySuccess(ConsumerRecord<String, String> consumerRecord) {
    // 解析Kafka消息
  OrderPaySuccessEvent event = JSON.parseObject(consumerRecord.value(), OrderPaySuccessEvent.class);
    // TODO 完成解析成功后的业务操作
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.

对代码有洁癖的同志就比较难受了，每次解析的操作都差不多，但这又不是业务代码……于是你就想：有没有一个办法让系统能够自动解析成自己想要的参数对象呢？

不过也发现了一些难以解决的问题，比如：共用了一个groupId，使用Java线程池来管理，这样工程会存在性能瓶颈。

专业的事还是交给专业的“人”来做吧，用Kafka组件本身来管理不同分组消费会更靠谱。

Spring官方也发现这个问题，并且对此提出了解决方案——spring-messaging包下的HandlerMethodArgumentResolver接口。

我们从官方文档中看到，Spring-kafka在2.4.2版本支持了对kafka消息进行方法参数级别转换。

其实，spring-web包下也有这个同名接口，用于自动解析Controller方法上的参数，这块网上资料比较多我就不详细展开了，而spring-messaging包下面这个接口的非官方资料比较少，我这里给大家总结一下用法。

HandlerMethodArgumentResolver方法参数处理器接口很简单，只有两个方法：

public interface HandlerMethodArgumentResolver {
    boolean supportsParameter(MethodParameter var1);

    @Nullable
    Object resolveArgument(MethodParameter var1, Message<?> var2) throws Exception;
}1.
2.
3.
4.
5.
6.

supportsParameter方法返回是否支持参数自动解析，resolveArgument方法就是具体的解析逻辑，把MQ传递参数转换为具体类型参数。

我们来看一下实际案例。

首先实现HandlerMethodArgumentResolver接口，定义为一个Spring的Component：

@Component
public class KafkaListenerMethodArgumentResolver implements HandlerMethodArgumentResolver {

    @Override
    public boolean supportsParameter(@NonNull MethodParameter parameter) {
        // 默认以com.xxx开头的类，这样可以不用在在参数前加@Payload注解
        return parameter.getParameterType().getName().startsWith("com.xxx") || parameter.hasParameterAnnotation(Payload.class);
    }

    @Override
    public Object resolveArgument(@NonNull MethodParameter parameter, @NonNull Message<?> message) {
        Class<?> parameterType = parameter.getParameterType();
        String messageContent = (String) message.getPayload();

        Object body;
        try {
            // 这里定义自己的解析方法
            body = JsonUtils.fromJson(messageContent, parameterType);
            Objects.requireNonNull(body);
        } catch (Throwable cause) {
            throw new KafkaException("kafka 消息解析失败: 非法JSON字符串", cause);
        }
                // 可选，定义解析后的参数校验逻辑
        validate(parameter, body);
        return body;
    }

    private void validate(MethodParameter parameter, Object target) {
        for (Annotation ann : parameter.getParameterAnnotations()) {
            Validated validatedAnn = AnnotationUtils.getAnnotation(ann, Validated.class);
            if (Objects.nonNull(validatedAnn) || ann.annotationType().getSimpleName().startsWith("Valid")) {
                ValidationUtils.valid(target);
            }
        }
    }
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
17.
18.
19.
20.
21.
22.
23.
24.
25.
26.
27.
28.
29.
30.
31.
32.
33.
34.
35.
36.

到这里，一个类就把参数自动解析搞定了，接下来咱们看看怎么用。

/**
 * 订单支付成功通知
 * @Author 公众号：架构师修行录
 */
@KafkaListener(topics = "oms.orderPaySuccess", groupId = "fms")
public void orderPaySuccess(@Payload OrderPaySuccessEvent orderPaySuccessEvent) {
    // 已经自动解析Kafka消息为orderPaySuccessEvent参数
  
    // TODO 完成解析成功后的业务操作
}1.
2.
3.
4.
5.
6.
7.
8.
9.
10.