使用 .NET XML 序列化将序列化属性包装在其他元素中

Question

我正在使用 C# + VSTS2008 + .Net 3.0 进行 XML 序列化。代码工作正常。下面是我的代码和当前的序列化 XML 结果。

现在我想在输出 XML 文件中添加两个附加层。这是我预期的 XML 结果。有什么简单的方法可以做到这一点？我不确定 NestingLevel 是否可以帮助做到这一点。我想找到一种不改变 MyClass 和 MyObject 结构的简单方法。

预期的 XML 序列化结果，

<?xml version="1.0"?>
<MyClass xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 

xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MyObjectProperty>
    <AdditionalLayer1>
      <AdditionalLayer2>
        <ObjectName>Foo</ObjectName>
      </AdditionalLayer1>
    </AdditionalLayer2>
  </MyObjectProperty>
</MyClass>

当前 XML 序列化结果，

<?xml version="1.0"?>
<MyClass xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 

xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <MyObjectProperty>
    <ObjectName>Foo</ObjectName>
  </MyObjectProperty>
</MyClass>

我当前的代码，

public class MyClass
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

public class Program
{
    static void Main(string[] args)
    {
        XmlSerializer s = new XmlSerializer(typeof(MyClass));
        FileStream fs = new FileStream("foo.xml", FileMode.Create);
        MyClass instance = new MyClass();
        instance.MyObjectProperty = new MyObject();
        instance.MyObjectProperty.ObjectName = "Foo";
        s.Serialize(fs, instance);

        return;
    }
}

Answer 1

我想找到一种不改变 MyClass 和 MyObject 结构的简单方法。

坦率地说，这不会发生。 XmlSerializer（简单使用时）遵循类/成员的结构。所以你不能在不改变结构的情况下添加额外的层。

当以定制方式 (IXmlSerializable) 使用时，您可以肯定地说它并不简单......这不是一个有趣的实现接口。

我的建议：引入一个模拟您所需格式的 DTO，并在序列化之前对其进行填充。

Answer 2

为什么需要这两个额外的层？

这是业务需求，你应该将这两个对象添加到你的对象模型中：

public class MyClass
{
    public AdditionalLayer1 AdditionalLayer1;
}
public class AdditionalLayer1
{
    public AdditionalLayer2 AdditionalLayer2;
}
public class AdditionalLayer2
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

如果纯粹是因为某些兼容性要求，您可以执行上述操作，或者在 MyClass 上实现 IXmlSerializable：

public class MyClass : IXmlSerializable
{
    public MyObject MyObjectProperty;

    public void WriteXml (XmlWriter writer)
    {
        //open the two layers
        //serialize MyObject
        //close the two layers
    }

    public void ReadXml (XmlReader reader)
    {
        //read all the layers back, etc
    }

    public XmlSchema GetSchema()
    {
        return(null);
    }

}

Answer 3

您可以在序列化后使用 XSL 进行转换并添加“缺失”标签。

Answer 4

我建议序列化为MemoryStream 而不是FileStream，然后将XML 加载到XmlDocument，然后使用该类的方法插入所需的额外节点。之后，您可以将其保存出来。

Answer 5

我最近才这样做，并没有发现重写 IXmlSerializable 接口非常困难或复杂。像往常一样进行序列化/反序列化，但对于包含子类的类，您需要将这些子类包装在从 IXmlSerializable 派生的额外标签中：

class ContainingClass : IXmlSerializable
{
 ...

#region IXmlSerializable Members

public XmlSchema GetSchema()
{
  return null;
}

public void ReadXml(XmlReader reader)
{
  **reader.ReadStartElement("Equipment");**

  XmlSerializer ser = new XmlSerializer(typeof(Host));

  while (reader.NodeType != XmlNodeType.EndElement)
  {
    Host newHost = new Host();
    newHost.Name = (string) ser.Deserialize(reader);
    _hosts.Add(newHost);

    reader.Read();
  }

  // Read the node to its end.
  // Next call of the reader methods will crash if not called.
  **reader.ReadEndElement(); // "Equipment"**
}

public void WriteXml(XmlWriter writer)
{
  XmlSerializer ser = new XmlSerializer(typeof(Host));
  **writer.WriteStartElement("Equipment");**
  foreach (Host host in this._hosts)
  {
    ser.Serialize(writer, host);
  }
  **writer.WriteEndElement();**
}

#endregion

我在这里所做的只是包装低级对象的反序列化。在这里，我在这个类的集合中的所有主机周围包装了一个额外的标签“设备”。您可以在此处添加任意数量的标签，只要关闭您开始的每个标签即可。

注意：粗体显示为 ** 文本 ** - 只需确保去掉双星号 :)