如何反序列化XML文件

Question

如何反序列化XML文件

c#asp.netxmlserializationxml-deserialization

536

我该如何反序列化这个 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;
    }
}

看起来不起作用 :-(

- Alex

我认为你需要在示例文档中转义尖括号。 - harpo

6

这个回答真的非常好：https://dev59.com/OXRC5IYBdhLWcg3wP-hh#19613934 - Revious

reader.ReadToEnd(); 是错误的！！！ - David Thielen

16个回答

390

这是一个工作版本。我将 XmlElementAttribute 标签更改为 XmlElement，因为在xml中，StockNumber、Make和Model值都是元素，而不是属性。此外，我移除了 reader.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; }
}

Deserialize函数：

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（我需要添加一个新元素来包装<Cars> …… .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>

- Kevin Tighe

74

如果使用XmlSerializer，则[Serializable]是多余的；XmlSerializer根本不会检查它。同样，大多数[Xml...]属性都是多余的，因为它只是模仿默认行为；即默认情况下，名为StockNumber的属性将作为名为<StockNumber>的元素存储 - 没有必要使用属性。 - Marc Gravell

4

请注意，XmlElementAttribute = XmlElement（这是一种语言特性，您可以省略后缀“Attribute”）。真正的解决方案在于删除ReadToEnd()调用并添加根节点。但最好使用erymski的代码来解决问题（解析给定的XML）。 - Flamefire

3

谢谢Kevin。但是如果我从示例XML中删除了CarsCollection会怎样？我已经从类和反序列化代码中删除了CarsCollection，但没有成功。 - Vikrant

据我所知，Serializable 已经被弃用，不应再使用。 - Jonathan Allen

@Flamefire +1 移除 ReadToEnd，-1 调整 XML，如果不是必要的。 - Andrew Dennison

266

您有两种选择。

方法1。 XSD工具

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

打开开发人员命令提示符
您可以在“开始菜单>程序> Microsoft Visual Studio 2012> Visual Studio工具”中找到它或者如果您拥有Windows 8，只需在“开始屏幕”中键入“Developer Command Prompt”
通过输入cd / D“ C：\ path \ to \ xml”将位置更改为您的XML文件目录
通过输入xsd file.xml从xml文件创建XSD文件
通过输入xsd / c file.xsd创建C＃类

就这样！您已经从xml文件生成了C＃类，位于C：\ path \ to \ xml \ file.cs

方法2-特殊粘贴

需要Visual Studio 2012+

将XML文件的内容复制到剪贴板中
向解决方案添加新的空类文件（Shift + Alt + C）
打开该文件，并在菜单中单击“编辑>特殊粘贴>粘贴XML作为类”

就这样！

用法

使用此帮助程序类非常简单。

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>();

- Damian Drygiel

18

+1 很好的回答。但是，“将 XML 粘贴为类”命令仅适用于 .NET 4.5。 - amiry jd

2

如果你已经安装了VS2012+，那么这是生成模型的好方法。我之后运行了ReSharper代码清理来使用自动属性，然后也进行了一些其他的整理。你可以通过这种方法生成，然后将其复制到旧项目中（如果需要的话）。 - Scotty.NET

5

目标 .net4.5 版本不是问题。只需启动一个临时项目，使用 dotnet4.5 进行复制粘贴，然后将源代码复制到您的实际项目中即可。 - LosManos

2

“catalog” 对象或类在哪里？ - CB4

5

在VS 2017 Community中，如果要在菜单中出现“将XML粘贴为类”，则需要安装“ASP.NET和Web开发”。如果缺失，请重新运行VS安装程序以修改您的安装。 - Slion

显示剩余7条评论

109

以下代码片段应该能做到这一点（您可以忽略大多数序列化属性）：

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);
}

- erymski

18

这实际上是唯一的答案。被接受的答案有几个缺陷，可能会让初学者感到困惑。 - Flamefire

@AndrewDennison 你在跟空气说话。 - John Deer

