使用 XmlSeralizer 在 C# 中解析稍微不正常的 XML

Question

我收到了一些不太具有适当架构的“XML”文件（我认为这就是问题所在），并且生成它们的医疗设备无法更改为生成易于解析的 XML。 （通过如此诱人的小修改（在 Image 条目周围额外包裹 Images 标签），读取这些文件将变得微不足道——这不是 XML 的意义所在吗？ ？）

基本上我被困在这里了。 XML 如下所示：（

<Series>
   <Metadata1>foo</Metadata1>
   <Metadata2>bar</Metadata2>
   ...
   <Image>...</Image>
   <Image>...</Image>
   ...
</Series>

可以有任意数量的图像，但可能的元数据标签都是已知的）。我的代码如下所示：

public class Image { ... }

public class Series : List<Image>
{
    public Series() { }
    public string Metadata1;
    public string Metadata2;
    ...
}

当我像这样运行时：

            XmlSerializer xs = new XmlSerializer(typeof(Series));
            StreamReader sr = new StreamReader(path);
            Series series = (Series)xs.Deserialize(sr);
            sr.Close();

图像对象列表正确读取到系列对象中，但没有读取 Metadata1/2/etc 字段（事实上，在调试器中浏览对象会显示所有元数据字段在“原始视图”类型的字段内部）。

当我更改代码：

public class Series    // // removed this : List<Image>
{
    public Series() { }
    public string Metadata1;
    public string Metadata2;
    ...
}

并在文件上运行阅读器时，我得到一个包含 Metadata1/2/etc 的系列对象。完美填充，但没有读取图像数据（显然）。

如何解析 Metadata1/2/etc。以及具有最少痛苦的临时代码的一系列图像？

我是否必须编写一些自定义（痛苦？简单？）ReadXML 方法来实现 IXMLSeralizable？

我不太关心对象的布局方式，因为使用这些 C# 类的软件非常灵活：

List<Image> Images;

for the images would be fine, or perhaps the metadata is wrapped in some object, whatever...

Answer 1

您的类缺少允许 XML 的属性序列化工作。我相信以下内容应该足够了。

[XmlElement]
public class Image { ... }

[XmlRoot(ElementName="Series")]
public class Series
{
        public Series() { }

        [XmlElement]
        public string Metadata1;

        [XmlElement]
        public string Metadata2;

        [XmlElement(ElementName="Image")]
        public Image[] Images;
}

我不确定您是否可以使用通用类型来代替图像数组，但上面引用的链接应该为您提供有关如何针对特定情况应用序列化属性的更多信息。

编辑：另一种选择是手工制作 XML 架构来验证应用程序生成的文档，然后使用 XSD.exe 生成对象模型。生成的类将演示如何调整对象模型以与序列化器一起使用。

Answer 2

为什么要尝试使用 XML 序列化程序来执行此操作？序列化通常是指能够以某种众所周知的格式（文本或二进制）保存对象的“状态”，以便可以在以后的某个时间点重新创建它。这听起来不像你在这里想做的事情。这里的问题是 XML 数据与您的对象层次结构并不真正匹配。

您有一个硬件设备，可以以某种方式生成您想要使用的 XML 数据。对我来说，使用简单的 XmlDocument 或 XmlReader 类而不是尝试通过序列化器是最简单的。

您可能可以使用如下代码来做到这一点：

public class Image { }

public class Series
{
   public string Metadata1;
   public string Metadata2;
   public List<Image> Images = new List<Image>();

   public void Load(string xml)
   {
      XmlDocument doc = new XmlDocument();
      doc.Load(xml);

      XmlNodeList images = doc.SelectNodes("Image");
      foreach (XmlNode image in images)
      {
         Images.Add(new Image(image.InnerText));
      }

      Metadata1 = GetMetadataValue(doc, "Metadata1");
      Metadata2 = GetMetadataValue(doc, "Metadata2");
   }

   private string GetMetadataValue(XmlDocument document, string nodeName)
   {
      string value = String.Empty;
      XmlNode metadataNode = document.SelectSingleNode(nodeName);
      if (metadataNode != null)
      {
         value = metaDataNode.InnerText;
      }

      return value;
   }
}

*这是未经测试/未经验证的代码，但它应该能够传达这个想法。

Answer 3

我认为史蒂夫的回答应该有效。我只是想补充一点，使用这种技术只能读取有限数量的元数据元素，因为它们没有常量名称。您可以做的是将它们读入 XmlElements 集合中，以便稍后解析：

[XmlRoot(ElementName="Series")]
public class Series
{
    public Series() { }

    [XmlAnyElement]
    XmlElement[] UnknownElements;

    private string[] _metadata;
    [XmlIgnore]
    public string[] Metadata
    {
        get
        {
            if (_metadata == null && UnknownElements != null)
            {
                _metadata = UnknownElements
                            .Where(e => e.Name.StartsWith("Metadata")
                            .Select(e => e.InnerText)
                            .ToArray();
            }
            return _metadata;
        }
    }

    [XmlElement(ElementName="Image")]
    public Image[] Images;
}