如何为 XML Serializer 创建一个类

Question

我的xml格式如下：

<FavouriteSettings xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Customer>
    <ID>12</ID>
    <ID>2</ID>
    <ID>5</ID>
  </Customer>

  <Supplier>
    <ID>158</ID>
    <ID>23</ID>
    <ID>598</ID>
  </Supplier>
</FavouriteSettings>

================================================ ===============
我会有一个像下面这样的课程

class FavouriteList
{
   public string Name; // this name will be "Customer" and "Supplier"
   public List<int> aList; // to store those "ID" value
}

Class FavouriteSettings
{
   public List<FavouriteList> bigList;
}

我需要做什么或改变才能使此类与 XMLSerializer 一起使用以生成类似该格式的 XML 文件并反序列化回列表和类作为 FavouriteList？

Answer 1

XmlSerializer 旨在将您的对象非常直接地转换为 xml；你可以使用IXmlSerializable，但这很少值得。您最好创建反映 xml 结构的对象。或者，更简单 - 使用 xsd 为您完成：

xsd example.xml
xsd example.xsd /classes

或者我怀疑以下方法会起作用（未经测试）：

using System.Collections.Generic;
using System.Xml.Serialization;
public class FavoriteSettings
{
    [XmlArray("Customer")]
    [XmlArrayItem("ID")]
    public List<int> Customers { get; set; }

    [XmlArray("Supplier")]
    [XmlArrayItem("ID")]
    public List<int> Suppliers { get; set; }
}

特别是；如果您希望 元素 名称（“客户”等）根据数据（“名称”等）而变化 - 那么除非您使用 IXmlSerializable 或自己编写，否则它不会发生与XDocument（或类似）。对于这样的简单数据，也许XDocument 是一个可行的选择？但是你会做很多额外的工作，尤其是在反序列化期间。

---

这是一个通过 LINQ-to-XML 使用 现有 类的示例：

static class Program
{
    static void Main() {
        var favs = new FavouriteSettings
        {
            bigList = new List<FavouriteList>
            {
                new FavouriteList {
                    Name = "Customer",
                    aList = new List<int>{
                        12,2,5
                    }
                }, new FavouriteList {
                    Name = "Supplier",
                    aList = new List<int>{
                        158, 23, 598
                    }
                }
            }
        };
        var el = new XElement("FavoriteSettings",
            from fav in favs.bigList
            select new XElement(fav.Name,
                from item in fav.aList
                select new XElement("ID", item)));

        string xml = el.ToString();
        Console.WriteLine(xml);

        el = XElement.Parse(xml);
        favs = new FavouriteSettings
        {
            bigList = new List<FavouriteList>(
                from outer in el.Elements()
                select new FavouriteList
                {
                    Name = outer.Name.LocalName,
                    aList = new List<int>(
                        from id in outer.Elements("ID")
                        select (int)id
                    )
                })
        };
    }
}

Answer 2

您可以使用以下类以及 XmlSerializer 来序列化/反序列化到/从所需的 XML：

  public class FavouriteSettings
  {
    public ID[] Customer
    {
      get;
      set;
    }

    public ID[] Supplier
    {
      get;
      set;
    }
  }

  public class ID
  {
    [XmlText()]
    public int Value
    {
      get;
      set;
    }
  }

Answer 3

如果您必须在类定义中保留所有现有名称，并且为 Customer 和 Supplier 引入类层次结构是不可能的，那么您将需要这样的 hack：

public class FavouriteList
{
   [XmlIgnore]
   public string Name; // this name will be "Customer" and "Supplier"

   [XmlElement("ID")]
   public List<int> aList; // to store those "ID" value
}

public class FavouriteSettings
{
   [XmlIgnore]
   public List<FavouriteList> bigList;

   [XmlElement("Customer")]
   public FavouriteList[] Customers
   {
       get { return bigList.Where(fl => fl.Name == "Customer").ToArray(); }
       set { bigList.AddRange(value); }
   }

   [XmlElement("Supplier")]
   public FavouriteList[] Suppliers
   {
       get { return bigList.Where(fl => fl.Name == "Supplier").ToArray(); }
       set { bigList.AddRange(value); }
   }
}

Answer 4

XMLSerializer（常规的）喜欢做自己的事情，结果往往很丑陋。你可以通过实现 IXmlSerializable 来半控制序列化，但是如果你有类似“List”的东西，.NET 会杀掉它。

我认为您可以改用 DataContractXmlSerializer 获得准确的结果。用 [DataContract] 标记该类，并在要序列化的每个元素上放置一个 [DataMember]。

Answer 5

我相信您可以使用属性来控制数据的序列化方式。请参阅此 MSDN 文章：“Attributes That Control XML Serialization”。