如何将 protobuf-net 与通过 ASP.NET Web Reference 生成的类一起使用，同时避免代码重复？

Posted 2023-02-16

【中文标题】如何将 protobuf-net 与通过 ASP.NET Web Reference 生成的类一起使用，同时避免代码重复？

【英文标题】：How to use protobuf-net with classes generated through ASP.NET Web Reference while avoiding code duplication?

【发布时间】：2012-07-11 10:02:31

【问题描述】：

我有一个服务器-客户端应用程序，我可以在其中修改两个代码库。客户端通过众多的 Web 服务与服务器进行通信，我通过 Web 参考系统分享了一些在服务器端定义的类。在网络上，数据是使用 XML (SOAP) 发送的。另外，我使用XmlSerializer将一些数据保存在磁盘上。

由于性能问题不断上升，我想迁移到更复杂的序列化程序，并着眼于 Protocol Buffers 和 protobuf-net。我目前使用 protobuf-net v2 (r480, .NET 3.5)

我似乎遇到的问题是通过 Web 引用系统共享的类不保留自定义类/成员属性，如 ProtoContract 和 ProtoMember。 （但是序列化系统不会抛出通常的System.InvalidOperationException: Type is not expected, and no contract can be inferred，给我留下一个空流。是不是因为在客户端生成的类被标记为partial？）

示例，服务器端：

[ProtoContract]
public class CommentStruct

    [ProtoMember(1)] public int id;
    [ProtoMember(2)] public DateTime time;
    [ProtoMember(3)] public string comment;
    [ProtoMember(4)] public int session;

客户端（生成代码）：

/// <remarks/>
[System.CodeDom.Compiler.GeneratedCodeAttribute("wsdl", "2.0.50727.1432")]
[System.SerializableAttribute()]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://example.org")]
public partial class CommentStruct 
    private int idField;
    private System.DateTime timeField;
    private string commentField;
    private int sessionField;

    /// <remarks/>
    public int id 
        get 
            return this.idField;
        
        set 
            this.idField = value;
        
    
    [...]

我设法在客户端的一个额外类文件中使用ProtoPartialMember 解决了这个问题：

[ProtoContract,
ProtoPartialMember(1, "id"),
ProtoPartialMember(2, "time"),
ProtoPartialMember(3, "comment"),
ProtoPartialMember(4, "session")]
public partial class CommentStruct

这里的主要问题是：我可以用不同的方式来避免代码重复吗？ 另一个是：我会错过一些 protobuf-net 的好东西，比如继承支持吗？

我找到了一些关于 protobuf-net Visual Studio 插件的信息。但正如 Marc Gravell 将其描述为“事后的想法”，我不愿意使用它。此外，我的一些合作开发者正在使用不支持加载项的 VS Express 版本。

编辑： 我的主要重复问题是必须两次指定类成员和 protobuf-net 属性 - 在服务器端的类定义和客户端的部分类属性中。

【参考方案1】：

作为一个次要的术语，我会避免在这里使用“共享”这个词，因为“共享”通常意味着：作为一个库（可以工作）。

不抛出错误的原因与partial无关；只是 protobuf-net 很乐意使用其他库的属性......在合理范围内。例如，它将与 [XmlType] / [XmlElement(Order=n)] 和 [DataContract] / [DataMember(Order=n)] 一起使用。但是，这里从 WSDL 生成的代码不包含 Order=n，因此它不会将那些视为需要序列化的成员（它确实需要数字）。

[ProtoPartialMember(...)] 用法（正如您所提到的）是解决此问题的一种方法。它不会限制您使用其他 protobuf-net。 [ProtoInclude(...)] 仍然可以工作（因为你提到了继承）。事实上，protobuf-net 中的everything 也可以在运行时完全配置，零属性（通过RuntimeTypeMode）。重复：除了类名，我看不到任何重复。可以说，[ProtoInclude(...)] 是与[XmlInclude(...)] 重复的位，但并不多。

我很高兴我顺便使用了这个短语，但我不确定“事后诸葛亮”是真的我描述插件用法的主要方式。澄清一下：protobuf-net 主要是为了适应代码优先的常见 .NET 习惯用法（可能带有属性），而不是从工具生成。它仍然有效。

当然，如果可用的话，最简单的选择可能是简单地共享 .dll 或 .cs。这与 WCF / DataContractSerializer 一起工作毫不费力，但我不确定旧的“网络参考”网络服务是否非常喜欢这一点。当然，也没有插件支持将 protobuf-net 用作旧式“网络参考”（“asmx”）的一部分，因此您可能已经需要在那里更改一些内容......

【讨论】：

我的主要重复问题是必须两次指定类成员和 protobuf-net 属性 - 在服务器端的类定义和客户端的部分类属性中。直到现在我才发现这个“事后”引用的来源是三年前的：link。我很抱歉挖了这么久的线程。