Comment décorer/définir les membres de la classe facultative de l'élément XML pour être utilisé avec XmlSerializer?

J'ai le texte suivant de la structure XML. Le theElement élément peut contenir theOptionalList élément, ou pas:

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

Ce qui est un moyen propre à exprimer le correspondant de la structure de la classe?

Je suis assez sûr de l'suivantes:

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();
        }
    }
}

Ainsi que:

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();
        }
    }
}

Mais ce sujet pour theElement? Dois-je prendre le theOptionalList élément comme un type tableau à lire ce qu'il trouve dans le fichier (soit rien, ou une seule), puis vérifier dans le code si elle est là ou pas? Ou est-il un autre décorateur que je peux fournir? Ou est-il juste de travail?

EDIT: j'ai fini par en utilisant les informations de cette réponse.

OriginalL'auteur John | 2011-10-28

c#xmlserializer

6

Essayez d'ajouter IsNullable = true à la XmlArrayItem attribut.

Merci pour la réponse James. Je suppose que ce serait en mesure de gérer un theOptionalList élément sans éléments, mais ne serait-il gérer theOptionalList n'existant pas à tous? (Je ne pourrais pas comprendre ce que vous êtes en train de suggérer.) Aussi, il n'y a pas de schéma pour mon format, c'est par un accord verbal entre moi et un autre développeur. 🙂
Je ne suis pas positif, mais je pense que l'utilisation d' IsNullable d'exclusion si le tableau est null.
Considérons un schéma. Il est puissamment utile, si petit et est un grand morceau de votre "boîte à outils".

OriginalL'auteur James Johnson
4

Il ressemble, vous pouvez utiliser un autre bool pour spécifier d'inclure un élément ou non.

Une autre option est d'utiliser un modèle spécifique pour créer un champ de type Boolean
reconnu par le XmlSerializer, et à appliquer la XmlIgnoreAttribute
pour le domaine. Le modèle est créé sous la forme d'
propertyNameSpecified. Par exemple, si il y a un champ nommé
"MyFirstName", vous devez également créer un champ nommé
"MyFirstNameSpecified" qui indique le XmlSerializer si
générer un élément XML nommé "MyFirstName". Ceci est illustré dans le
l'exemple suivant.
```
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

Merci pour la réponse. Cet exemple traite de la sérialisation, qui fait partie de ce que je suis confronté. L'autre partie est de la désérialisation. Ce que si je l'appelle Deserialize() sur un fichier avec ce format? Parce que je ne pense pas que je peux dire à la XmlSerializer pour l'ensemble du fichier à quoi s'attendre par élément. En d'autres termes, est-il un comportement par défaut si je désérialiser et il ne veut pas voir un membre qui est spécifié dans la classe?
Oui, il y a un comportement par défaut, Le constructeur par défaut de la classe. Lorsque vous désérialisez votre XML, le XMLSerializer appelle le constructeur par défaut pour créer vos objets, de sorte que vous pouvez définir vos paramètres par défaut ici. Il est généralement utile de définir des valeurs par défaut pour les propriétés par défaut dans le constructeur et ajouter : this() sur vos autres constructeurs pour assurer vos valeurs par défaut sont définies en premier.

OriginalL'auteur K2so

Supplémentaires à la XxySpecifed de la propriété, il y a aussi une méthode avec un ShouldSerialize préfixe

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

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

OriginalL'auteur kux

Vous devez vous connecter pour publier un commentaire.