两端未遵循Protocol Buffer契约时的处理方案咨询

当然可行，Protobuf本身提供了相关机制，再配合额外的校验逻辑，就能有效避免契约不遵循带来的意外问题。针对你遇到的具体场景——客户端发送的WelcomeMessage和服务器预期的WelcomeClient字段不匹配，导致MagicNumber被设为默认值0的问题，给你几个实用的解决方案：

1. 用必填字段标记强制校验 #

protobuf-net支持给字段标记IsRequired = true，把必须存在的字段设为必填，反序列化时如果缺失该字段，会直接抛出ProtoException，这样你就能立刻捕获契约不匹配的情况。

修改服务器端的WelcomeClient类：

[ProtoContract]
public class WelcomeClient
{
    [ProtoMember(1, IsRequired = true)] // 标记为必填字段
    public int MagicNumber {get;set;}
    [ProtoMember(2)]
    public string WelcomeMessage {get;set;}
}

然后修改你的反序列化代码，添加异常捕获：

public class ProtocolBufferUtilities
{
    public static T Deserialize<T>(byte[] data)
    {
        using var stream = new MemoryStream(data);
        try
        {
            return Serializer.Deserialize<T>(stream);
        }
        catch (ProtoException ex)
        {
            // 处理契约不匹配的情况，比如断开连接、记录日志等
            throw new InvalidDataException("消息不符合契约要求", ex);
        }
    }
}

2. 给消息加类型标识，从根源避免错反序列化 #

在TCP传输的每个Protobuf消息前，先加一个固定长度的消息类型ID（比如4字节整数），两端提前约定每个ID对应的Protobuf类。服务器接收时先读ID，再用对应类反序列化，就能避免把A类型消息反序列化成B类型的情况。

服务器端反序列化逻辑修改： #

public class ProtocolBufferUtilities
{
    // 提前约定消息类型ID：1=WelcomeClient，2=WelcomeMessage
    public static object DeserializeWithType(byte[] data)
    {
        using var stream = new MemoryStream(data);
        var reader = new BinaryReader(stream);
        int messageTypeId = reader.ReadInt32();
        
        switch(messageTypeId)
        {
            case 1:
                return Serializer.Deserialize<WelcomeClient>(stream);
            case 2:
                return Serializer.Deserialize<WelcomeMessage>(stream);
            default:
                throw new InvalidOperationException("收到未知类型的消息");
        }
    }
}

客户端发送时也要先写类型ID： #

public static byte[] SerializeWithType(object message, int messageTypeId)
{
    using var stream = new MemoryStream();
    var writer = new BinaryWriter(stream);
    writer.Write(messageTypeId); // 先写类型ID
    Serializer.Serialize(stream, message); // 再写Protobuf序列化内容
    return stream.ToArray();
}

3. 自定义反序列化后的校验逻辑 #

如果不想用必填字段，或者需要更灵活的校验规则，可以在反序列化完成后，手动检查关键字段是否符合预期。

步骤： #

1. 定义一个校验接口：

public interface IValidatableMessage
{
    bool Validate();
}

2. 让服务器端的消息类实现这个接口：

[ProtoContract]
public class WelcomeClient : IValidatableMessage
{
    [ProtoMember(1)]
    public int MagicNumber {get;set;}
    [ProtoMember(2)]
    public string WelcomeMessage {get;set;}

    public bool Validate()
    {
        // 这里可以自定义校验规则，比如约定MagicNumber不能为0
        return MagicNumber != 0;
    }
}

3. 修改反序列化代码，加入校验：

public class ProtocolBufferUtilities
{
    public static T Deserialize<T>(byte[] data) where T : IValidatableMessage
    {
        using var stream = new MemoryStream(data);
        var result = Serializer.Deserialize<T>(stream);
        
        if (!result.Validate())
        {
            throw new InvalidDataException("消息不符合契约校验规则");
        }
        
        return result;
    }
}

额外建议 #

• 两端共用同一个.proto契约文件，再各自生成代码，不要手动编写C#类，这样能从根源保证契约完全一致。protobuf-net支持从.proto生成C#代码，也可以用官方Protobuf工具生成。
• 出现契约不匹配时，记录详细日志（比如收到的字节内容、反序列化类型等），方便后续排查问题。

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