C#XML Serialization删除包装元素

时间:2017-02-15 09:15:50

标签: c# xml xml-serialization

我写的是因为我有XmlSerializer的问题。我希望XML格式如下:

<?xml version="1.0" encoding="utf-8"?>
<RootXML>
    <e-Invoice>
      <Version>1.03</Version>
    </e-Invoice>
    <TradeInvoice>
        <Id>1</Id>
        <Value>100</Value>
    </TradeInvoice>
    <e-Invoice>
      <Version>1.03</Version>
    </e-Invoice>
    <TradeInvoice>
        <Id>2</Id>
        <Value>200</Value>
    </TradeInvoice>
    <e-Invoice>
        <Version>1.03</Version>
    </e-Invoice>
    <TradeInvoice>
        <Id>3</Id>
        <Value>300</Value>
    </TradeInvoice>
</RootXML>

所以我创建了以下类。

[XmlRoot("RootXML")]
public class Root
{
    public Root()
    {
        RootBodies = new List<RootBody>();
    }

    [XmlElement("e-Invoice")]
    public List<RootBody> RootBodies { get; set; }
}

public class RootBody
{
    public RootBody()
    {
        TradeInvoice = new TradeInvoice();
        EInvoiceInfo = new Version(); ;
    }

    [XmlElement("e-Invoice")]
    public Version EInvoiceInfo { get; set; }

    [XmlElement("TradeInvoice")]
    public TradeInvoice TradeInvoice { get; set; }
}

public class Version
{
    [XmlElement("Version")]
    public string Version { get; set; }
}

public class TradeInvoice
{
    [XmlElement("Id")]
    public int Id { get; set; }
    [XmlElement("Value")]
    public int Value { get; set; }
}

我有删除包装器元素的问题(删除RootBody)。我读了类似link这样的话题。但它并没有解决我的问题。

1 个答案:

答案 0 :(得分:2)

在实际解释之前,让我指出一些非常重要的事情:

  • 这个XML设计得不是很好,并且会引起很多其他问题(我猜它实际上比这复杂得多)。
  • 命名约定不一致(e-InvoiceTradeInvoce
  • 版本号看起来不合适,确保这是他们(告诉你这样做的人)在投入额外时间之前所需要的。
  • 此XML定义 namespaces(可能没有XSDDTD
  • 看看Google's XML design guidelines。你会发现还有很大的改进空间。

有很多不同的方法可以做到这一点,这只是其中之一。我建议您与负责此设计的人一起讨论,并尝试改变主意。

由于您想要在没有包装元素的情况下序列化e-InvoiceTradeInvoce但仍保持元素的顺序(因为它们属于一起),您需要确保它们具有公共基类,以便它们可以从同一个系列中序列化。

这个抽象的Invoice类只是告诉序列化程序在序列化过程中应该通过XmlInclude属性包含哪些类。

[XmlInclude(typeof(EInvoice))]
[XmlInclude(typeof(TradeInvoice))]
public abstract class Invoice
{
}

您的实际课程将基本保持不变

[XmlRoot("e-Invoice")]
public class EInvoice : Invoice
{
    [XmlElement("Version")]
    public string Version { get; set; }
}

[XmlRoot("TradeInvoice")]
public class TradeInvoice : Invoice
{
    [XmlElement("Id")]
    public int Id { get; set; }
    [XmlElement("Value")]
    public int Value { get; set; }
}

您的数据类不再需要任何与XML相关的属性,因为现在它不能直接序列化为该格式。

public class InvoicePair
{
    public InvoicePair(EInvoice eInvoice, TradeInvoice tradeInvoice)
    {
        TradeInvoice = tradeInvoice;
        EInvoiceInfo = eInvoice;
    }

    public EInvoice EInvoiceInfo { get; set; }

    public TradeInvoice TradeInvoice { get; set; }
}

您的Root课程必须简化一点。由于我们希望EInvoceTradeInvoice元素位于同一级别但混合在一起,因此我们需要将它们放在同一个集合中。 XmlElement属性将告诉序列化程序如何处理不同类型的元素,而不依赖于xsi:type属性。

[XmlRoot("RootXML")]
public class Root
{
    public Root()
    {
        RootBodies = new List<Invoice>();
    }

    [XmlElement(Type = typeof(EInvoice), ElementName = "e-Invoice")]
    [XmlElement(Type = typeof(TradeInvoice), ElementName = "TradeInvoice")]
    public List<Invoice> RootBodies { get; set; }
}

此时序列化非常简单。只需将所有元素一个接一个地添加到元素集合中:

public static void Serialize(IEnumerable<InvoicePair> invoices, Stream stream)
{
    Root root = new Root();
    foreach (var invoice in invoices)
    {
        root.RootBodies.Add(invoice.EInvoiceInfo);
        root.RootBodies.Add(invoice.TradeInvoice);
    }

    XmlSerializer serializer = new XmlSerializer(typeof(Root));
    serializer.Serialize(stream, root);
}

反序列化也不是很难,但很容易产生错误并做出很多假设:

public static IEnumerable<InvoicePair> Deserialize(Stream stream)
{
    XmlSerializer serializer = new XmlSerializer(typeof(Root));
    Root root = serializer.Deserialize(stream) as Root;

    for (int i = 0; i < root.RootBodies.Count; i += 2)
    {
        yield return new InvoicePair(
            (EInvoice) root.RootBodies[i], 
            (TradeInvoice) root.RootBodies[i+1]
        );
    }
}

Here is a working Demo Fiddle, that outputs the XML