使用XmlSerializer将空xml属性值反序列化为nullable int属性

时间:2009-08-18 18:35:26

标签: .net xml serialization nullable

我从第三方获得了一个xml,我需要将其反序列化为C#对象。此xml可能包含值为整数类型或空值的属性:attr =“11”或attr =“”。我想将此属性值反序列化为类型为可空整数的属性。但XmlSerializer不支持反序列化为可空类型。在使用InvalidOperationException创建XmlSerializer期间,以下测试代码失败{“有一个错误反映了类型'TestConsoleApplication.SerializeMe'。”}。

[XmlRoot("root")]
public class SerializeMe
{
    [XmlElement("element")]
    public Element Element { get; set; }
}

public class Element
{
    [XmlAttribute("attr")]
    public int? Value { get; set; }
}

class Program {
    static void Main(string[] args) {
        string xml = "<root><element attr=''>valE</element></root>";
        var deserializer = new XmlSerializer(typeof(SerializeMe));
        Stream xmlStream = new MemoryStream(Encoding.ASCII.GetBytes(xml));
        var result = (SerializeMe)deserializer.Deserialize(xmlStream);
    }
}

当我将'Value'属性的类型更改为int时,反序列化失败并出现InvalidOperationException:

  

XML文档(1,16)中存在错误。

任何人都可以建议如何将具有空值的属性反序列化为可空类型(作为null),同时将非空属性值反序列化为整数?有没有任何技巧,所以我不必手动反序列化每个字段(实际上有很多)?

在ahsteele的评论后更新:

  1. Xsi:nil attribute

    据我所知,此属性仅适用于XmlElementAttribute - 此属性指定元素没有内容,无论是子元素还是正文。但我需要找到XmlAttributeAttribute的解决方案。无论如何我无法改变xml,因为我无法控制它。

  2. bool *Specified property

    仅当属性值为非空或缺少属性时,此属性才有效。当attr具有空值(attr ='')时,XmlSerializer构造函数失败(如预期的那样)。

    public class Element
    {
        [XmlAttribute("attr")]
        public int Value { get; set; }
    
        [XmlIgnore]
        public bool ValueSpecified;
    }
    
  3. Custom Nullable class like in this blog post by Alex Scordellis

    我尝试将此博客文章中的课程用于我的问题:

    [XmlAttribute("attr")]
    public NullableInt Value { get; set; } 
    

    但XmlSerializer构造函数因InvalidOperationException失败:

      

    无法序列化TestConsoleApplication.NullableInt类型的成员'Value'。

         

    XmlAttribute / XmlText不能用于编码实现IXmlSerializable的类型}

  4. 丑陋的代理解决方案(我在这里编写此代码时感到羞耻:)):

    public class Element
    {
        [XmlAttribute("attr")]
        public string SetValue { get; set; }
    
        public int? GetValue()
        {
            if ( string.IsNullOrEmpty(SetValue) || SetValue.Trim().Length <= 0 )
                return null;
    
            int result;
            if (int.TryParse(SetValue, out result))
                return result;
    
            return null;
        }
    }
    

    但我不想提出这样的解决方案,因为它打破了我的类的接口为其消费者。我最好手动实现IXmlSerializable接口。

  5. 目前看起来我必须为整个Element类实现IXmlSerializable(它很大)并且没有简单的解决方法......

5 个答案:

答案 0 :(得分:53)

这应该有效:

[XmlIgnore]
public int? Age { get; set; }

[XmlElement("Age")]
public string AgeAsText
{
  get { return (Age.HasValue) ? Age.ToString() : null; } 
  set { Age = !string.IsNullOrEmpty(value) ? int.Parse(value) : default(int?); }
}

答案 1 :(得分:19)

我通过实现IXmlSerializable接口解决了这个问题。我没有找到更简单的方法。

以下是测试代码示例:

[XmlRoot("root")]
public class DeserializeMe {
    [XmlArray("elements"), XmlArrayItem("element")]
    public List<Element> Element { get; set; }
}

public class Element : IXmlSerializable {
    public int? Value1 { get; private set; }
    public float? Value2 { get; private set; }

