如何反序列化 XML 文档

How to Deserialize XML document

提问人:Alex 提问时间:12/13/2008 最后编辑:Dariusz WoźniakAlex 更新时间:10/18/2022 访问量:811079

问:

如何反序列化此 XML 文档:

<?xml version="1.0" encoding="utf-8"?>
<Cars>
  <Car>
    <StockNumber>1020</StockNumber>
    <Make>Nissan</Make>
    <Model>Sentra</Model>
  </Car>
  <Car>
    <StockNumber>1010</StockNumber>
    <Make>Toyota</Make>
    <Model>Corolla</Model>
  </Car>
  <Car>
    <StockNumber>1111</StockNumber>
    <Make>Honda</Make>
    <Model>Accord</Model>
  </Car>
</Cars>

我有这个:

[Serializable()]
public class Car
{
    [System.Xml.Serialization.XmlElementAttribute("StockNumber")]
    public string StockNumber{ get; set; }

    [System.Xml.Serialization.XmlElementAttribute("Make")]
    public string Make{ get; set; }

    [System.Xml.Serialization.XmlElementAttribute("Model")]
    public string Model{ get; set; }
}

.

[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlArrayItem(typeof(Car))]
    public Car[] Car { get; set; }

}

.

public class CarSerializer
{
    public Cars Deserialize()
    {
        Cars[] cars = null;
        string path = HttpContext.Current.ApplicationInstance.Server.MapPath("~/App_Data/") + "cars.xml";

        XmlSerializer serializer = new XmlSerializer(typeof(Cars[]));

        StreamReader reader = new StreamReader(path);
        reader.ReadToEnd();
        cars = (Cars[])serializer.Deserialize(reader);
        reader.Close();

        return cars;
    }
}

这似乎不起作用:-(

C# asp.net XML 反序列化

评论

0赞 harpo 12/13/2008
我认为您需要转义示例文档中的尖括号。
6赞 Revious 2/19/2014
这个答案真的很好:stackoverflow.com/a/19613934/196210
0赞 David Thielen 6/27/2020
读者。ReadToEnd();错了!!

答:

25赞 Joel Coehoorn 12/13/2008 #1

看看这是否有帮助:

[Serializable()]
[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlArrayItem(typeof(Car))]
    public Car[] Car { get; set; }
}

.

[Serializable()]
public class Car
{
    [System.Xml.Serialization.XmlElement()]
    public string StockNumber{ get; set; }

    [System.Xml.Serialization.XmlElement()]
    public string Make{ get; set; }

    [System.Xml.Serialization.XmlElement()]
    public string Model{ get; set; }
}

如果失败,请使用 Visual Studio 附带的 xsd.exe 程序基于该 xml 文件创建架构文档,然后再次使用它基于架构文档创建类。

390赞 Kevin Tighe 12/13/2008 #2

这是一个工作版本。我更改了标签,因为在 xml 中,StockNumber、Make 和 Model 值是元素,而不是属性。我还删除了(该函数读取整个流并返回一个字符串,因此该函数无法再使用阅读器......该位置位于流的末尾)。我还对命名:)进行了一些自由。XmlElementAttributeXmlElementreader.ReadToEnd();Deserialize()

以下是课程:

[Serializable()]
public class Car
{
    [System.Xml.Serialization.XmlElement("StockNumber")]
    public string StockNumber { get; set; }

    [System.Xml.Serialization.XmlElement("Make")]
    public string Make { get; set; }

    [System.Xml.Serialization.XmlElement("Model")]
    public string Model { get; set; }
}


[Serializable()]
[System.Xml.Serialization.XmlRoot("CarCollection")]
public class CarCollection
{
    [XmlArray("Cars")]
    [XmlArrayItem("Car", typeof(Car))]
    public Car[] Car { get; set; }
}

反序列化函数:

CarCollection cars = null;
string path = "cars.xml";

XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));

StreamReader reader = new StreamReader(path);
cars = (CarCollection)serializer.Deserialize(reader);
reader.Close();

