Protobuf的MessageDifferencer是否支持对map类型字段的比较？

1. 底层实现与默认比较规则 #

protobuf中的map字段在底层会被编译为特殊的repeated Entry结构，每个Entry包含固定命名的key和value两个子字段，官方文档明确说明：

线格式序列化顺序以及map迭代顺序都是未定义的，你不能依赖map元素会按特定顺序存储或遍历。

MessageDifferencer对map字段的比较逻辑和protobuf版本直接相关：

• 3.10.0及以上版本：会自动识别proto定义中标记为map的字段，默认按照key匹配对应Entry，忽略底层repeated结构的存储/遍历顺序，只要同key对应的value相等，就会判定map字段相等。
• 3.10.0之前的版本：没有对map字段做特殊适配，会将底层的repeated Entry当成普通重复字段，按索引位置逐个对比，只要存储顺序不一致，哪怕所有key-value对完全相同也会判定为不相等，你遇到的同key字段无法匹配的问题就是这个原因导致的。

2. Compare与Equals方法的适配性 #

MessageDifferencer::Compare和MessageDifferencer::Equals使用完全一致的字段比较规则，唯一区别是Equals仅返回是否相等的布尔值，Compare会输出详细的差异内容，两者对map无序特性的适配性完全相同。

3. 问题解决方法 #

方案1：升级protobuf库（优先推荐） #

将项目依赖的protobuf库升级到3.10.0及以上版本，不需要额外修改代码，默认就支持map字段的无序比较，自动按key匹配对应元素。

方案2：手动配置比较规则（无法升级版本时使用） #

如果受项目限制无法升级库，可以通过MessageDifferencer的配置接口手动指定map字段的匹配规则，示例代码如下：

#include <google/protobuf/util/message_differencer.h>
using namespace google::protobuf::util;

// 初始化比较器
MessageDifferencer differ;
// 针对你定义的foo消息的bar map字段，指定用Entry的key子字段作为匹配依据
differ.AddRepeatedFieldKey(
    foo::descriptor()->FindFieldByName("bar"),
    google::protobuf::FieldDescriptor::TYPE_STRING,
    "key"
);

// 之后调用Equals或者Compare都可以正确匹配同key元素
bool is_equal = differ.Equals(msg1, msg2);

内容的提问来源于stack exchange，提问作者DonBaka