协议缓冲区是否支持轻量级参考序列化

时间:2013-09-12 14:22:01

标签: c# .net serialization protocol-buffers

假设一个这样的类:

class Person {
  public string Name;
  public Person Parent;
}

现在您创建两个对象:

...
Person mike = new Person("Mike");
Person jack = new Person("Jack");
jack.Parent = mike;
List<Person> family = new List<Person>();
people.Add(mike);
people.Add(jack);
...

字符串“Mike”会序列化一次(维护)对象mike的唯一引用然后解析它,还是会被序列化两次?

1 个答案:

答案 0 :(得分:3)

这里的答案是“它取决于”。 protobuf规范不包含任何对象标识符/重用,因此通常(默认情况下)这将是树序列化,并且数据将被复制。

我们可以通过使用带有所有默认行为的protobuf-net来检查这个

using ProtoBuf;
using System;
using System.Collections.Generic;
using System.Linq;

class Program
{
    static void Main()
    {
        Person mike = new Person { Name = "Mike" };
        Person jack = new Person { Name = "Jack" };
        jack.Parent = mike;
        List<Person> people = new List<Person>();
        people.Add(mike);
        people.Add(jack);

        var cloneOfEverything = Serializer.DeepClone(people);

        var newMike = cloneOfEverything.Single(x => x.Name == "Mike");
        var newJack = cloneOfEverything.Single(x => x.Name == "Jack");
        Console.WriteLine(jack.Parent.Name); // writes Miks as expected

        bool areSamePersonObject = ReferenceEquals(newMike, newJack.Parent);
        // False ^^^

        bool areSameStringInstance = ReferenceEquals(
            newMike.Name, newJack.Parent.Name);
        // True ^^^
    }
}
[ProtoContract]
class Person
{
    [ProtoMember(1)]
    public string Name;
    [ProtoMember(2)]
    public Person Parent;
}

观察:

  • 杰克的父母被正确地称为迈克
  • 但它是一个看起来相同的不同对象实例
  • string是相同的实例 - 作为实现细节,protobuf-net包含在数据中发现相同UTF-8块的代码,并重新使用相同的string实例来避免分配 - 但数据在二进制文件中包含两次
  • 获取信息,上面的树需要24个字节

我们也可以通过调查这里发生的事情来看到这一点:

Person mike = new Person { Name = "Mike" };
mike.Parent = mike;
var clone = Serializer.DeepClone(mike);

因为它是以树形式编写的,所以它出错:

  

检测到可能的递归(偏移:1级):人

然而!作为特定于库的实现细节,protobuf-net包含许多可以转动的旋钮和拨号盘。其中之一涉及对象身份。我们可以切换Person以参考标识:

[ProtoContract(AsReferenceDefault=true)]
class Person {...}

更改二进制文件中的数据 (以包含其他标记),因此 - 现在相同的行工作:

Person mike = new Person { Name = "Mike" };
mike.Parent = mike;
var clone = Serializer.DeepClone(mike);
bool areSamePersonObject = ReferenceEquals(clone, clone.Parent);
// ^^^ true

请注意,这会使用特定于实现的详细信息,并且可能会混淆其他实现。

AsReferenceDefault此处声明Person只要看到它就应被视为参考;对于更精细的控制,[ProtoMember]还包括可以单独使用的AsReference对象。但是,快速检查似乎表明 当前正在与List<Person>正常工作 - 我需要对此进行调查。可能有一个很好的理由,但我现在想不到一个,我怀疑这是一个错误。

AsReference也可以包含在string成员中,以避免重复写入相同的字符串 - 尽管请注意,在这种情况下,编写"Mike"两次可能更便宜!当相同的string重复批次时,此选项非常有用。尽管名称如此,但在使用string时,AsReference被解释为“字符串相等”,而不是“引用相等”。