还有略微调整的 xml(我需要添加一个新元素来包装<汽车>......Net 对反序列化数组很挑剔):

<?xml version="1.0" encoding="utf-8"?>
<CarCollection>
<Cars>
  <Car>
    <StockNumber>1020</StockNumber>
    <Make>Nissan</Make>
    <Model>Sentra</Model>
  </Car>
  <Car>
    <StockNumber>1010</StockNumber>
    <Make>Toyota</Make>
    <Model>Corolla</Model>
  </Car>
  <Car>
    <StockNumber>1111</StockNumber>
    <Make>Honda</Make>
    <Model>Accord</Model>
  </Car>
</Cars>
</CarCollection>

评论

74赞 Marc Gravell 5/8/2012
如果使用 ; 根本不会检查这一点。同样,大多数属性都是多余的,因为它只是模仿默认行为;也就是说,默认情况下,调用的属性被存储为一个名为的元素 - 不需要属性。[Serializable]XmlSerializerXmlSerializer[Xml...]StockNumber<StockNumber>
4赞 Flamefire 10/25/2014
请注意,XmlElementAttribute = XmlElement(这是一种语言功能,可以省略后缀“Attribute”) 这里真正的解决方案是删除 ReadToEnd() 调用并添加根节点。但最好使用 erymski 的代码来解决问题(解析给定的 xml)
3赞 Vikrant 7/27/2015
谢谢凯文,但是如果我从示例 XML 中删除 CarsCollection 怎么办?我从类和 Deserealize 代码中删除了 Carscollection,但没有成功。
0赞 Jonathan Allen 4/20/2022
据我了解,它被剥夺了,不应该再使用了。Serializable
0赞 Andrew Dennison 8/11/2022
@Flamefire +1 用于删除 ReadToEnd,-1 用于调整 XML(当不需要时)。
506赞 Marc Gravell 12/13/2008 #3

您只需将 xml 保存到文件中,然后使用 xsd 生成 C# 类怎么样?

  1. 将文件写入磁盘(我将其命名为 foo.xml)
  2. 生成 xsd:xsd foo.xml
  3. 生成 C#:xsd foo.xsd /classes

瞧 - 和 C# 代码文件,应该能够通过以下方式读取数据:XmlSerializer

    XmlSerializer ser = new XmlSerializer(typeof(Cars));
    Cars cars;
    using (XmlReader reader = XmlReader.Create(path))
    {
        cars = (Cars) ser.Deserialize(reader);
    }

(在项目中包含生成的 foo.cs)

评论

8赞 Induster 2/2/2013
你。。。是男人!谢谢。对于任何需要它的人来说,“path”可以是您从 Web 响应创建的 Stream,如下所示:var resp = response。内容.ReadAsByteArrayAsync();var stream = new MemoryStream(resp.结果);
1赞 GotDibbs 2/7/2013
很棒的主意,但无法让它适用于我稍微复杂的模型,其中包含成批的嵌套数组。我不断收到嵌套数组的类型转换错误——加上生成的命名方案还有一些不足之处。因此,我最终选择了自定义路线。
12赞 jwillmer 10/29/2013
如何访问 xsd.exe
3赞 goku_da_master 10/16/2014
XSD.exe 可从 Visual Studio 命令提示符获得,而不是 Windows 命令提示符。查看是否可以从 Visual Studio 中的“工具”下打开命令提示符。如果没有,请尝试从 Visual Studio 文件夹访问它。对于VS 2012,它位于以下位置:C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\Tools\Shortcuts。在 Windows 8 中,尝试搜索“Visual Studio Tools”。
3赞 SOReader 10/13/2015
适合所有正在寻找 XSD 的人。这是一个 SO 线程:stackoverflow.com/questions/22975031/...
109赞 erymski 12/23/2008 #4

以下代码片段应该可以解决问题(您可以忽略大多数序列化属性):

public class Car
{
  public string StockNumber { get; set; }
  public string Make { get; set; }
  public string Model { get; set; }
}

[XmlRootAttribute("Cars")]
public class CarCollection
{
  [XmlElement("Car")]
  public Car[] Cars { get; set; }
}

