# RocketMQ源码解析:消息过滤是如何实现的?

在这里插入图片描述

# 三种消息过滤方式

RocketMQ的过滤方式主要分为如下2种,其中类模式过滤的方式会在RocketMQ 5.0.0版本中被移除,所以不进行详细分析

在这里插入图片描述

# 根据Tag过滤

public class TagFilterProducer {

    public static final String RPODUCER_GROUP_NAME = "tagFilterProducerGroup";
    public static final String TOPIC_NAME = "tagFilterTopic";

    public static void main(String[] args) throws Exception {
        DefaultMQProducer producer = new DefaultMQProducer(RPODUCER_GROUP_NAME);
        producer.setNamesrvAddr("myhost:9876");
        producer.setSendMsgTimeout(6000);
        producer.start();

        String[] tags = new String[] {"TagA", "TagB", "TagC"};

        for (int i = 0; i < 12; i++) {
            Message message = new Message(TOPIC_NAME, tags[i % tags.length], ("hello rocketmq " + i).getBytes(RemotingHelper.DEFAULT_CHARSET));
            SendResult sendResult = producer.send(message);
            System.out.println(sendResult);
        }

        producer.shutdown();
    }
}

Producer端总共发送了12条数据。TagA,TagB,TagC的数据各4条。

public class TagFilterConsumer {

    public static final String CONSUMER_GROUP_NAME = "tagFilterConsumerGroup";

    public static void main(String[] args) throws Exception {
        DefaultMQPushConsumer consumer = new DefaultMQPushConsumer(CONSUMER_GROUP_NAME);
        consumer.setNamesrvAddr("myhost:9876");
        consumer.subscribe(TagFilterProducer.TOPIC_NAME, "TagA || TagC");

        consumer.registerMessageListener(new MessageListenerConcurrently() {
            @Override
            public ConsumeConcurrentlyStatus consumeMessage(List<MessageExt> list, ConsumeConcurrentlyContext consumeConcurrentlyContext) {
                System.out.printf("%s receive new message %s", Thread.currentThread().getName(), list);
                System.out.println();
                return ConsumeConcurrentlyStatus.CONSUME_SUCCESS;
            }
        });

        consumer.start();
        System.out.println("Consumer Started");
    }
}

Consumer端订阅了TagA和TagC的数据,最终只接收到8条数据,TagA和TagC的数据各4条

# 根据SQL92语法过滤

在发送消息的时候,可以给消息设置很多扩展属性,SQL92语法过滤就是根据这些扩展属性来过滤消息的(其实tag也是扩展属性的一种)

rocketmq默认是不支持sql92语法过滤的,需要在broker.conf中加入如下配置

enablePropertyFilter = true
filterSupportRetry = true
public class SqlFilterProducer {

    public static final String RPODUCER_GROUP_NAME = "sqlFilterProducerGroup";
    public static final String TOPIC_NAME = "sqlFilterTopic";

    public static void main(String[] args) throws Exception {
        DefaultMQProducer producer = new DefaultMQProducer(RPODUCER_GROUP_NAME);
        producer.setNamesrvAddr("myhost:9876");
        producer.setSendMsgTimeout(6000);
        producer.start();

        String[] tags = new String[] {"TagA", "TagB", "TagC"};

        for (int i = 0; i < 12; i++) {
            Message message = new Message(TOPIC_NAME, tags[i % tags.length], ("hello rocketmq " + i).getBytes(RemotingHelper.DEFAULT_CHARSET));
            message.putUserProperty("a", String.valueOf(i));
            SendResult sendResult = producer.send(message);
            System.out.println(sendResult);
        }

        producer.shutdown();
    }
}
public class SqlFilterConsumer {

    public static final String CONSUMER_GROUP_NAME = "sqlFilterConsumerGroup";

    public static void main(String[] args) throws Exception {
        DefaultMQPushConsumer consumer = new DefaultMQPushConsumer(CONSUMER_GROUP_NAME);
        consumer.setNamesrvAddr("myhost:9876");
        consumer.subscribe(SqlFilterProducer.TOPIC_NAME,
                MessageSelector.bySql("(TAGS is not null and TAGS in ('TagA', 'TagB'))"
                + "and (a is not null and a between 0 and 3)"));

        consumer.registerMessageListener(new MessageListenerConcurrently() {
            @Override
            public ConsumeConcurrentlyStatus consumeMessage(List<MessageExt> list, ConsumeConcurrentlyContext consumeConcurrentlyContext) {
                System.out.printf("%s receive new message %s \n", Thread.currentThread().getName(), list);
                return ConsumeConcurrentlyStatus.CONSUME_SUCCESS;
            }
        });

        consumer.start();
        System.out.println("Consumer Started");
    }
}

生产者发送了12条数据,消费者消费了2条数据(tag为TagA或TagB,属性a的值在0到3之间)

# 源码解析

因为通过tag过滤的方式最常用,因此只分析tag过滤的实现过程。

如果让你实现通过tag过滤你会在Consumer端进行过滤还是在Broker端进行过滤?

可能大多数人都会选择在Broker端进行过滤,因为在Consumer端进行过滤,会有无用的消息被发送到Consumer端,造成带宽浪费

在这里插入图片描述

其实RocketMQ根据Tag过滤消息的方式需要Consumer端和Broker端一起来完成

  1. Broker端收到消息后,先根据ConsumerQueue中的tagCods(tag的hashcode)进行过滤,过滤完成后从CommitLog取出对应的消息值,然后返回给Consuemr

  2. Consumer收到消息后再根据tag的具体值进行过滤,然后再开始消费消息(因为有可能2个tag的内容不同,但是hashcode相同,所以还需要根据内容再过滤一次)

请添加图片描述

可能你会说那目前这种方式可能会有大量不匹配的消息发送到客户端!

首先tag的hashcode冲突的概率比较低。其次,你完全可以在设置tagName的时候避免和之前tagName的hashcode产生冲突

# Consumer端过滤

consumer.subscribe("TopicTest", "*");

当执行DefaultMQPushConsumerImpl#subscribe方法时,Consumer会将订阅的Topic和tag信息封装成SubscriptionData保存下来

在这里插入图片描述

当收到消息时会回调PullCallback的实现类,用来消费消息。当调用PullAPIWrapper#processPullResult方法时,会对收到的消息通过tag的具体值进行过滤

在这里插入图片描述 在这里插入图片描述

# Broker端过滤

当拉取消息的请求发送到Broker端时,会交给PullMessageProcessor来处理,PullMessageProcessor会调用DefaultMessageStore#getMessage根据topic和queueId找到具体的ConsumeQueue,然后获取到消息的如下三个属性信息

在这里插入图片描述

org.apache.rocketmq.store.DefaultMessageStore#getMessage

在这里插入图片描述

拉取请求中会传递过来要订阅的tag的hashcode值,如果消息tag的hashcode值在要订阅的hashcode值中,则将消息返回,否则不会返回

org.apache.rocketmq.broker.filter.ExpressionMessageFilter#isMatchedByConsumeQueue

在这里插入图片描述