    public void ReadXml(XmlReader reader) {
        string attr1 = reader.GetAttribute("attr");
        string attr2 = reader.GetAttribute("attr2");
        reader.Read();

        Value1 = ConvertToNullable<int>(attr1);
        Value2 = ConvertToNullable<float>(attr2);
    }

    private static T? ConvertToNullable<T>(string inputValue) where T : struct {
        if ( string.IsNullOrEmpty(inputValue) || inputValue.Trim().Length == 0 ) {
            return null;
        }

        try {
            TypeConverter conv = TypeDescriptor.GetConverter(typeof(T));
            return (T)conv.ConvertFrom(inputValue);
        }
        catch ( NotSupportedException ) {
            // The conversion cannot be performed
            return null;
        }
    }

    public XmlSchema GetSchema() { return null; }
    public void WriteXml(XmlWriter writer) { throw new NotImplementedException(); }
}

class TestProgram {
    public static void Main(string[] args) {
        string xml = @"<root><elements><element attr='11' attr2='11.3'/><element attr='' attr2=''/></elements></root>";
        XmlSerializer deserializer = new XmlSerializer(typeof(DeserializeMe));
        Stream xmlStream = new MemoryStream(Encoding.ASCII.GetBytes(xml));
        var result = (DeserializeMe)deserializer.Deserialize(xmlStream);
    }
}

答案 2 :(得分:10)

我最近一直在搞乱序列化,并且在处理值类型的空数据时发现以下文章和帖子很有用。

How to make a value type nullable with XmlSerializer in C# - serialization 的答案详细介绍了XmlSerializer的一个非常好的技巧。具体来说,XmlSerialier查找XXXSpecified布尔属性以确定是否应该包含它以允许您忽略空值。

Alex Scordellis问了一个收到a good answer的StackOverflow问题。 Alex也在他的博客上写了一篇关于他试图解决的问题 Using XmlSerializer to deserialize into a Nullable<int> 的文章。

Xsi:nil Attribute Binding Support上的MSDN文档也很有用。正如IXmlSerializable Interface上的文档一样,尽管编写自己的实现应该是最后的选择。

答案 3 :(得分:2)

我想我也可以把答案放到帽子里: 通过创建实现IXmlSerializable接口的自定义类型来解决此问题:

假设您有一个包含以下节点的XML对象:

<ItemOne>10</Item2>
<ItemTwo />

代表他们的对象:

public class MyItems {
    [XmlElement("ItemOne")]
    public int ItemOne { get; set; }

    [XmlElement("ItemTwo")]
    public CustomNullable<int> ItemTwo { get; set; } // will throw exception if empty element and type is int
}

动态可空结构表示任何潜在的可空条目以及转换

public struct CustomNullable<T> : IXmlSerializable where T: struct {
    private T value;
    private bool hasValue;

    public bool HasValue {
        get { return hasValue; }
    }

    public T Value {
        get { return value; }
    }

    private CustomNullable(T value) {
        this.hasValue = true;
        this.value = value;
    }

    public XmlSchema GetSchema() {
        return null;
    }

    public void ReadXml(XmlReader reader) {
        string strValue = reader.ReadString();
        if (String.IsNullOrEmpty(strValue)) {
            this.hasValue = false;
        }
        else {
            T convertedValue = strValue.To<T>();
            this.value = convertedValue;
            this.hasValue = true;
        }
        reader.ReadEndElement();

    }

    public void WriteXml(XmlWriter writer) {
        throw new NotImplementedException();
    }

    public static implicit operator CustomNullable<T>(T value) {
        return new CustomNullable<T>(value);
    }

}

public static class ObjectExtensions {
    public static T To<T>(this object value) {
        Type t = typeof(T);
        // Get the type that was made nullable.
        Type valueType = Nullable.GetUnderlyingType(typeof(T));
        if (valueType != null) {
            // Nullable type.
            if (value == null) {
                // you may want to do something different here.
                return default(T);
            }
            else {
                // Convert to the value type.
                object result = Convert.ChangeType(value, valueType);
                // Cast the value type to the nullable type.
                return (T)result;
            }
        }
        else {
            // Not nullable.
            return (T)Convert.ChangeType(value, typeof(T));
        }
    }
}

答案 4 :(得分:1)

您还可以通过将230s加载到xml中,然后将其反序列化到XmlDocument中来获得所需的对象Json

T