...

using (TextReader reader = new StreamReader(path))
{
  XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));
  return (CarCollection) serializer.Deserialize(reader);
}

评论

18赞 Flamefire 10/25/2014
这实际上是唯一的答案。公认的答案有几个缺陷,可能会让初学者感到困惑。
0赞 John Deer 10/26/2020
@AndrewDennison你没有和任何人说话
0赞 Sulli 10/8/2021
这应该是公认的答案。我与OP处于相同的情况,但无法控制XML的任何内容,因此无法将根元素包装在新的根元素中。直接在数组上使用 XmlElement,而不是混合 XmlArray 和 XmlArrayItem 的各种组合就可以了。
11赞 janbak 1/26/2012 #5

我不认为 .net “对反序列化数组很挑剔”。第一个 xml 文档的格式不正确。 没有根元素,尽管它看起来有。规范 xml 文档有一个根和至少 1 个元素(如果有的话)。在您的示例中:

<Root> <-- well, the root
  <Cars> <-- an element (not a root), it being an array
    <Car> <-- an element, it being an array item
    ...
    </Car>
  </Cars>
</Root>
9赞 sheetal nainwal 10/7/2013 #6

如果您的 .xml 文件已在磁盘中的某个位置生成,并且您使用了以下代码,请尝试此代码块:List<T>

//deserialization

