¿Por qué mis propiedades públicas no están serializadas por XmlSerializer?

Question

Este es uno con el que luché durante años, así que pensé en documentar en alguna parte. (Disculpas por hacer y responder una pregunta.)

(C# .net 2.0) Tenía una clase que estaba siendo serializada por XmlSerializer, agregué una nueva propiedad pública, sin embargo, no se incluyó en el XML de salida.

No se menciona en los documentos en ningún lugar que pude encontrar, ¡pero las propiedades públicas deben tener un conjunto y una serialización! Supongo que esto se debe a que supone que si vas a serializar, querrás deserializar desde el mismo archivo, por lo que solo serializará las propiedades que tengan un conjunto y un get.

Answer 1

Como se mencionó, la mayoría de las propiedades deben tener un getter y un setter; la principal excepción a esto son las listas, por ejemplo:

private readonly List<Foo> bar = new List<Foo>(); 
public List<Foo> Bar {get { return bar; } } // works fine 

que funcionará bien; sin embargo, si XmlSerializerencuentra un colocador - exige que sea público; lo siguiente será no trabajo:

public List<Foo> Bar {get; private set;} // FAIL 

Otras razones por las que podría no serializa:

• no es pública con obtener y establecer (o es readonly para un campo)
• tiene un atributo [DefaultValue], y es con ese valor
• tiene un método público bool ShouldSerializeFoo() que devolvió falso
• tiene un público bool FooSpecified {get;set;} propiedad o campo que ha devuelto false
• se marca [XmlIgnore]
• se marca [Obsolete]

Cualquiera de estos y hacer que no serializar

Answer 2

El punto sobre captador + setter está hecho en el 3er párrafo en la página "Intro to Xml Serialization". En realidad está en una caja de llamada. No puedo perderlo!

Intro-to-XML Serialization http://www.freeimagehosting.net/uploads/2f04fea2db.png

(quien tiene demasiada diversión con Freeimagehosting.net)

Answer 3

también propiedades que devuelven NULL no se serializado!

Answer 4

Y si su clase hereda una lista y también tiene sus propios miembros, solo los elementos de la lista se serializan. Los datos presentes en los miembros de su clase no se capturan. ¡Tomó algo de tiempo descubrir esto!

Answer 5

si no desea implementar Setter adecuados (porque tal vez no son ni queriendo deserializar o cambiar un valor de objetos) que sólo puede utilizar los emisores ficticias como esto set { }, de manera que los XMLSerializer obras, pero no pasa nada si use el Setter ...

iE

public string ID { get { return _item.ID.ToString(); } set { } } 

Answer 6

Una cosa más que añadir sobre la serialización de las colecciones:

XmlSerializer hace caso omiso de las colecciones de las interfaces!

Y con eso quiero decir ignore. Mientras que obtendrá una excepción para una línea como:

public IFoo Foo { get; set; } 

va no obtener una excepción para:

public ICollection<IFoo> LotsOfFoos { get { return this.fooBackingField; } } 

Answer 7

Puede implementar la IXmlSerializer y hacer la serialización de forma manual, y se benefician de la serialización propiedades, y viceversa, deserializarlos usando constructores/asignación de campo privada.