Подавлять типы нулевых значений от испускания XmlSerializer

Обратите внимание на следующее свойство типа значения суммы, которое помечено как нулевое значение XmlElement:

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

Если для типа nullable value установлено значение null, результат С# XmlSerializer выглядит следующим образом:

<amount xsi:nil="true" />

Вместо того, чтобы испускать этот элемент, я хотел бы, чтобы XmlSerializer полностью подавил элемент. Зачем? Мы используем Authorize.NET для онлайн-платежей, а Authorize.NET отклоняет запрос, если этот нулевой элемент существует.

Текущее решение/обходное решение состоит в том, чтобы вообще не сериализовать свойство типа значения суммы. Вместо этого мы создали дополнительное свойство SerializableAmount, которое основано на сумме и вместо этого сериализуется. Поскольку SerializableAmount имеет тип String, который, подобно ссылочным типам, подавляется XmlSerializer, если значение null по умолчанию, все работает отлично.

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

Конечно, это всего лишь обходной путь. Существует ли более чистый способ подавления элементов типа нулевого значения?

Ответ 1

Попробуйте добавить:

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

Существует ряд шаблонов, распознаваемых частями фреймворка. Для информации XmlSerializer также ищет public bool AmountSpecified {get;set;}.

Полный пример (также переход на 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);
    }
}

Дополнительная информация о ShouldSerialize * в MSDN.

Ответ 2

Существует также альтернатива получить

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

Использование

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

Ответ 3

вы можете попробовать следующее:

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