Suppression des types de valeurs nulles émis par XmlSerializer

Question

Veuillez considérer la propriété de type valeur du montant suivante qui est marquée comme un XmlElement nullable :

[XmlElement(IsNullable=true)] 
public double? Amount { get ; set ; }

Lorsqu'un type de valeur nullable est défini sur null, le résultat de C# XmlSerializer ressemble à ce qui suit :

<amount xsi:nil="true" />

Plutôt que d'émettre cet élément, je voudrais que le XmlSerializer le supprime complètement. Pourquoi ? Nous utilisons Authorize.NET pour les paiements en ligne et Authorize.NET rejette la demande si cet élément nul existe.

La solution actuelle consiste à ne pas sérialiser du tout la propriété Amount value type. Au lieu de cela, nous avons créé une propriété complémentaire, SerializableAmount, qui est basée sur Amount et est sérialisée à la place. Puisque SerializableAmount est de type String, qui comme les types de référence sont supprimés par le XmlSerializer s'ils sont nuls par défaut, tout fonctionne parfaitement.

/// <summary>
/// Gets or sets the amount.
/// </summary>
[XmlIgnore]
public double? Amount { get; set; }

/// <summary>
/// Gets or sets the amount for serialization purposes only.
/// This had to be done because setting value types to null 
/// does not prevent them from being included when a class 
/// is being serialized.  When a nullable value type is set 
/// to null, such as with the Amount property, the result 
/// looks like: &gt;amount xsi:nil="true" /&lt; which will 
/// cause the Authorize.NET to reject the request.  Strings 
/// when set to null will be removed as they are a 
/// reference type.
/// </summary>
[XmlElement("amount", IsNullable = false)]
public string SerializableAmount
{
    get { return this.Amount == null ? null : this.Amount.ToString(); }
    set { this.Amount = Convert.ToDouble(value); }
}

Bien sûr, il ne s'agit que d'une solution de rechange. Existe-t-il un moyen plus propre de supprimer l'émission des éléments de type valeur nulle ?

Answer 1

Essayez d'ajouter :

public bool ShouldSerializeAmount() {
   return Amount != null;
}

Il existe un certain nombre de modèles reconnus par certaines parties du cadre. Pour plus d'informations, XmlSerializer cherche également public bool AmountSpecified {get;set;} .

Exemple complet (passant également à decimal ) :

using System;
using System.Xml.Serialization;

public class Data {
    public decimal? Amount { get; set; }
    public bool ShouldSerializeAmount() {
        return Amount != null;
    }
    static void Main() {
        Data d = new Data();
        XmlSerializer ser = new XmlSerializer(d.GetType());
        ser.Serialize(Console.Out, d);
        Console.WriteLine();
        Console.WriteLine();
        d.Amount = 123.45M;
        ser.Serialize(Console.Out, d);
    }
}

Plus d'informations sur ShouldSerialize* sur MSDN .

Answer 2

Il existe également une alternative pour obtenir

 <amount /> instead of <amount xsi:nil="true" />

Utilisez

[XmlElement("amount", IsNullable = false)]
public string SerializableAmount
{
    get { return this.Amount == null ? "" : this.Amount.ToString(); }
    set { this.Amount = Convert.ToDouble(value); }
}

Answer 3

Vous pouvez essayer ceci :

xml.Replace("xsi:nil=\"true\"", string.Empty);