使用一个类序列化不同的根元素名称

本文关键字:元素 序列化 一个 | 更新日期: 2023-09-27 18:22:19

我有几个XML文件,它们有不同的根元素,但有相同类型的子元素,我希望能够创建一个单独的类来容纳不同的根元件,另一个类来容纳每个子元件。下面是XML文件的两个示例。

文件1:

<?xml version="1.0" encoding="utf-8" ?>
<Sandra>
  <Address>
    <Street></Street>
    <Number></Number>
  </Address>
</Sandra>

文件2:

<?xml version="1.0" encoding="utf-8" ?>
<John>
  <Address>
    <Street></Street>
    <Number></Number>
  </Address>
</John>

我希望只使用两个类就可以对其进行序列化和反序列化,比如:

[Serializable]
[XmlRoot]
public class Person
{
    [XmlElement("Address")]
    public List<Address> Adresses { get; set; }
}
[Serializable]
public class Address
{
    public string Street { get; set; }
    public string Number { get; set; }
}

我试着用阅读它们

    var ser = new XmlSerializer(typeof(Person));
    var reader = XmlReader.Create("person1.xml");
    var person = (Person)ser.Deserialize(reader);

但我得到了"There is an error in XML document (2, 2).",因为反序列化程序需要<"Person">根元素,而不是<"John"><"Paul">。如果我将[XmlRoot]更改为[XmlRoot("John")],效果会很好,但这正是我在这里试图避免的。

此外,我必须能够使用同样奇怪的XML结构将其序列化,因此我需要将根元素名称存储在Person类中

我知道我可以简单地创建自己的(反)序列化程序,但我想知道是否可以使用现有的方法来实现它。

编辑1:(回滚)。

编辑2:回滚了"编辑1"的修改,因为我找到了一种更简单的方法来实现我所需要的。请参阅下面的答案。

使用一个类序列化不同的根元素名称

找到了一个简洁快速的方法来解决我的问题!在实例化XmlSerializer时,我只需要使用XmlRootAttribute。通过这种方式,我可以在运行时设置根元素的名称。

var personsName = "Sandra";
var ser = new XmlSerializer(typeof(Person), 
   new XmlRootAttribute { ElementName = personsName });
var reader = XmlReader.Create("person1.xml");
var person = (Person)ser.Deserialize(reader);

当然,如果我想序列化它,它也可以用同样的方式工作

使用人名作为XML元素名称感觉有点不稳定。每个元素代表什么,John还是Person

如果您能够控制这些XML文件的形状,那么这样表示它们可能会更好:

<?xml version="1.0" encoding="utf-8" ?>
<Person name="Sandra">
  <Address>
    <Street></Street>
    <Number></Number>
  </Address>
</Person>

然后,您将有一种简单的方法将名称存储在属性中,映射为XML属性:

[Serializable]
[XmlRoot]
public class Person
{
    [XmlElement("Address")]
    public List<Address> Adresses { get; set; }
    [XmlAttribute("name")]
    public string Name { get; set;}
}

在类中实现IXmlSerializable,并在函数中按照您想要的方式进行序列化:

ReadXml(System.Xml.XmlReader reader)WriteXml(System.Xml.XmlWriter writer)

示例:

[Serializable]
public class Threshold : IXmlSerializable
{
public int Type {get;set;}
public object Value {get;set;}
public string Name {get;set;}
public void ReadXml(System.Xml.XmlReader reader)
{

XElement thresholdXML = XElement.Load(reader);
if (!thresholdXML.HasElements || thresholdXML.IsEmpty)
return;
Type = (ThresholdType)int.Parse(thresholdXML.Element("Type").Value);
Value = Type.Equals(ThresholdType.Complex) ? thresholdXML.Element("Value").Value : (object)Decimal.Parse(thresholdXML.Element("Value").Value);
Name = thresholdXML.Element("Name").Value;

}

public System.Xml.Schema.XmlSchema GetSchema()
{
return null;
}
public void WriteXml(System.Xml.XmlWriter writer)
{
XmlSerializerNamespaces xmlnsEmpty = new XmlSerializerNamespaces();
xmlnsEmpty.Add("", "");

writer.WriteElementString("Type", ((int)Type).ToString("D"));
writer.WriteElementString("Value", Value.ToString());
writer.WriteElementString("Name", Name);
}
}

使用根元素作为ArrayOfClassName,然后尝试。

<ArrayOfAlarmSummary>
  <AlarmSummary>
    <ClientId>1</ClientId>
    <StationId>2</StationId>
    <StationName>Station-2</StationName>
    <DateTime>13/09/15</DateTime>
    <TagName>AI2_2</TagName>
    <Description>TR DC Current</Description>
    <Units>Amps</Units>
    <NormalOperation>10 to 100</NormalOperation>
    <AlarmValue>132.48</AlarmValue>
    <AlarmDescription>
    </AlarmDescription>
  </AlarmSummary>
  <AlarmSummary>
    <ClientId>1</ClientId>
    <StationId>2</StationId>
    <StationName>Station-2</StationName>
    <DateTime>13/09/15</DateTime>
    <TagName>AI2_2</TagName>
    <Description>TR AC Current</Description>
    <Units>Amps</Units>
    <NormalOperation>10 to 100</NormalOperation>
    <AlarmValue>132.48</AlarmValue>
    <AlarmDescription>
    </AlarmDescription>
  </AlarmSummary>
</ArrayOfAlarmSummary>

这是反序列化类,使用它可以反序列化Xml文件。

 public class SerializeDeserialize<T>
    {
        StringBuilder sbData;
        StringWriter swWriter;
        XmlDocument xDoc;
        XmlNodeReader xNodeReader;
        XmlSerializer xmlSerializer;
        public SerializeDeserialize()
        {
            sbData = new StringBuilder();
        }
        public string SerializeData(T data)
        {
            XmlSerializer employeeSerializer = new XmlSerializer(typeof(T));
            swWriter = new StringWriter(sbData);
            employeeSerializer.Serialize(swWriter, data);
            return sbData.ToString();
        }
        public T DeserializeData(string dataXML)
        {
            xDoc = new XmlDocument();
            xDoc.LoadXml(dataXML);
            xNodeReader = new XmlNodeReader(xDoc.DocumentElement);
            xmlSerializer = new XmlSerializer(typeof(T));
            var employeeData = xmlSerializer.Deserialize(xNodeReader);
            T deserializedEmployee = (T)employeeData;
            return deserializedEmployee;
        }
    }

调用类

 var appDomain = System.IO.Directory.GetCurrentDirectory() + "''AlarmFiles";
            var strPath = Path.Combine(appDomain,
                "Alarm_" + DateTime.Now.ToString("ddMMyyyy") + Constants.FileType.XmlFile);
            var fi = new FileInfo(strPath);
            if (fi.Exists)
            {
                try
                {
                    var xmlString = System.IO.File.ReadAllText(strPath);
                    var serializeAlarmSummary =
                        new SerializeDeserialize<List<AlarmSummary>>();
                    return serializeAlarmSummary.DeserializeData(xmlString);
                }
                catch (Exception ex)
                {
                    throw ex;
                }
            }