如何使用FieldMaskUtil合并Protobuf对象并过滤零值字段？

要实现NewMerge(src, dest)方法，合并时跳过src中所有值为零值的字段（如int类型0、字符串空值等），同时避免重复字段拼接，可以通过Protobuf的反射API结合字段值判断来实现，具体步骤和代码如下：

核心思路 #

1. 基于目标对象创建Builder，用于修改合并后的内容
2. 遍历源对象的所有字段，逐一检查字段值是否为对应类型的零值
3. 仅将源对象中非零值的字段复制到目标Builder中；对于重复字段，先清空目标的对应字段，再添加源对象中非零值的元素（实现替换而非拼接）
4. 最终构建出合并后的Protobuf对象

工具类实现代码 #

import com.google.protobuf.Descriptors;
import com.google.protobuf.Message;
import com.google.protobuf.Message.Builder;

public class ProtobufMergeUtil {
    public static <T extends Message> T newMerge(T src, T dest) {
        Builder destBuilder = dest.toBuilder();
        Descriptors.Descriptor descriptor = src.getDescriptorForType();
        
        for (Descriptors.FieldDescriptor field : descriptor.getFields()) {
            if (!field.isRepeated()) {
                // 处理非重复字段：仅复制非零值的已设置字段
                if (src.hasField(field)) {
                    Object value = src.getField(field);
                    if (!isZeroValue(value, field)) {
                        destBuilder.setField(field, value);
                    }
                }
            } else {
                // 处理重复字段：替换目标字段内容，跳过源中的零值元素
                int srcFieldCount = src.getRepeatedFieldCount(field);
                if (srcFieldCount > 0) {
                    destBuilder.clearField(field);
                    for (int i = 0; i < srcFieldCount; i++) {
                        Object element = src.getRepeatedField(field, i);
                        if (!isZeroValue(element, field)) {
                            destBuilder.addRepeatedField(field, element);
                        }
                    }
                }
            }
        }
        
        return (T) destBuilder.build();
    }
    
    // 判断字段值是否为对应类型的零值
    private static boolean isZeroValue(Object value, Descriptors.FieldDescriptor field) {
        switch (field.getJavaType()) {
            case INT:
                return (Integer) value == 0;
            case LONG:
                return (Long) value == 0L;
            case FLOAT:
                return Float.compare((Float) value, 0.0f) == 0;
            case DOUBLE:
                return Double.compare((Double) value, 0.0d) == 0;
            case BOOLEAN:
                return !(Boolean) value;
            case STRING:
                return ((String) value).isEmpty();
            case BYTE_STRING:
                return ((com.google.protobuf.ByteString) value).isEmpty();
            case ENUM:
                return ((com.google.protobuf.EnumValueDescriptor) value).getNumber() == 0;
            case MESSAGE:
                // 空消息（所有字段均为默认值）视为零值
                return ((Message) value).getAllFields().isEmpty();
            default:
                return false;
        }
    }
}

使用示例 #

假设我们有如下Protobuf定义：

syntax = "proto3";

message User {
    int32 id = 1;
    string name = 2;
    repeated int32 scores = 3;
    bool active = 4;
}

调用合并方法的示例代码：

public class MergeDemo {
    public static void main(String[] args) {
        // 源对象：包含零值字段和非零值字段
        User src = User.newBuilder()
                .setId(0)          // int零值，不会被复制
                .setName("Alice")  // 非空字符串，会覆盖目标值
                .addScores(0)      // 零值元素，会被跳过
                .addScores(90)     // 非零值元素，会被添加
                .setActive(false)  // 布尔零值，不会被复制
                .build();

        // 目标对象：初始值
        User dest = User.newBuilder()
                .setId(100)
                .setName("Bob")
                .addScores(80)
                .setActive(true)
                .build();

        // 执行合并
        User mergedUser = ProtobufMergeUtil.newMerge(src, dest);
        
        // 输出结果：id=100, name=Alice, scores=[90], active=true
        System.out.println(mergedUser);
    }
}

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