it-swarm.dev

Suprimir tipos de valor nulo de ser emitido pelo XmlSerializer

Por favor, considere a seguinte propriedade do tipo valor do montante que está marcado como um XmlElement anulável: 

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

Quando um tipo de valor anulável é definido como nulo, o resultado C # XmlSerializer parece com o seguinte: 

<amount xsi:nil="true" />

Em vez de emitir esse elemento, gostaria que o XmlSerializer suprimisse o elemento completamente. Por quê? Estamos usando o Authorize.NET para pagamentos on-line e o Authorize.NET rejeita a solicitação se esse elemento nulo existir. 

A solução/solução atual é não serializar a propriedade do tipo valor Amount. Em vez disso, criamos uma propriedade complementar, SerializableAmount, que é baseada em Valor e é serializada. Já que SerializableAmount é do tipo String, que como tipos de referência são suprimidos pelo XmlSerializer se null por padrão, tudo funciona muito bem. 

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

Claro, isso é apenas uma solução. Existe uma maneira mais limpa de impedir que os elementos do tipo de valor nulo sejam emitidos?

63
Ben Griswold

Tente adicionar:

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

Existem vários padrões reconhecidos por partes do framework. Para informações, XmlSerializer também procura public bool AmountSpecified {get;set;}.

Exemplo completo (também mudando para 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);
    }
}

Mais informações sobre ShouldSerialize * no MSDN .

132
Marc Gravell

Há também uma alternativa para obter 

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

Usar

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

você pode tentar isto: 

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

0
Nicolas Battaglia