XmlSerializer xmlser = new XmlSerializer(typeof(List<Item>));
StreamReader srdr = new StreamReader(@"C:\serialize.xml");
List<Item> p = (List<Item>)xmlser.Deserialize(srdr);
srdr.Close();`

注意:是我的 .xml 文件的路径。您可以根据需要进行更改。C:\serialize.xml

266赞 Damian Drygiel 10/27/2013 #7

你有两种可能性。

方法 1.XSD 工具


假设您的 XML 文件位于此位置C:\path\to\xml\file.xml

  1. 打开开发人员命令提示符,
    您可以在以下位置找到它,或者如果您有 Windows 8,则可以在“开始”屏幕中开始键入开发人员命令提示
    Start Menu > Programs > Microsoft Visual Studio 2012 > Visual Studio Tools
  2. 通过键入cd /D "C:\path\to\xml"
  3. 键入 XML 文件,从 xml 文件创建 XSD 文件xsd file.xml
  4. 通过键入创建 C# 类xsd /c file.xsd

就是这样!您已从 xml 文件生成 C# 类C:\path\to\xml\file.cs

方法2 - 选择性粘贴


必需的 Visual Studio 2012+

  1. 将 XML 文件的内容复制到剪贴板
  2. 将新的空类文件 (Shift+Alt+C)
  3. 打开该文件,然后在菜单中单击Edit > Paste special > Paste XML As Classes
    enter image description here

就是这样!

用法


这个帮助程序类的用法非常简单:

using System;
using System.IO;
using System.Web.Script.Serialization; // Add reference: System.Web.Extensions
using System.Xml;
using System.Xml.Serialization;

namespace Helpers
{
    internal static class ParseHelpers
    {
        private static JavaScriptSerializer json;
        private static JavaScriptSerializer JSON { get { return json ?? (json = new JavaScriptSerializer()); } }

        public static Stream ToStream(this string @this)
        {
            var stream = new MemoryStream();
            var writer = new StreamWriter(stream);
            writer.Write(@this);
            writer.Flush();
            stream.Position = 0;
            return stream;
        }


        public static T ParseXML<T>(this string @this) where T : class
        {
            var reader = XmlReader.Create(@this.Trim().ToStream(), new XmlReaderSettings() { ConformanceLevel = ConformanceLevel.Document });
            return new XmlSerializer(typeof(T)).Deserialize(reader) as T;
        }

        public static T ParseJSON<T>(this string @this) where T : class
        {
            return JSON.Deserialize<T>(@this.Trim());
        }
    }
}

你现在要做的就是:

    public class JSONRoot
    {
        public catalog catalog { get; set; }
    }
    // ...

    string xml = File.ReadAllText(@"D:\file.xml");
    var catalog1 = xml.ParseXML<catalog>();

    string json = File.ReadAllText(@"D:\file.json");
    var catalog2 = json.ParseJSON<JSONRoot>();

评论

18赞 amiry jd 11/16/2013
+1 好答案。但是,该命令仅针对 .NET 4.5Paste XML As Classes
2赞 Scotty.NET 11/25/2014
如果您确实安装了 vs2012+,这是生成模型的好方法。之后我确实运行了 ReSharper 代码清理以使用自动属性,然后还进行了一些其他整理。你可以通过这种方法生成,然后如果需要,复制到一个较旧的proj中。
5赞 LosManos 3/23/2015
瞄准 .net4.5 不是问题。只需使用 dotnet4.5 启动一个临时项目,在那里进行复制粘贴并将源代码复制到您的实际项目中。
2赞 CB4 12/6/2016
“目录”对象或类在哪里?
5赞 Slion 8/22/2018
要使“将 XML 粘贴为类”显示在 VS 2017 社区的该菜单中,您需要安装“ASP.NET 和 Web 开发”。如果缺少,只需再次运行 VS 安装程序即可修改安装。
1赞 goku_da_master 10/17/2014 #8

如果使用 xsd.exe 创建 xsd 文件时遇到错误,请使用 msdn 上提到的 XmlSchemaInference 类。下面是一个要演示的单元测试:

using System.Xml;
using System.Xml.Schema;

[TestMethod]
public void GenerateXsdFromXmlTest()
{
    string folder = @"C:\mydir\mydata\xmlToCSharp";
    XmlReader reader = XmlReader.Create(folder + "\some_xml.xml");
    XmlSchemaSet schemaSet = new XmlSchemaSet();
    XmlSchemaInference schema = new XmlSchemaInference();

    schemaSet = schema.InferSchema(reader);


    foreach (XmlSchema s in schemaSet.Schemas())
    {
        XmlWriter xsdFile = new XmlTextWriter(folder + "\some_xsd.xsd", System.Text.Encoding.UTF8);
        s.Write(xsdFile);
        xsdFile.Close();
    }
}

// now from the visual studio command line type: xsd some_xsd.xsd /classes
1赞 XU Weijiang 11/17/2014 #9

只需将 Cars 汽车属性的一个属性从 XmlArrayItem 更改为 XmlElment。也就是说,从

[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlArrayItem(typeof(Car))]
    public Car[] Car { get; set; }
}

[System.Xml.Serialization.XmlRootAttribute("Cars", Namespace = "", IsNullable = false)]
public class Cars
{
    [XmlElement("Car")]
    public Car[] Car { get; set; }
}
3赞 makdu 9/30/2015 #10

这个想法是处理所有级别以进行反序列化 请参阅解决我的类似问题的示例解决方案

<?xml version="1.0" ?> 
 <TRANSACTION_RESPONSE>
    <TRANSACTION>
        <TRANSACTION_ID>25429</TRANSACTION_ID> 
        <MERCHANT_ACC_NO>02700701354375000964</MERCHANT_ACC_NO> 
        <TXN_STATUS>F</TXN_STATUS> 
        <TXN_SIGNATURE>a16af68d4c3e2280e44bd7c2c23f2af6cb1f0e5a28c266ea741608e72b1a5e4224da5b975909cc43c53b6c0f7f1bbf0820269caa3e350dd1812484edc499b279</TXN_SIGNATURE> 
        <TXN_SIGNATURE2>B1684258EA112C8B5BA51F73CDA9864D1BB98E04F5A78B67A3E539BEF96CCF4D16CFF6B9E04818B50E855E0783BB075309D112CA596BDC49F9738C4BF3AA1FB4</TXN_SIGNATURE2> 
        <TRAN_DATE>29-09-2015 07:36:59</TRAN_DATE> 
        <MERCHANT_TRANID>150929093703RUDZMX4</MERCHANT_TRANID> 
        <RESPONSE_CODE>9967</RESPONSE_CODE> 
        <RESPONSE_DESC>Bank rejected transaction!</RESPONSE_DESC> 
        <CUSTOMER_ID>RUDZMX</CUSTOMER_ID> 
        <AUTH_ID /> 
        <AUTH_DATE /> 
        <CAPTURE_DATE /> 
        <SALES_DATE /> 
        <VOID_REV_DATE /> 
        <REFUND_DATE /> 
        <REFUND_AMOUNT>0.00</REFUND_AMOUNT> 
    </TRANSACTION>
  </TRANSACTION_RESPONSE> 

上面的 XML 在两个级别中处理

  [XmlType("TRANSACTION_RESPONSE")]
public class TransactionResponse
{
    [XmlElement("TRANSACTION")]
    public BankQueryResponse Response { get; set; }

}

内在层

public class BankQueryResponse
{
    [XmlElement("TRANSACTION_ID")]
    public string TransactionId { get; set; }

    [XmlElement("MERCHANT_ACC_NO")]
    public string MerchantAccNo { get; set; }

    [XmlElement("TXN_SIGNATURE")]
    public string TxnSignature { get; set; }

    [XmlElement("TRAN_DATE")]
    public DateTime TranDate { get; set; }

    [XmlElement("TXN_STATUS")]
    public string TxnStatus { get; set; }


    [XmlElement("REFUND_DATE")]
    public DateTime RefundDate { get; set; }

    [XmlElement("RESPONSE_CODE")]
    public string ResponseCode { get; set; }


    [XmlElement("RESPONSE_DESC")]
    public string ResponseDesc { get; set; }

    [XmlAttribute("MERCHANT_TRANID")]
    public string MerchantTranId { get; set; }

}

同样,您需要多级 检查此示例是否进行多级反序列化car as array

6赞 Hasan Javaid 5/12/2016 #11

试试这个用于 Xml 序列化和反序列化的泛型类。

public class SerializeConfig<T> where T : class
{
    public static void Serialize(string path, T type)
    {
        var serializer = new XmlSerializer(type.GetType());
        using (var writer = new FileStream(path, FileMode.Create))
        {
            serializer.Serialize(writer, type);
        }
    }

    public static T DeSerialize(string path)
    {
        T type;
        var serializer = new XmlSerializer(typeof(T));
        using (var reader = XmlReader.Create(path))
        {
            type = serializer.Deserialize(reader) as T;
        }
        return type;
    }
}
1赞 haiduong87 8/9/2017 #12

我的解决方案:

  1. 用于获取代码中的类Edit > Past Special > Paste XML As Classes
  2. 尝试如下操作:创建该类 (>) 的列表,然后使用 将该列表序列化为文件。List<class1XmlSerializerxml
  3. 现在,您只需将该文件的正文替换为您的数据并尝试它。deserialize

法典:

StreamReader sr = new StreamReader(@"C:\Users\duongngh\Desktop\Newfolder\abc.txt");
XmlSerializer xml = new XmlSerializer(typeof(Class1[]));
var a = xml.Deserialize(sr);
sr.Close();

注意:您必须注意根名称,不要更改它。我的是“ArrayOfClass1”

5赞 David C Fuchs 12/2/2017 #13

使用泛型类来反序列化 XML 文档怎么样

//++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
// Generic class to load any xml into a class
// used like this ...
// YourClassTypeHere InfoList = LoadXMLFileIntoClass<YourClassTypeHere>(xmlFile);

using System.IO;
using System.Xml.Serialization;

public static T LoadXMLFileIntoClass<T>(string xmlFile)
{
    T returnThis;
    XmlSerializer serializer = new XmlSerializer(typeof(T));
    if (!FileAndIO.FileExists(xmlFile))
    {
        Console.WriteLine("FileDoesNotExistError {0}", xmlFile);
    }
    returnThis = (T)serializer.Deserialize(new StreamReader(xmlFile));
    return (T)returnThis;
}

这部分可能是必需的,也可能不是必需的。在 Visual Studio 中打开 XML 文档,右键单击 XML,选择“属性”。然后选择您的架构文件。

评论

1赞 pwrgreg007 2/5/2020
这使我能够大幅缩小业务逻辑代码,并将功能集中在一个帮助程序类中,其中包含我生成的所有 <T> 类。我已经将 XML 放在一个字符串中,因此可以将其压缩为: ' public static T LoadXMLFileIntoClass<T>(string xmlData) ' { ' XmlSerializer serializer = new XmlSerializer(typeof(T)); ' return (T)serializer.反序列化(new StringReader(xmlData));' } 谢谢!
9赞 Kim Homann 1/13/2018 #14

Kevin 的回答很好,除了在现实世界中,您通常无法更改原始 XML 以满足您的需求。

对于原始 XML,也有一个简单的解决方案:

[XmlRoot("Cars")]
public class XmlData
{
    [XmlElement("Car")]
    public List<Car> Cars{ get; set; }
}

public class Car
{
    public string StockNumber { get; set; }
    public string Make { get; set; }
    public string Model { get; set; }
}

然后你可以简单地调用:

var ser = new XmlSerializer(typeof(XmlData));
var data = (XmlData)ser.Deserialize(XmlReader.Create(PathToCarsXml));

评论

0赞 Colin 3/12/2018
谢谢!您的答案正是我所需要的,因为我不想更改千兆字节的日志文件。
0赞 Kim Homann 3/21/2018
虽然值得一提的是,XmlSerializer 解决方案非常优雅,但不可否认,它的速度也不是很快,并且对意外的 Xml 数据反应灵敏。因此,如果您的问题不需要完全反序列化,则应考虑仅使用更实用且性能更高的 XmlReader 类,并循环访问 <Car> 元素。
11赞 SlowLearner 5/22/2018 #15

对于初学者

我发现这里的答案非常有帮助,也就是说我仍然在努力(只是一点点)让它工作。因此,如果它对某人有帮助,我将阐明可行的解决方案:

来自原始问题的 XML。xml 位于文件 Class1.xml 中,在代码中使用 to this file 来查找此 xml 文件。path

我使用了 @erymski 的答案来解决这个问题,因此创建了一个名为 Car.cs 的文件并添加了以下内容:

using System.Xml.Serialization;  // Added

public class Car
{
    public string StockNumber { get; set; }
    public string Make { get; set; }
    public string Model { get; set; }
}

[XmlRootAttribute("Cars")]
public class CarCollection
{
    [XmlElement("Car")]
    public Car[] Cars { get; set; }
}

@erymski提供的另一段代码...

using (TextReader reader = new StreamReader(path))
{
  XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));
  return (CarCollection) serializer.Deserialize(reader);
}

...进入您的主程序(Program.cs),如下所示:static CarCollection XCar()

using System;
using System.IO;
using System.Xml.Serialization;

namespace ConsoleApp2
{
    class Program
    {

        public static void Main()
        {
            var c = new CarCollection();

            c = XCar();

            foreach (var k in c.Cars)
            {
                Console.WriteLine(k.Make + " " + k.Model + " " + k.StockNumber);
            }
            c = null;
            Console.ReadLine();

        }
        static CarCollection XCar()
        {
            using (TextReader reader = new StreamReader(@"C:\Users\SlowLearner\source\repos\ConsoleApp2\ConsoleApp2\Class1.xml"))
            {
                XmlSerializer serializer = new XmlSerializer(typeof(CarCollection));
                return (CarCollection)serializer.Deserialize(reader);
            }
        }
    }
}

希望对你有所帮助:-)

评论

1赞 Diwakar Padmaraja 1/29/2019
它对我有用。对于给定的 xml 输入(如 OP 的示例)来说,这也是一个完美的解决方案。[XmlElement(“Car”)] 是正确的属性。在其他示例中,他们使用了 XmlArray 等,只要我们将属性定义为 public Car[] Cars { get; set; } 并且它会正确反序列化它,就不需要这些属性。谢谢。
7赞 Andre M 9/20/2019 #16

一班:

var object = (Cars)new XmlSerializer(typeof(Cars)).Deserialize(new StringReader(xmlString));