C#:从泛型类型名称获取 XML 元素名称的最佳方式

本文关键字：元素 最佳 方式 XML 获取 泛型类型 | 更新日期: 2023-09-27 17:56:37

我想为泛型类创建一个 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应以"正常"方式序列化。另一个重要的事情是，如果可能的话，代码应该准备好在StoreItem类中自动序列化新添加的属性。

C#:从泛型类型名称获取 XML 元素名称的最佳方式

你想在

序列化为 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>

样品小提琴。

相关文章：