如何反序列化XML文档


470

如何反序列化此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;
    }
}

似乎不起作用:-(


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

4
这个答案确实非常好:stackoverflow.com/a/19613934/196210
2014年

Answers:


359

这是工作版本。我将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; }
}

反序列化功能:

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>

67
[Serializable]是冗余如果使用XmlSerializer; XmlSerializer根本就不会检查。同样,大多数[Xml...]属性都是多余的,因为它只是模仿默认行为。即,默认情况下,名为的属性StockNumber存储为名为的元素<StockNumber>-不需要属性。
马克·Gravell

3
请注意,XmlElementAttribute = XmlElement(这是一种语言功能,您可以省略后缀“ Attribute”)。真正的解决方案是删除ReadToEnd()调用并添加根节点。但是最好使用erymski的代码来解决问题(解析给定的xml)
Flamefire 2014年

2
谢谢Kevin,但是如果我从示例XML中删除CarsCollection,该怎么办。我从类和Deserealize代码中删除了Carscollection,但是没有成功。
Vikrant

441

您如何将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)


6
你...是男人!谢谢。对于任何需要它的人,“ path”可以是您通过Web响应创建的Stream,如下所示:var resp = response.Content.ReadAsByteArrayAsync(); var stream = new MemoryStream(resp.Result);
Induster

1
很棒的主意,但是对于我稍微复杂一些的带有一批嵌套数组的模型来说,它无法正常工作。我一直在获取嵌套数组的类型转换错误-加上生成的命名方案,还有一些不足之处。因此,我最终选择了自定义路线。
GotDibbs

9
如何获取xsd.exe
jwillmer 2013年

2
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

2
对于正在寻找XSD的每个人。这里有一个SO线程:stackoverflow.com/questions/22975031/...
SOReader

229

您有两种可能性。

方法1。XSD工具


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

  1. 打开开发人员命令提示符
    您可以在中找到它;Start Menu > Programs > Microsoft Visual Studio 2012 > Visual Studio Tools 如果您使用Windows 8,也可以在“ 开始”屏幕中开始键入“ 开发人员命令提示符”
  2. 通过键入将位置更改为XML文件目录 cd /D "C:\path\to\xml"
  3. 创建 通过键入从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
    在此处输入图片说明

就是这样!

用法


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

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

16
+1好答案。但是,该Paste XML As Classes命令仅针对.NET 4.5
ravy amiry,2013年

1
如果您确实安装了vs2012 +,这是生成模型的好方法。之后,我确实运行了ReSharper代码清理以使用自动属性,然后还进行了一些其他整理。您可以通过此方法生成,然后根据需要复制到较旧的项目中。
Scotty.NET 2014年

4
定位.net4.5没问题。只需使用dotnet4.5启动一个临时项目,然后在其中粘贴粘贴并将源复制到实际项目即可。
LosManos

2
“目录”对象或类在哪里?
CB4

3
为了使“将XML粘贴为类”显示在VS 2017社区的菜单中,您需要安装“ ASP.NET和Web开发”。如果缺少,请再次运行VS安装程序以修改安装。
斯莱恩

89

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

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

14
这实际上是唯一的答案。公认的答案有一些缺陷,可能会使初学者感到困惑。
Flamefire

24

看看这是否有帮助:

[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文件创建架构文档,然后再次使用它来创建基于架构文档的类。


9

我认为.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>

7

如果您的.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文件的路径。您可以根据需要进行更改。


6

除了事实之外,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));
XmlData data = (XmlData)ser.Deserialize(XmlReader.Create(PathToCarsXml));

谢谢!您的答案正是我所需要的,因为我不想更改千兆字节的日志文件。
科林

尽管值得一提的是,XmlSerializer解决方案非常优雅,但也要承认它也不太快,并且对意外的Xml数据敏感。因此,如果您的问题不需要完全反序列化,则应考虑仅使用更为实用和高性能的XmlReader类,并遍历<Car>元素。
金·霍曼

5

尝试使用此通用类进行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;
    }
}

4

对于初学者

我发现这里的答案非常有帮助,说我仍在(一点点)努力地工作。因此,以防万一,我将阐明可行的解决方案:

来自原始问题的XML。该xml在文件Class1.xml中,path该文件在代码中用于查找该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);
            }
        }
    }
}

希望能帮助到你 :-)


1
它为我工作。对于给定的xml输入(这也是OP的示例),这也是一个完美的解决方案。[XmlElement(“ Car”)]是正确的属性。在其他示例中,他们使用XmlArray等,只要我们将属性定义为public Car [] Cars {get; 组; },它将正确地反序列化它。谢谢。
Diwakar Padmaraja

3

泛型类如何反序列化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
这使我可以大大缩减业务逻辑代码,并将功能集中在我生成的所有<T>类的帮助器类中。我已经在字符串中包含了XML,因此可以将其压缩为:`public static T LoadXMLFileIntoClass <T>(string xmlData){{XmlSerializer serializer = new XmlSerializer(typeof(T)); `return(T)serializer.Deserialize(new StringReader(xmlData)); 谢谢!
pwrgreg007

3

一班轮:

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

2

想法是要处理所有级别的反序列化,请参阅解决了我类似问题的示例解决方案

<?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 检查这个例子的多级反序列化


1

如果使用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

您可以将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; }
}

1

我的解决方案:

  1. 用于Edit > Past Special > Paste XML As Classes在您的代码中获取类
  2. 尝试如下操作:创建该类的列表(List<class1>),然后使用将XmlSerializer列表序列化为xml文件。
  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”


1
async public static Task<JObject> XMLtoNETAsync(XmlDocument ToConvert)
{
    //Van XML naar JSON
    string jsonText = await Task.Run(() => JsonConvert.SerializeXmlNode(ToConvert));

    //Van JSON naar .net object
    var o = await Task.Run(() => JObject.Parse(jsonText));

    return o;
}

1
请始终将答案放在上下文中,而不仅仅是粘贴代码。有关更多详细信息,请参见此处
gehbiszumeis
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.