C#:从通用类型名称获取XML元素名称的最佳方法

时间:2016-07-13 06:51:48

标签: c# xml generics xml-serialization

我想为泛型类创建一个xml。其中一个属性具有泛型类型。对于此属性,我不想将属性名称用作其XML元素名称,而是使用泛型类型的名称。

该课程如下:

[XmlRoot("Entity")]
public class StoreItem<TEntity>
    where TEntity : class, new()
{
    /// <summary>
    /// Gets and sets the status of the entity when storing.
    /// </summary>
    [XmlAttribute]
    public System.Data.Services.Client.EntityStates Status { get; set; }

    /// <summary>
    /// Gets and sets the entity to be stored.
    /// </summary>
    public TEntity Entity { get; set; }
}

在序列化类型StoreItem<SewageArea>的商店项时,XML应包含以下内容:

<Entity Status="Deleted">
    <SewageArea ...>
       ...
    </SewageArea>
<Entity>

要求是,上面例子中的SewageArea应该在&#34; normal&#34;中序列化。办法。另一个重要的事情是,如果可能的话,代码应该准备好在StoreItem类自动序列化新添加的属性。

1 个答案:

答案 0 :(得分:6)

您希望按照Rename class when serializing to XML的方式执行某些操作,但您不能这样做,因为属性参数不能包含泛型类型参数,即[XmlElement(typeof(TEntity))]。实现IXmlSerializable的明显替代方法很不方便,因为您丢失了随后添加到StoreItem<TEntity>的属性的自动序列化。

相反,您可以使用[XmlAnyElement]代理属性来执行TEntity嵌套序列化,如下所示:

[XmlRoot("Entity")]
public class StoreItem<TEntity>
    where TEntity : class, new()
{
    /// <summary>
    /// Gets and sets the status of the entity when storing.
    /// </summary>
    [XmlAttribute]
    public System.Data.Services.Client.EntityStates Status { get; set; }

    /// <summary>
    /// Gets and sets the entity to be stored.
    /// </summary>
    [XmlIgnore]
    public TEntity Entity { get; set; }

    [XmlAnyElement]
    [Browsable(false), EditorBrowsable(EditorBrowsableState.Never), DebuggerBrowsable(DebuggerBrowsableState.Never)]
    public XElement XmlEntity
    {
        get
        {
            return (Entity == null ? null : XObjectExtensions.SerializeToXElement(Entity, null, true));
        }
        set
        {
            Entity = (value == null ? null : XObjectExtensions.Deserialize<TEntity>(value));
        }
    }
}

使用扩展方法:

public static class XObjectExtensions
{
    public static T Deserialize<T>(this XContainer element)
    {
        return element.Deserialize<T>(null);
    }

    public static T Deserialize<T>(this XContainer element, XmlSerializer serializer)
    {
        using (var reader = element.CreateReader())
        {
            serializer = serializer ?? new XmlSerializer(typeof(T));
            object result = serializer.Deserialize(reader);
            if (result is T)
                return (T)result;
        }
        return default(T);
    }

    public static XElement SerializeToXElement<T>(this T obj)
    {
        return obj.SerializeToXElement(null, true);
    }

    public static XElement SerializeToXElement<T>(this T obj, XmlSerializer serializer, bool omitStandardNamespaces)
    {
        var doc = new XDocument();
        using (var writer = doc.CreateWriter())
        {
            XmlSerializerNamespaces ns = null;
            if (omitStandardNamespaces)
                (ns = new XmlSerializerNamespaces()).Add("", ""); // Disable the xmlns:xsi and xmlns:xsd lines.
            serializer = serializer ?? new XmlSerializer(obj.GetType());
            serializer.Serialize(writer, obj, ns);
        }
        var element = doc.Root;
        if (element != null)
            element.Remove();
        return element;
    }
}

请注意,将为所有未知元素调用[XmlAnyElement]属性,因此如果您的XML由于某种原因具有意外元素,则可能会从XObjectExtensions.Deserialize<TEntity>(value))抛出异常,因为根元素名称错误。如果可能的话,您可能希望捕获并忽略此方法中的异常。

然后,对于样本TEntity

public class SewageArea
{
    public double Area { get; set; }
}

XML输出是:

<Entity Status="State1">
  <SewageArea>
    <Area>10101</Area>
  </SewageArea>
</Entity>

示例fiddle