Come decorare/definire i membri della classe per un elemento XML facoltativo da utilizzare con XmlSerializer?

Question

Ho la seguente struttura XML. L'elemento theElement può contenere theOptionalList elemento, o no:

<theElement attrOne="valueOne" attrTwo="valueTwo"> 
    <theOptionalList> 
     <theListItem attrA="valueA" /> 
     <theListItem attrA="anotherValue" /> 
     <theListItem attrA="stillAnother" /> 
    </theOptionalList> 
</theElement> 
<theElement attrOne="anotherOne" attrTwo="anotherTwo" /> 

Che cosa è un modo pulito per esprimere la struttura corrispondente classe?

Sono abbastanza sicuro di quanto segue:

using System; 
using System.Collections.Generic; 
using System.Linq; 
using System.Text; 
using System.Xml.Serialization; 

namespace MyNamespace 
{ 
    public class TheOptionalList 
    { 
     [XmlAttributeAttribute("attrOne")] 
     public string AttrOne { get; set; } 

     [XmlAttributeAttribute("attrTwo")] 
     public string AttrTwo { get; set; } 

     [XmlArrayItem("theListItem", typeof(TheListItem))] 
     public TheListItem[] theListItems{ get; set; } 

     public override string ToString() 
     { 
      StringBuilder outText = new StringBuilder(); 

      outText.Append("attrOne = " + AttrOne + " attrTwo = " + AttrTwo + "\r\n"); 

      foreach (TheListItem li in theListItems) 
      { 
       outText.Append(li.ToString()); 
      } 

      return outText.ToString(); 
     } 
    } 
} 

Così come:

using System; 
using System.Collections.Generic; 
using System.Linq; 
using System.Text; 
using System.Xml.Serialization; 

namespace MyNamespace 
{ 
    public class TheListItem 
    { 
     [XmlAttributeAttribute("attrA")] 
     public string AttrA { get; set; } 

     public override string ToString() 
     { 
      StringBuilder outText = new StringBuilder(); 

      outText.Append(" attrA = " + AttrA + "\r\n");     
      return outText.ToString(); 
     } 
    } 
} 

Ma che dire per theElement? Prendo l'elemento theOptionalList come un tipo di matrice per fare in modo che legga ciò che trova nel file (nulla o uno) e poi controlla nel codice se è lì o no? O c'è un altro decoratore che posso fornire? Oppure funziona?

MODIFICA: Ho finito per utilizzare le informazioni da this answer.

Answer 1

Prova ad aggiungere IsNullable = true all'attributo XmlArrayItem.

Answer 2

Sembra che sia possibile utilizzare un altro bool per specificare di includere un elemento o meno.

Un'altra opzione è quella di utilizzare un modello speciale per creare un campo booleano riconosciuto dal XmlSerializer, e di applicare il XmlIgnoreAttribute al campo. Il modello viene creato sotto forma di propertyNameSpecified. Ad esempio, se esiste un campo denominato "MyFirstName", verrà creato anche un campo denominato "MyFirstNameSpecified" che indica a XmlSerializer se a generare l'elemento XML denominato "MyFirstName". Questo è mostrato nell'esempio seguente .

public class OptionalOrder 
{ 
    // This field should not be serialized 
    // if it is uninitialized. 
    public string FirstOrder; 

    // Use the XmlIgnoreAttribute to ignore the 
    // special field named "FirstOrderSpecified". 
    [System.Xml.Serialization.XmlIgnoreAttribute] 
    public bool FirstOrderSpecified; 
} 

http://msdn.microsoft.com/en-us/library/system.xml.serialization.xmlserializer.aspx

Answer 3

supplementare alla proprietà XxySpecifed, v'è anche un metodo con un ShouldSerialize prefisso

[XmlElement] 
public List<string> OptionalXyz {get; set;} 

public bool ShouldSerializeOptionaXyz() { 
    return OptionalXyz != null && OptionalXyz.Count > 0 ; 
}