这应该是被接受的答案。我和提问者处于同样的情况，但是对XML没有任何控制，所以将根元素包装在新的根元素中不是一个选项。直接在数组上使用XmlElement而不是混合使用XmlArray和XmlArrayItem的各种组合就可以正常工作。 - Sulli

25

看看这个有没有帮助：

[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 文件的模式文档，然后再次使用它创建一个基于模式文档的类。

- Joel Coehoorn

11

我认为 .net 对反序列化数组不会很挑剔。第一个 XML 文档格式不正确。虽然看起来有根元素，但实际上并没有。规范的 XML 文档应该至少有一个根元素。在你的例子中：

<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>

- janbak

11

初学者指南

我发现这里的答案非常有帮助，但是我仍然在努力（只是一点点）使它工作。因此，为了帮助他人，我将详细说明可行的解决方案：

原始问题中的XML。 XML位于Class1.xml文件中，代码中使用路径来定位此xml文件。

我使用@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);
            }
        }
    }
}

希望这能帮到你：-）

- SlowLearner

1

它对我起作用了。这是一个完美的解决方案，适用于给定的xml输入（如OP的示例）。[XmlElement("Car")]是正确的属性。在其他示例中，他们使用了XmlArray等不必要的属性，只要我们将属性定义为public Car[] Cars { get; set; }，它就可以正确反序列化。谢谢。 - Diwakar Padmaraja

9

除了一个事实，在现实世界中，你经常无法更改原始XML以适应你的需求，Kevin的回答很好。

对于原始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));

- Kim Homann

谢谢！您的答案正是我所需要的，因为我不想修改数千兆字节的日志文件。 - Colin

虽然值得一提的是XmlSerializer方案非常优雅，但是承认它并不是很快，并且对于意外的Xml数据会产生敏感反应。因此，如果您的问题不需要完整反序列化，则应该考虑仅使用更加实用和高效的XmlReader类，并循环遍历<Car>元素。 - Kim Homann

9

如果你的 .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();`

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

- sheetal nainwal

7

一句话描述：

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

- Andre M

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- Marc Gravell · Accepted Answer

505

为什么不将XML保存到文件中，然后使用xsd生成C#类呢？

将文件写入磁盘（我将其命名为foo.xml）
生成xsd：xsd foo.xml
生成C#代码：xsd foo.xsd /classes

Et voila- 一个C#代码文件应该可以通过 XmlSerializer 读取数据：

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

（将生成的foo.cs文件包含在项目中）

- Marc Gravell

8

你是个了不起的人！谢谢。对于需要的任何人，"path"可以是你从Web响应创建的流，像这样：var resp = response.Content.ReadAsByteArrayAsync(); var stream = new MemoryStream(resp.Result); - Induster

1

很棒的想法，但是对于我的批量嵌套数组稍微复杂一些的模型无法正常工作。我不断收到嵌套数组类型转换错误的提示，加上生成的命名方案让人感到有些不满意。因此，最终我选择了自定义方法。 - GotDibbs

11

如何使用命令行打开 xsd.exe：

打开命令提示符（按下Win+R，输入“cmd”，按回车键）。
导航到 xsd.exe 的文件夹。例如，如果 xsd.exe 存在于 C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.7.2 工具中，则输入“cd C:\Program Files (x86)\Microsoft SDKs\Windows\v10.0A\bin\NETFX 4.7.2 工具”并按下回车键。
在命令提示符中输入“xsd.exe”和相应的参数来运行 xsd.exe。例如，“xsd.exe /?” 将显示 xsd.exe 的帮助文档。

- jwillmer

3

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工具”。 - goku_da_master

3

对于所有正在寻找XSD的人，这里有一个SO线程：https://dev59.com/CGAg5IYBdhLWcg3w9e_l - SOReader

如果我没有将XML保存到文件中，而是从ServiceModel.Channels.Message GetReaderAtBodyContents读取，该方法会返回xmlReader，那么如何使用xmlserializer？ - user1532976