protobuf-net: сериализация пустого списка - PullRequest
Новая
       14

protobuf-net: сериализация пустого списка

28 голосов
/ 04 марта 2010

у нас есть некоторые проблемы с сериализацией пустого списка. здесь некоторый код в .NET с использованием CF 2.0 

//Generating the protobuf-msg
ProtoBufMessage msg = new ProtoBufMessage();
msg.list = new List<AnotherProtobufMessage>();
// Serializing and sending throw HTTP-POST
MemoryStream stream = new MemoryStream();
Serializer.Serialize(stream, msg);
byte[] bytes = stream.ToArray();
HttpWebRequest request = createRequest();
request.ContentLength = bytes.Length ;

using (Stream httpStream = request.GetRequestStream())
{              
      httpStream.Write(bytes, 0, bytes.Length);
}

мы получили исключение при попытке записи в поток (bytes.length вне диапазона). Но тип с пустым списком не должен быть 0 байтов, верно (type-information?)?

Нам нужен этот тип отправки, потому что в Ответе находятся сообщения от Сервера для нашего клиента.

Ответы [ 3 ]

32 голосов
/ 04 марта 2010

Проводной формат (определенный Google - не в моем контроле!) Отправляет данные только для пунктов .Он не делает различий между пустым списком и нулевым списком.Так что, если нет данных для отправки - да, длина равна 0 (это очень скромный формат ;-p).

Буферы протокола не включают в себя метаданные любого типа на проводе.

Еще одна распространенная ошибка: вы можете предположить, что ваше свойство списка автоматически создается как пустое, но этого не произойдет (если ваш код не сделает этого, возможно, в инициализаторе поля или конструкторе).

Вот работоспособныйhack: 

[ProtoContract]
class SomeType {

    [ProtoMember(1)]
    public List<SomeOtherType> Items {get;set;}

    [DefaultValue(false), ProtoMember(2)]
    private bool IsEmptyList {
        get { return Items != null && Items.Count == 0; }
        set { if(value) {Items = new List<SomeOtherType>();}}
    }
}

Хаки может быть, но это должно сработать.Вы также можете потерять Items «сет», если хотите, и просто сбросить bool: 

    [ProtoMember(1)]
    public List<SomeOtherType> Items {get {return items;}}
    private readonly List<SomeOtherType> items = new List<SomeOtherType>();

    [DefaultValue(false), ProtoMember(2)]
    private bool IsEmptyList {
        get { return items.Count == 0; }
        set { }
    }
1 голос
/ 09 июля 2015

Как сказал @Marc, проводной формат отправляет данные только для элементов, поэтому, чтобы узнать, был ли список пустым или нулевым, необходимо добавить этот бит информации в поток.
Добавить дополнительное свойство, чтобы указать, была ли исходная коллекция пустой или нет, легко, но если вы не хотите изменять определение исходного типа, у вас есть еще две опции:

Сериализация с использованием суррогата

Суррогатный тип будет иметь дополнительное свойство (при этом исходный тип не будет затронут) и будет восстанавливать исходное состояние списка: пустое, с элементами или пустым. 

    [TestMethod]
    public void SerializeEmptyCollectionUsingSurrogate_RemainEmpty()
    {
        var instance = new SomeType { Items = new List<int>() };

        // set the surrogate
        RuntimeTypeModel.Default.Add(typeof(SomeType), true).SetSurrogate(typeof(SomeTypeSurrogate));

        // serialize-deserialize using cloning
        var clone = Serializer.DeepClone(instance);

        // clone is not null and empty
        Assert.IsNotNull(clone.Items);
        Assert.AreEqual(0, clone.Items.Count);
    }

    [ProtoContract]
    public class SomeType
    {
        [ProtoMember(1)]
        public List<int> Items { get; set; }
    }

    [ProtoContract]
    public class SomeTypeSurrogate
    {
        [ProtoMember(1)]
        public List<int> Items { get; set; }

        [ProtoMember(2)]
        public bool ItemsIsEmpty { get; set; }

        public static implicit operator SomeTypeSurrogate(SomeType value)
        {
            return value != null
                ? new SomeTypeSurrogate { Items = value.Items, ItemsIsEmpty = value.Items != null && value.Items.Count == 0 }
                : null;
        }

        public static implicit operator SomeType(SomeTypeSurrogate value)
        {
            return value != null
                ? new SomeType { Items = value.ItemsIsEmpty ? new List<int>() : value.Items }
                : null;
        }
    }


Сделайте ваши типы расширяемыми

protobuf-net предлагает интерфейс IExtensible, который позволяет расширять типы, чтобы поля можно было добавлять в сообщение без каких-либо нарушений (подробнее здесь ). Чтобы использовать расширение protobuf-net, вы можете унаследовать класс Extensible или реализовать интерфейс IExtensible, чтобы избежать ограничения наследования.
Теперь, когда ваш тип является «расширяемым», вы определяете методы [OnSerializing] и [OnDeserialized], чтобы добавить новые индикаторы, которые будут сериализованы в поток и десериализованы из него при реконструкции объекта с его исходным состоянием.
Плюсы в том, что вам не нужно определять новые свойства или новые типы как суррогаты, минусы в том, что IExtensible не поддерживается, если у вашего типа есть подтипы, определенные в вашей модели типов. 

    [TestMethod]
    public void SerializeEmptyCollectionInExtensibleType_RemainEmpty()
    {
        var instance = new Store { Products = new List<string>() };

        // serialize-deserialize using cloning
        var clone = Serializer.DeepClone(instance);

        // clone is not null and empty
        Assert.IsNotNull(clone.Products);
        Assert.AreEqual(0, clone.Products.Count);
    }

    [ProtoContract]
    public class Store : Extensible
    {
        [ProtoMember(1)]
        public List<string> Products { get; set; }

        [OnSerializing]
        public void OnDeserializing()
        {
            var productsListIsEmpty = this.Products != null && this.Products.Count == 0;
            Extensible.AppendValue(this, 101, productsListIsEmpty);
        }

        [OnDeserialized]
        public void OnDeserialized()
        {
            var productsListIsEmpty = Extensible.GetValue<bool>(this, 101);
            if (productsListIsEmpty)
                this.Products = new List<string>();
        }
    }
0 голосов
/ 12 июня 2015 
public List<NotificationAddress> BccAddresses { get; set; }

Вы можете заменить на: 

private List<NotificationAddress> _BccAddresses;
public List<NotificationAddress> BccAddresses {
   get { return _BccAddresses; }
   set { _BccAddresses = (value != null && value.length) ? value : null; }
}
...