c# - 如何序列化可能只有唯一实例的类

Question

我有一个类只能有如下所示的唯一实例。这使得引用相等性足以等同于对象。

虽然序列化很简单，但反序列化有点棘手，因为不能像我在下面所做的那样分配给 this。如果仍然只想维护类的唯一实例，我该如何反序列化对象？

public sealed class MyClass :
    ISerializable,
    IXmlSerializable
{
    private static readonly Dictionary<string, MyClass> Cache;

    static MyClass() { /* build cache, use private constructor */ }

    private MyClass(string name)
    {
        this.Name = name;
    }

    public string Name { get; }

    public static MyClass Parse(string from)
        => Cache[from];

    public void GetObjectData(SerializationInfo info, StreamingContext context)
        => throw new NotImplementedException();

    public XmlSchema GetSchema() => null;

    public void ReadXml(XmlReader reader)
    {
        reader.ReadStartElement();
        this = Parse(reader.ReadContentAsString());
        reader.ReadEndElement();
    }

    public MyClass(SerializationInfo info, StreamingContext context) 
        => this = Parse(info.GetString(nameof(this.Name)));

    public void WriteXml(XmlWriter writer)
        => throw new NotImplementedException();
}

Answer 1

一般来说，处理这个问题的方法是，在对象图序列化过程中，使用serialization surrogate mechanism替换单例。 ，其中单例被替换为 Data Transfer Object (DTO)它只包含单例的标识符。然后，稍后，随着图形被反序列化，DTO 最初被反序列化，然后通过查找替换为相应的单例。

例如，如果您的 MyClass 如下所示:

public sealed class MyClass
{
    private static readonly Dictionary<string, MyClass> Cache;

    static MyClass()
    {
        Cache = new Dictionary<string, MyClass>()
        {
            { "one", new MyClass("one") { OtherRuntimeData = "other runtime data 1" } },
            { "two", new MyClass("two") { OtherRuntimeData = "other runtime data 2" } },
        };
    }

    // XmlSerializer required parameterless constructor.
    private MyClass() => throw new NotImplementedException();

    private MyClass(string name) => this.Name = name;

    public string Name { get; }

    public string OtherRuntimeData { get; set; }

    public static MyClass Parse(string from) => Cache[from];

    public static IEnumerable<MyClass> Instances => Cache.Values;
}

那么只包含 Name 的 DTO 看起来像:

public sealed class MyClassDTO
{
    public string Name { get; set; }

    public static implicit operator MyClassDTO(MyClass obj) => obj == null ? null : new MyClassDTO { Name = obj.Name };

    public static implicit operator MyClass(MyClassDTO dto) => dto == null ? null : MyClass.Parse(dto.Name);
}

注意 implicit operator在 DTO 和原始文件之间进行转换？这将使将代理项注入(inject)序列化图中变得更加容易。

不幸的是，没有标准的方法可以在所有常用的 .Net 序列化程序中实现序列化代理 DTO 的注入(inject)。每个都有自己独立的机制(或根本没有机制)。分解它们:

• 数据协定序列化程序支持通过 IDataContractSurrogate 替换为代理项界面，如图所示在 this answer至 DataContractJsonSerializer - share an object instance for the whole graph?或 this answer至 How to serialize / deserialize immutable list type in c# .

• 数据协定序列化程序还支持 IObjectReference界面如图this answer至 C# DataContract Serialization, how to deserialize to already existing instance .

• 但不幸的是，XmlSerializer 没有方便地支持通过代理机制注入(inject) DTO。最接近的是来自 this answer 的技巧至 Most elegant XML serialization of Color structure ，这涉及设置 XmlElementAttribute.Type为引用您的单例类型的每个属性的 DTO 类型，例如如下:

  public class RootObject
  {
      // Technique taken from https://stackoverflow.com/questions/3280362/most-elegant-xml-serialization-of-color-structure
      [XmlElement(Type=typeof(MyClassDTO))]
      public MyClass MyClass { get; set; }
  } 
  

  示例 .Net fiddle 在此处展示了这一点:https://dotnetfiddle.net/R07NiW .请注意，这仅适用于我们之前定义的单例及其 DTO 之间的隐式运算符。

• 当通过 Json.NET 进行序列化时，单例可以用 custom JsonConverter 中的 DTO 替换。 .

• protobuf.net支持通过 RuntimeTypeModel.Default.Add(typeof(OriginalType), false) .SetSurrogate(typeof(SurrogateType)) 替换代理，如 Can I serialize arbitrary types with protobuf-net? 所示, No serializer defined for type: System.Windows.Media.Media3D.Point3D ，或文章 Protobuf-net: the unofficial manual .

• 最后，如果您正在使用 BinaryFormatter(我不推荐使用 here 原因)，请使用 SurrogateSelector Customized Serialization 中所示，支持类似于数据契约(Contract)代理替换机制的机制。 .

  SerializationInfo.SetType() 结合 IObjectReference 也受支持，如 this documentation example 所示。 .