C# 反序列化 XML 文件到列表

Question

我想将 XML 反序列化为对象列表。

这是我的顶级 C# 课程：

[XmlRoot("Events")]
[XmlType("Events")]
[Serializable]
public class WinEventLogList
{

    public WinEventLogList() { Items = new List<WinEventLog>(); }

    [XmlElement("Event")]
    public List<WinEventLog> Items { get; set; }

}

[XmlRoot("Event")]
[XmlType("Event")]
[Serializable]
public class WinEventLog
{

    [XmlElement("System")]
    [JsonPropertyName("system")]
    public EventSystem System { get; set; } = new EventSystem();

    [XmlElement("EventData")]
    [JsonPropertyName("eventData")]
    public EventData EventData { get; set; } = new EventData();

}

这是我需要反序列化的示例 XML：

<?xml version="1.0" encoding="utf-8"?>
<Events>
  <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
    <System>Omitted tags go in here</System>
    <EventData>Omitted tags go in here</EventData>
  </Event>
  <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
    <System>Omitted tags go in here</System>
    <EventData>Omitted tags go in here</Event>
  <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
    <System>Omitted tags go in here</System>
    <EventData>Omitted tags go in here</EventData>
  </Event>
  <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
    <System>Omitted tags go in here</System>
    <EventData>Omitted tags go in here</EventData>
  </Event>
  <Event xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
    <System>Omitted tags go in here</System>
    <EventData>Omitted tags go in here</EventData>
  </Event>
</Events>

这是我尝试过的两种不同方法，都来自这个 stackoverflow 问题。

首先，尝试使用包装器 class WinEventLogList

using var stream = File.OpenRead("path/to/my/xml/file.xml");
using var reader = new StreamReader(stream);
var serializer = new XmlSerializer(typeof(WinEventLogList));
var list = serializer.Value.Deserialize(reader) as WinEventLogList;
var winEventLogs = list.Items;

然后，尝试在序列化程序中直接使用普通List 。

using var stream = File.OpenRead("path/to/my/xml/file.xml");
using var reader = new StreamReader(stream);
var serializer = new XmlSerializer(
    typeof(List<WinEventLog>),  
    new XmlRootAttribute("Events"));
var winEventLogs = serializer.Value.Deserialize(reader) as List<WinEventLog>;

在这两种情况下，生成的winEventLogs变量都是一个空列表。 为什么会这样？ 如何纠正？

Answer 1

XML 的一个经常被忽视的组件是名称空间。 它们实际上是 [反] 序列化过程中不可或缺的一部分。
您几乎就在那里，只需在 object 中指定名称空间以匹配 XML。

这是一个工作片段：

void Main() {
  using var reader = new StringReader(xmlStr);
  var serializer = new XmlSerializer(typeof(WinEventLogList));
  var list = (WinEventLogList)serializer.Deserialize(reader)!;
  list.Dump();
}

[XmlRoot("Events")]
public class WinEventLogList {
  // Namespaces are extremely important!
  [XmlElement("Event", Namespace="http://schemas.microsoft.com/win/2004/08/events/event")]
  public List<WinEventLog> Items { get; set; } = new();
}

public class WinEventLog {
  [XmlElement] public int System { get; set; }
  [XmlElement] public int EventData { get; set; }
}

string xmlStr = """
<?xml version='1.0' encoding='utf-8'?>
<Events>
  <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'>
    <System>1</System>  <EventData>2</EventData>
  </Event>
  <Event xmlns='http://schemas.microsoft.com/win/2004/08/events/event'>
    <System>3</System>  <EventData>4</EventData>
  </Event>
</Events>
""";